mirror of
https://github.com/SerenityOS/serenity.git
synced 2025-01-22 09:21:57 -05:00
Everywhere: Format Markdown with prettier
These are the exact changes necessary to get the next commit to pass pre-commit checks.
This commit is contained in:
kleines Filmröllchen
Nico Weber
parent
7eb1534c54
commit
19163e79a3
310 changed files with 3571 additions and 3215 deletions
|
|
@ -10,33 +10,33 @@ Note that many applications can be disabled at SerenityOS build time if desired.
|
|||
|
||||
## See also
|
||||
|
||||
- Documentation for SerenityOS Games in section 6
|
||||
- Documentation for SerenityOS Games in section 6
|
||||
|
||||
### List of Application manpages
|
||||
|
||||
- [3D File Viewer](help://man/1/Applications/3DFileViewer)
|
||||
- [About](help://man/1/Applications/About)
|
||||
- [Analog Clock](help://man/1/Applications/AnalogClock)
|
||||
- [Assistant](help://man/1/Applications/Assistant)
|
||||
- [Browser](help://man/1/Applications/Browser)
|
||||
- [Calculator](help://man/1/Applications/Calculator)
|
||||
- [Calendar](help://man/1/Applications/Calendar)
|
||||
- [CatDog](help://man/1/Applications/CatDog)
|
||||
- [Certificate Settings](help://man/1/Applications/CertificateSettings)
|
||||
- [Character Map](help://man/1/Applications/CharacterMap)
|
||||
- [Eyes](help://man/1/Applications/Eyes)
|
||||
- [FontEditor](help://man/1/Applications/FontEditor)
|
||||
- [GML Playground](help://man/1/Applications/GMLPlayground)
|
||||
- [Help](help://man/1/Applications/Help)
|
||||
- [Hex Editor](help://man/1/Applications/HexEditor)
|
||||
- [Image Viewer](help://man/1/Applications/ImageViewer)
|
||||
- [Magnifier](help://man/1/Applications/Magnifier)
|
||||
- [Mail](help://man/1/Applications/Mail)
|
||||
- [Maps](help://man/1/Applications/Maps)
|
||||
- [Mouse Settings](help://man/1/Applications/MouseSettings)
|
||||
- [Pixel Paint](help://man/1/Applications/PixelPaint)
|
||||
- [Presenter](help://man/1/Applications/Presenter)
|
||||
- [Profiler](help://man/1/Applications/Profiler)
|
||||
- [SQL Studio](help://man/1/Applications/SQLStudio)
|
||||
- [Terminal](help://man/1/Applications/Terminal)
|
||||
- [Text Editor](help://man/1/Applications/TextEditor)
|
||||
- [3D File Viewer](help://man/1/Applications/3DFileViewer)
|
||||
- [About](help://man/1/Applications/About)
|
||||
- [Analog Clock](help://man/1/Applications/AnalogClock)
|
||||
- [Assistant](help://man/1/Applications/Assistant)
|
||||
- [Browser](help://man/1/Applications/Browser)
|
||||
- [Calculator](help://man/1/Applications/Calculator)
|
||||
- [Calendar](help://man/1/Applications/Calendar)
|
||||
- [CatDog](help://man/1/Applications/CatDog)
|
||||
- [Certificate Settings](help://man/1/Applications/CertificateSettings)
|
||||
- [Character Map](help://man/1/Applications/CharacterMap)
|
||||
- [Eyes](help://man/1/Applications/Eyes)
|
||||
- [FontEditor](help://man/1/Applications/FontEditor)
|
||||
- [GML Playground](help://man/1/Applications/GMLPlayground)
|
||||
- [Help](help://man/1/Applications/Help)
|
||||
- [Hex Editor](help://man/1/Applications/HexEditor)
|
||||
- [Image Viewer](help://man/1/Applications/ImageViewer)
|
||||
- [Magnifier](help://man/1/Applications/Magnifier)
|
||||
- [Mail](help://man/1/Applications/Mail)
|
||||
- [Maps](help://man/1/Applications/Maps)
|
||||
- [Mouse Settings](help://man/1/Applications/MouseSettings)
|
||||
- [Pixel Paint](help://man/1/Applications/PixelPaint)
|
||||
- [Presenter](help://man/1/Applications/Presenter)
|
||||
- [Profiler](help://man/1/Applications/Profiler)
|
||||
- [SQL Studio](help://man/1/Applications/SQLStudio)
|
||||
- [Terminal](help://man/1/Applications/Terminal)
|
||||
- [Text Editor](help://man/1/Applications/TextEditor)
|
||||
|
|
|
|||
|
|
@ -18,33 +18,33 @@ It currently supports opening the [Wavefront OBJ file format](https://en.wikiped
|
|||
|
||||
## Features
|
||||
|
||||
By default, 3D File Viewer opens with a rotating [Utah teapot](https://en.wikipedia.org/wiki/Utah_teapot), a standard 3D test model. Open files via *File → Open* (`Ctrl+O`) or dragging and dropping files into the application. Sample files can be found in `Documents/3D Models`.
|
||||
By default, 3D File Viewer opens with a rotating [Utah teapot](https://en.wikipedia.org/wiki/Utah_teapot), a standard 3D test model. Open files via _File → Open_ (`Ctrl+O`) or dragging and dropping files into the application. Sample files can be found in `Documents/3D Models`.
|
||||
|
||||
Orbit around the model by grabbing it with the cursor, and zoom in and out with the mouse wheel.
|
||||
|
||||
### View Options
|
||||
|
||||
* View in Fullscreen mode by pressing `F11` and press `Esc` to return to windowed mode.
|
||||
* **Rotation Axis** - Enable or disable rotation:
|
||||
* **X** rotates upwards.
|
||||
* **Y** rotates right.
|
||||
* **Z** rotates clockwise.
|
||||
* **Rotation Speed** - Set to slow, normal, fast or disable.
|
||||
* **Show Frame Rate** - Display FPS (frames per second) and frame time values (indicating how long it took to render a single frame) in the top-right corner.
|
||||
- View in Fullscreen mode by pressing `F11` and press `Esc` to return to windowed mode.
|
||||
- **Rotation Axis** - Enable or disable rotation:
|
||||
- **X** rotates upwards.
|
||||
- **Y** rotates right.
|
||||
- **Z** rotates clockwise.
|
||||
- **Rotation Speed** - Set to slow, normal, fast or disable.
|
||||
- **Show Frame Rate** - Display FPS (frames per second) and frame time values (indicating how long it took to render a single frame) in the top-right corner.
|
||||
|
||||
### Texture Options
|
||||
|
||||
To load a texture, ensure there's a [Bitmap image file](https://en.wikipedia.org/wiki/BMP_file_format) (`.bmp`) with the same name as the OBJ file in the same folder and 3D File Viewer will attempt to load it automatically.
|
||||
|
||||
* **Enable Texture** - On by default, disable for a blank (gray) model.
|
||||
* **Wrap S or T** - Controls how a texture is applied horizontally (S) or vertically (T):
|
||||
* **Repeat** - Tiles the texture along the axis.
|
||||
* **Mirrored** - Tiles and mirrors the texture along the axis.
|
||||
* **Clamp** - Stretches or clamps the texture edges instead of repeating it.
|
||||
* **Scale** - Adjusts texture size (e.g. `0.5` reduces by half, `2x` doubles the size).
|
||||
* **Mag Filter** - Determines the appearance of textures when enlarged beyond their original resolution.
|
||||
* **Nearest** - *Nearest Neighbor* means no scaling is applied to the texture, resulting in a pixellated look.
|
||||
* **Linear** - *Linear Interpolation* scales the image by estimating pixel values, resulting in a smoother image.
|
||||
- **Enable Texture** - On by default, disable for a blank (gray) model.
|
||||
- **Wrap S or T** - Controls how a texture is applied horizontally (S) or vertically (T):
|
||||
- **Repeat** - Tiles the texture along the axis.
|
||||
- **Mirrored** - Tiles and mirrors the texture along the axis.
|
||||
- **Clamp** - Stretches or clamps the texture edges instead of repeating it.
|
||||
- **Scale** - Adjusts texture size (e.g. `0.5` reduces by half, `2x` doubles the size).
|
||||
- **Mag Filter** - Determines the appearance of textures when enlarged beyond their original resolution.
|
||||
- **Nearest** - _Nearest Neighbor_ means no scaling is applied to the texture, resulting in a pixellated look.
|
||||
- **Linear** - _Linear Interpolation_ scales the image by estimating pixel values, resulting in a smoother image.
|
||||
|
||||
Currently, the flashing color lights can't be disabled.
|
||||
|
||||
|
|
@ -52,7 +52,7 @@ Settings persist whilst the application is open with different files, but do not
|
|||
|
||||
## Arguments
|
||||
|
||||
* `file`: The 3D file to be viewed.
|
||||
- `file`: The 3D file to be viewed.
|
||||
|
||||
## Example
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ $ About
|
|||
|
||||
`About` is an application that displays information about SerenityOS.
|
||||
|
||||
On the left is the official Ladyball logo. Designed by Katalin Kult, it combines the Yin-Yang symbol with the distinctive shell pattern of a [ladybird](https://en.wikipedia.org/wiki/Coccinellidae), the projects's insect motif. It symbolizes the SerenityOS philosophy, encompassing the *Serenity Prayer's* acceptance of the uncontrollable, the *Yin and yang* concept of balancing opposing forces, and *Lagom*, the Swedish concept of moderation or finding "just the right amount."
|
||||
On the left is the official Ladyball logo. Designed by Katalin Kult, it combines the Yin-Yang symbol with the distinctive shell pattern of a [ladybird](https://en.wikipedia.org/wiki/Coccinellidae), the projects's insect motif. It symbolizes the SerenityOS philosophy, encompassing the _Serenity Prayer's_ acceptance of the uncontrollable, the _Yin and yang_ concept of balancing opposing forces, and _Lagom_, the Swedish concept of moderation or finding "just the right amount."
|
||||
|
||||
Since there are no official releases of the project, the version number is denoted as `1.0-dev` and the revision number reflects the latest Git commit's hash.
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ $ Assistant
|
|||
|
||||
### Features
|
||||
|
||||
* Enter a URL to open it in [Browser](help://man/1/Applications/Browser), e.g. `serenityos.org`.
|
||||
* Perform quick calculations by typing the equal sign (=) followed by a mathematical expression, e.g. `=22*101`. Press `Return` to copy the result.
|
||||
* Run commands in [Terminal](help://man/1/Applications/Terminal) by prefixing them with a dollar sign ($), e.g. `$ uname -a`.
|
||||
* Launch applications with arguments, e.g. launch [Pixel Paint](help://man/1/Applications/PixelPaint) with a file: `pp image.png`.
|
||||
- Enter a URL to open it in [Browser](help://man/1/Applications/Browser), e.g. `serenityos.org`.
|
||||
- Perform quick calculations by typing the equal sign (=) followed by a mathematical expression, e.g. `=22*101`. Press `Return` to copy the result.
|
||||
- Run commands in [Terminal](help://man/1/Applications/Terminal) by prefixing them with a dollar sign ($), e.g. `$ uname -a`.
|
||||
- Launch applications with arguments, e.g. launch [Pixel Paint](help://man/1/Applications/PixelPaint) with a file: `pp image.png`.
|
||||
|
|
|
|||
|
|
@ -16,12 +16,12 @@ Browser is an application used to view the World Wide Web. It is built on top of
|
|||
|
||||
## Options
|
||||
|
||||
* `--help`: Display help message and exit
|
||||
* `--version`: Display version number and exit
|
||||
- `--help`: Display help message and exit
|
||||
- `--version`: Display version number and exit
|
||||
|
||||
## Arguments
|
||||
|
||||
* `urls`: A list of urls to open, one per tab. If none are specified, then the homepage will be opened instead.
|
||||
- `urls`: A list of urls to open, one per tab. If none are specified, then the homepage will be opened instead.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ $ CatDog
|
|||
|
||||
`CatDog` is an animated screenmate application in the form of a virtual pet.
|
||||
|
||||
It was inspired by [Neko](https://en.wikipedia.org/wiki/Neko_(software)). The name derives from its ambiguous appearance: is it a cat, a dog, or a hybrid?
|
||||
It was inspired by [Neko](<https://en.wikipedia.org/wiki/Neko_(software)>). The name derives from its ambiguous appearance: is it a cat, a dog, or a hybrid?
|
||||
|
||||
Its helpful suggestions evoke the animated assistants popular at the turn of the millennium, such as [Clippy](https://en.wikipedia.org/wiki/Office_Assistant).
|
||||
|
||||
|
|
@ -28,10 +28,10 @@ Additionally, CatDog offers helpful suggestions depending on the currently activ
|
|||
|
||||
CatDog has multiple states:
|
||||
|
||||
- *Sleeping* if the mouse cursor hasn’t moved in some time
|
||||
- *Alert* if woken by the mouse cursor or speaking after being idle
|
||||
- *Dressed as an Artist* if [Pixel Paint](help://man/1/Applications/PixelPaint) or [Font Editor](help://man/1/Applications/FontEditor) are open
|
||||
- *Dressed as an Inspector* if [Profiler](help://man/1/Applications/Profiler) or System Monitor are open
|
||||
- _Sleeping_ if the mouse cursor hasn’t moved in some time
|
||||
- _Alert_ if woken by the mouse cursor or speaking after being idle
|
||||
- _Dressed as an Artist_ if [Pixel Paint](help://man/1/Applications/PixelPaint) or [Font Editor](help://man/1/Applications/FontEditor) are open
|
||||
- _Dressed as an Inspector_ if [Profiler](help://man/1/Applications/Profiler) or System Monitor are open
|
||||
|
||||
To exit, right-click on CatDog and select `Quit` or, if active, press `Alt+F4`.
|
||||
|
||||
|
|
|
|||
|
|
@ -11,11 +11,12 @@ $ CertificateSettings
|
|||
```
|
||||
|
||||
## Description
|
||||
|
||||
`Certificate Settings` is an application for managing digital certificates in SerenityOS.
|
||||
|
||||
Certificates are used for establishing a user's credentials when trying to create secure connection between a client and server by matching a public and private key.
|
||||
|
||||
The *Certificate Store* lists all of the certificates currently stored in the system, the Trusted Root Certification Authorities (CAs) they were issued by and their expiration dates.
|
||||
The _Certificate Store_ lists all of the certificates currently stored in the system, the Trusted Root Certification Authorities (CAs) they were issued by and their expiration dates.
|
||||
|
||||
### Features
|
||||
|
||||
|
|
|
|||
|
|
@ -18,15 +18,17 @@ Character Map is a GUI application for viewing, searching for, and copying Unico
|
|||
## Examples
|
||||
|
||||
To open Character Map:
|
||||
|
||||
```sh
|
||||
$ CharacterMap
|
||||
```
|
||||
|
||||
To view a list of all characters that have "yak" in their name:
|
||||
|
||||
```sh
|
||||
$ CharacterMap --search "yak"
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
* [`FontEditor`(1)](help://man/1/Applications/FontEditor) To edit the fonts instead of just viewing them.
|
||||
- [`FontEditor`(1)](help://man/1/Applications/FontEditor) To edit the fonts instead of just viewing them.
|
||||
|
|
|
|||
|
|
@ -12,10 +12,10 @@ $ Eyes [--num-eyes number] [--max-in-row number] [--grid-rows number] [--grid-co
|
|||
|
||||
## Options
|
||||
|
||||
* `--help`: Display help message and exit
|
||||
* `--version`: Print version
|
||||
* `-n number`, `--num-eyes number`: Number of eyes
|
||||
* `-m number`, `--max-in-row number`: Maximum number of eyes in a row
|
||||
* `-r number`, `--grid-rows number`: Number of rows in grid (incompatible with --number)
|
||||
* `-c number`, `--grid-cols number`: Number of columns in grid (incompatible with --number)
|
||||
* `-h`, `--hide-window`: Hide window frame
|
||||
- `--help`: Display help message and exit
|
||||
- `--version`: Print version
|
||||
- `-n number`, `--num-eyes number`: Number of eyes
|
||||
- `-m number`, `--max-in-row number`: Maximum number of eyes in a row
|
||||
- `-r number`, `--grid-rows number`: Number of rows in grid (incompatible with --number)
|
||||
- `-c number`, `--grid-cols number`: Number of columns in grid (incompatible with --number)
|
||||
- `-h`, `--hide-window`: Hide window frame
|
||||
|
|
|
|||
|
|
@ -17,7 +17,9 @@ FontEditor is the font editing application for creating and editing bitmap font
|
|||
|
||||
|
||||
### Basic Parts
|
||||
|
||||
FontEditor has the following basic parts:
|
||||
|
||||
1. The menu bar at the top
|
||||
2. The toolbar
|
||||
3. The main workspace
|
||||
|
|
@ -26,80 +28,95 @@ FontEditor has the following basic parts:
|
|||
Presently, you can resize the entire FontEditor form to your liking. You can turn the visibility of Font Metadata and Unicode Blocks on or off. You can change the glyph editor window zoom factor. All of these things are currently available in FontEditor automatically.
|
||||
|
||||
### The Toolbar
|
||||
|
||||
The Toolbar contains the same functional entries as that of the Menubar and is represented as clickable icons. Hovering on each icon will display additional information listed in the status bar which further states what each icon does.
|
||||
|
||||
### The Main Workspace
|
||||
|
||||
The main workspace has three partitions:
|
||||
|
||||
- The ***left section*** contains the glyph editor window. This window has three different zoom factors for ease of use and for your viewing comfort. They are 500%, 1000% and 1500%. You can freely switch to any zoom level at anytime while creating your font. Don't let the size of the glyph editor window fool you. This is where you will spend about 95% of the time. And the task is that of shaping each glyph by left-clicking on the mouse. You can form a dot, a line, or a complete glyph just by connecting the dots. If you need to undo a certain location with a black dot, you can right-click on top of the target area and it will revert back to empty. Each grid area can hold any of the three states: 1) on or black 2) off or white 3) empty or gray. On state is displayed as black by default. Off state is displayed as white by default. Empty state is displayed as gray by default. Off state or white is relevant most specially if the font is fixed-width as it dictates the distance a glyph will have from left, center or right. Empty state or gray is important for variable-width font as it affects the overall width of the glyph. For variable width fonts, you move the glyph flushed left on the glyph editor window and remove any extra empty grids by decrementing the present column counter located right under the glyph editor window and thereby leaving only the entire glyph all by itself. Below the glyph editor is the glyph tool which contains the following: the pen icon for creating the glyph itself, the move icon to enable the entire glyph move to top, down, left or right from within the glyph editor window. Below the glyph tool are the transform icons which are flip horizontal, flip vertical, rotate counter-clockwise 90°and rotate clockwise 90°. Transform tools are most helpful when copying over existing glyphs and transforming them to form a new glyph. A becomes V, M becomes W, c becomes e, n becomes u, etc.
|
||||
- The **_left section_** contains the glyph editor window. This window has three different zoom factors for ease of use and for your viewing comfort. They are 500%, 1000% and 1500%. You can freely switch to any zoom level at anytime while creating your font. Don't let the size of the glyph editor window fool you. This is where you will spend about 95% of the time. And the task is that of shaping each glyph by left-clicking on the mouse. You can form a dot, a line, or a complete glyph just by connecting the dots. If you need to undo a certain location with a black dot, you can right-click on top of the target area and it will revert back to empty. Each grid area can hold any of the three states: 1) on or black 2) off or white 3) empty or gray. On state is displayed as black by default. Off state is displayed as white by default. Empty state is displayed as gray by default. Off state or white is relevant most specially if the font is fixed-width as it dictates the distance a glyph will have from left, center or right. Empty state or gray is important for variable-width font as it affects the overall width of the glyph. For variable width fonts, you move the glyph flushed left on the glyph editor window and remove any extra empty grids by decrementing the present column counter located right under the glyph editor window and thereby leaving only the entire glyph all by itself. Below the glyph editor is the glyph tool which contains the following: the pen icon for creating the glyph itself, the move icon to enable the entire glyph move to top, down, left or right from within the glyph editor window. Below the glyph tool are the transform icons which are flip horizontal, flip vertical, rotate counter-clockwise 90°and rotate clockwise 90°. Transform tools are most helpful when copying over existing glyphs and transforming them to form a new glyph. A becomes V, M becomes W, c becomes e, n becomes u, etc.
|
||||
|
||||
- The ***middle section*** contains two parts: the upper part which holds the entire glyph content of the font, or lack thereof if you are making a new one. And the lower part which contains ***Metadata*** information such as name, family, weight, slope, presentation size, mean line, baseline, glyph spacing and if the font is either fixed-width or variable-width. You can still further tweak your font parameters via the Metadata section. The `Fixed width` toggle located at the right side next to Glyph spacing is of special note. It applies to the entire font file. It does not only apply to a single glyph or group of glyphs. It is the differentiating factor that informs the system if the font is or is not fixed-width. Fixed-width fonts are mostly used for Terminals and for displaying source code.
|
||||
- The **_middle section_** contains two parts: the upper part which holds the entire glyph content of the font, or lack thereof if you are making a new one. And the lower part which contains **_Metadata_** information such as name, family, weight, slope, presentation size, mean line, baseline, glyph spacing and if the font is either fixed-width or variable-width. You can still further tweak your font parameters via the Metadata section. The `Fixed width` toggle located at the right side next to Glyph spacing is of special note. It applies to the entire font file. It does not only apply to a single glyph or group of glyphs. It is the differentiating factor that informs the system if the font is or is not fixed-width. Fixed-width fonts are mostly used for Terminals and for displaying source code.
|
||||
|
||||
- The ***right section*** displays a searchable list of Unicode Blocks.
|
||||
Metadata and Unicode Blocks can be turned on or off in `Menu → View`. Selecting a Unicode Block will show only the glyphs contained within the range of that block. Basic Latin covers 000-007F, Latin-1 Supplement covers 0080-00FF, Latin Extended-A covers 0100-017F and so on and so forth. Global search for a glyph is affected when a certain block is currently selected. Only by selecting `Show All` will the global glyph search work as expected. So make it a habit of confirming that Show All is active before searching for a glyph.
|
||||
- The **_right section_** displays a searchable list of Unicode Blocks.
|
||||
Metadata and Unicode Blocks can be turned on or off in `Menu → View`. Selecting a Unicode Block will show only the glyphs contained within the range of that block. Basic Latin covers 000-007F, Latin-1 Supplement covers 0080-00FF, Latin Extended-A covers 0100-017F and so on and so forth. Global search for a glyph is affected when a certain block is currently selected. Only by selecting `Show All` will the global glyph search work as expected. So make it a habit of confirming that Show All is active before searching for a glyph.
|
||||
|
||||
### The status bar
|
||||
|
||||
The status bar displays additional information describing what each menu entry and toolbar icon does. It identifies the unicode value of the glyph currently under the cursor. It shows the glyph's visual representation (if available), description and dimensions. The right-most segment displays the code point range of the currently selected Unicode Block. Clicking this segment will toggle the display of the Unicode Block list. Second only to the glyph editor window, the status bar is your next best friend on your path to becoming a font master.
|
||||
|
||||
## Tutorial: Create a new font
|
||||
|
||||
|
||||
|
||||
To create a new font, you can either click on New Font icon on the Toolbar or go to `File → New Font` in the Menubar.
|
||||
A wizard will walk you through setting the needed parameters for your new font.
|
||||
|
||||
### Typeface Properties
|
||||
|
||||
|
||||
|
||||
You can try out the default values just to get the feel of the program.
|
||||
|
||||
### Glyph Properties
|
||||
|
||||
|
||||
|
||||
Just click **Finish** when you are so inclined.
|
||||
|
||||
### Edit Glyph Properties
|
||||
|
||||
|
||||
|
||||
Adjust the values to suit your needs. The higher the value, the larger the font size.
|
||||
|
||||
### Untitled font
|
||||
|
||||
|
||||
|
||||
Congratulations on your successful initial font setup. Now you are ready to begin. And begin you shall. There is more to font creation than simply scribbling away. You need to always remind yourself this question: "Where is the fun in that?". Start with what you need to do while striving to achieve fun in the process. Let's be honest, font creation is one of the many thankless jobs, unless and until there is fun in it, why bother?
|
||||
|
||||
### Launch another instance
|
||||
|
||||
|
||||
|
||||
The figure above shows where you can find FontEditor from inside the SerenityOS desktop.
|
||||
|
||||
### Side by side
|
||||
|
||||
|
||||
|
||||
Having another instance of FontEditor can help boost productivity. This is most noticeable when one is just starting out in using FontEditor and trying out how to best make use of the application. Don't be afraid to experiment, let your inner font master slowly shine through. It is best to maintain the feeling of having fun while silently grinning from ear to ear as you steadily create form and personality in your font. Don't be afraid to start again, if you must. As with the entire workflow, being aware when to start, when to stop and when to reset is crucial. With FontEditor to assist you, starting from scratch is no longer an arduous process.
|
||||
|
||||
### Save font
|
||||
|
||||
|
||||
|
||||
Save your font by following the recommended `FontName + FontStyle + FontPresentationSize + .font` naming convention.
|
||||
|
||||
### Continue Editing
|
||||
|
||||
|
||||
|
||||
The figure above shows some previously made glyphs. Those with sharp eyes can immediately see that the glyphs for M and W, O and Q came from the same base. W was copied over from M and was flipped horizontally. Q was copied over from O and a descender was added to achieve the final glyph. Continue editing your font by adding more glyphs into it. Take your time in creating the font, only you know the reason why the glyph is formed the way it is. You know why the height and the width is so, why the curvature is just so. Aside from achieving balance, maintain the spirit of fun in making your font. The more glyphs are added, the easier it is to get the general feel and character of the font. Remember to always save and to save often.
|
||||
|
||||
### fonts.serenityos.net
|
||||
|
||||
|
||||
|
||||
It is highly recommended to use our own [fonts portal](https://fonts.serenityos.net) as one of your primary resource for glyph and font information. The others are [Unicode charts [unicode.org]](https://www.unicode.org/charts/) and our [wiki](https://wiki.serenityos.net).
|
||||
|
||||
### Search glyph
|
||||
|
||||
|
||||
|
||||
Figure above depicts a search session on the [fonts.serenityos.net](https://fonts.serenityos.net) portal.
|
||||
|
||||
### Search detail
|
||||
|
||||
|
||||
|
||||
The same search session displaying result of the previous query.
|
||||
|
||||
So there you have it, by now you have at least an idea of how to make ***SerenityOS*** fonts using **FontEditor**. For any font-related questions or inquiries, just drop by the official [SerenityOS Discord #fonts](https://discord.com/channels/830522505605283862/927893781968191508).
|
||||
So there you have it, by now you have at least an idea of how to make **_SerenityOS_** fonts using **FontEditor**. For any font-related questions or inquiries, just drop by the official [SerenityOS Discord #fonts](https://discord.com/channels/830522505605283862/927893781968191508).
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ $ GMLPlayground [file]
|
|||
|
||||
## Arguments
|
||||
|
||||
* `file`: Path of GML file to load
|
||||
- `file`: Path of GML file to load
|
||||
|
||||
## Description
|
||||
|
||||
|
|
@ -31,5 +31,4 @@ $ GMLPlayground /home/anon/example.gml
|
|||
|
||||
## See also
|
||||
|
||||
* [`gml-format`(1)](help://man/1/gml-format) For automated GML formatting
|
||||
|
||||
- [`gml-format`(1)](help://man/1/gml-format) For automated GML formatting
|
||||
|
|
|
|||
|
|
@ -21,20 +21,25 @@ It lets you search for and read manual pages (or "man pages").
|
|||
## Examples
|
||||
|
||||
To open Help:
|
||||
|
||||
```sh
|
||||
$ Help
|
||||
```
|
||||
|
||||
To open documentation for the `echo` command:
|
||||
|
||||
```sh
|
||||
$ Help echo
|
||||
```
|
||||
|
||||
To open the documentation for the `mkdir` command:
|
||||
|
||||
```sh
|
||||
$ Help 1 mkdir
|
||||
```
|
||||
|
||||
Conversely, to open the documentation about the `mkdir()` syscall:
|
||||
|
||||
```sh
|
||||
$ Help 2 mkdir
|
||||
```
|
||||
|
|
@ -46,5 +51,5 @@ this man page should be located at `/usr/share/man/man1/Applications/Help.md`.
|
|||
|
||||
## See Also
|
||||
|
||||
* [`man`(1)](help://man/1/man) To read these same man pages from the terminal
|
||||
* [`man`(7)](help://man/7/man) For an overview on how manpages are organized
|
||||
- [`man`(1)](help://man/1/man) To read these same man pages from the terminal
|
||||
- [`man`(7)](help://man/7/man) For an overview on how manpages are organized
|
||||
|
|
|
|||
|
|
@ -23,13 +23,14 @@ Hex Editor abstracts data access into documents, one for memory based streaming
|
|||
The core feature of Hex Editor is value inspector functionality. The inspector operates on current cursor position (or selection start range if one is selected) and interprets bytes moving forward as various data types. The inspector can toggle between big and little endian modes. A value selected in the inspector has its associated bytes that makes up that value gets highlighted in the editor.
|
||||
|
||||
### Find value
|
||||
|
||||
One can search using ASCII string or Hex value, the result will be displayed on the right side with corresponding ValueInspector information.
|
||||
|
||||
|
||||
|
||||
### Copy value
|
||||
An option to copy as hex value, as text, or as C-code is available and can extract the file in parts or as a whole. The figure below shows all three output formats transferred into Text Editor.
|
||||
|
||||
An option to copy as hex value, as text, or as C-code is available and can extract the file in parts or as a whole. The figure below shows all three output formats transferred into Text Editor.
|
||||
|
||||
|
||||
|
||||
|
|
@ -37,8 +38,8 @@ Hex Editor's simple and straight-forward interface offers search, export, byte p
|
|||
|
||||
## Options
|
||||
|
||||
* `-a`, `--annotations`: Path to an annotations file to load on startup
|
||||
- `-a`, `--annotations`: Path to an annotations file to load on startup
|
||||
|
||||
## Arguments
|
||||
|
||||
* `file`: File to open on startup
|
||||
- `file`: File to open on startup
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ ImageViewer is even smart enough to detect other images and display them when cl
|
|||
|
||||
## Arguments
|
||||
|
||||
* `file`: The image file to be displayed.
|
||||
- `file`: The image file to be displayed.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -24,4 +24,4 @@ To lock the location, making Magnifier stop following your mouse and stay in pla
|
|||
|
||||
To view a pixel grid overlay, press `G`.
|
||||
|
||||
For users with slight visual impairment, Magnifier can apply several filters to the captured image. Click on the *Accessibility* menu and select one of the impairment categories available in the drop-down list.
|
||||
For users with slight visual impairment, Magnifier can apply several filters to the captured image. Click on the _Accessibility_ menu and select one of the impairment categories available in the drop-down list.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
## Name
|
||||
|
||||
 Mail - Serenity e-mail client
|
||||
 Mail - Serenity e-mail client
|
||||
|
||||
[Open](file:///bin/Mail)
|
||||
|
||||
|
|
@ -19,6 +19,7 @@ See the Examples section for an example configuration file.
|
|||
## Examples
|
||||
|
||||
`~/.config/Mail.ini`:
|
||||
|
||||
```ini
|
||||
[Connection]
|
||||
Server=email.example.com
|
||||
|
|
|
|||
|
|
@ -17,16 +17,18 @@ $ Maps
|
|||
The default data provider is [OpenStreetMaps](https://www.openstreetmap.org/), an open-source community-maintained map similar in spirit to Wikipedia.
|
||||
|
||||
## Features
|
||||
|
||||
Pan around the map by clicking and dragging.
|
||||
|
||||
Zoom by using the toolbar icons, the mouse wheel or `Ctrl +` to zoom-in and `Ctrl -` to zoom-out. Reset the zoom to a global view with `Ctrl 0`.
|
||||
Double-clicking anywhere on the map zooms-in to that location. Double-clicking whilst holding `Shift` zooms-out.
|
||||
|
||||
Right-click on a location to:
|
||||
* Copy its coordinates to the Clipboard
|
||||
* Save it to your favorites
|
||||
* Open it in various mapping services
|
||||
* Center the map on it
|
||||
|
||||
- Copy its coordinates to the Clipboard
|
||||
- Save it to your favorites
|
||||
- Open it in various mapping services
|
||||
- Center the map on it
|
||||
|
||||
Show and hide the search panel by clicking on the leftmost magnifying glass in the toolbar. Type your query, press `Return` and then click on a result to focus on it in the map. Navigate the search results with the `Up` and `Down` arrow keys.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1,18 @@
|
|||
## Name
|
||||
|
||||
 Pixel Paint - Image Editor
|
||||
|
||||
[Open](file:///bin/PixelPaint)
|
||||
|
||||
## Synopsis
|
||||
|
||||
```sh
|
||||
$ PixelPaint [file]
|
||||
$ pp
|
||||
```
|
||||
|
||||
## Description
|
||||
|
||||
`Pixel Paint` is a feature-rich image editing application inspired by the likes of classic [Microsoft Paint](https://en.wikipedia.org/wiki/Microsoft_Paint#Windows_9x), though includes many more advanced features such as tabs, layers and filters.
|
||||
|
||||
Documents can be saved as Pixel Paint Files (`.pp`), preserving layers and images.
|
||||
|
|
@ -17,167 +20,211 @@ Documents can be saved as Pixel Paint Files (`.pp`), preserving layers and image
|
|||
The supported export formats are BMP, PNG and QOI ([Quite Okay Image Format](https://qoiformat.org)).
|
||||
|
||||
## User Interface
|
||||
|
||||
|
||||
|
||||
The interface follows familiar conventions, making it easy for users experienced with other image editors to pick up. Most options are accessible through the Menu bar and are searchable with `Ctrl+Shift+A`.
|
||||
|
||||
### Toolbar
|
||||
The toolbar contains common actions such as creating, opening and saving a file. It also provides quick access to useful zoom levels (*Fit to width*, *Fit to height* and *Fit entire image*).
|
||||
|
||||
The toolbar contains common actions such as creating, opening and saving a file. It also provides quick access to useful zoom levels (_Fit to width_, _Fit to height_ and _Fit entire image_).
|
||||
|
||||
#### Levels
|
||||
|
||||
|
||||
|
||||
The last icon on the toolbar opens the levels adjustment window. Levels control the exposure (light) in an image.
|
||||
* **Brightness** - Lighten or darken all colors.
|
||||
* **Contrast** - Increase or decrease the difference between light and dark areas.
|
||||
* **Gamma** - Redistribute light intensities, allowing adjustments that can bring a digital image closer to the way human eyes perceive details, particularly in darker areas.
|
||||
|
||||
- **Brightness** - Lighten or darken all colors.
|
||||
- **Contrast** - Increase or decrease the difference between light and dark areas.
|
||||
- **Gamma** - Redistribute light intensities, allowing adjustments that can bring a digital image closer to the way human eyes perceive details, particularly in darker areas.
|
||||
|
||||
### Main Workspace
|
||||
* The tab bar above the canvas allows multiple documents to be open simultaneously.
|
||||
* Surrounding the canvas is a vertical and horizontal ruler. When the Guide Tool is active, dragging from these rulers creates a line guide.
|
||||
* In the center is the Canvas in which you can paint, create shapes, write text and manipulate images. Use the left mouse-button to paint with the primary color and the right mouse-button to paint with the secondary color. Zoom in/out with `Ctrl +` / `Ctrl -` or use the mouse wheel. Pan with the middle-mouse button. Zooming-in far enough reveals a pixel grid which is useful for precise work, such as making pixel art.
|
||||
|
||||
- The tab bar above the canvas allows multiple documents to be open simultaneously.
|
||||
- Surrounding the canvas is a vertical and horizontal ruler. When the Guide Tool is active, dragging from these rulers creates a line guide.
|
||||
- In the center is the Canvas in which you can paint, create shapes, write text and manipulate images. Use the left mouse-button to paint with the primary color and the right mouse-button to paint with the secondary color. Zoom in/out with `Ctrl +` / `Ctrl -` or use the mouse wheel. Pan with the middle-mouse button. Zooming-in far enough reveals a pixel grid which is useful for precise work, such as making pixel art.
|
||||
|
||||
### Color Panel
|
||||
|
||||
|
||||
|
||||
Below the canvas is the Color Panel. On the left is the Color Picker, showing the currently selected colors. The inner color is the primary color, the outer color is the secondary color. Click on either to change its color.
|
||||
To the right of the Color Picker is a palette of default colors. Left-click on one to set it as the primary color and right-click to set as the secondary color. Switch primary and secondary colors by pressing `X`. Reset to default colors (black and white) by pressing `D`.
|
||||
In the *Edit* menu, palettes can be saved and loaded as `.palette` files. These are text files containing [Hex Color Codes](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet), arranged by line from the top-left color going across.
|
||||
In the _Edit_ menu, palettes can be saved and loaded as `.palette` files. These are text files containing [Hex Color Codes](https://en.wikipedia.org/wiki/Web_colors#Hex_triplet), arranged by line from the top-left color going across.
|
||||
|
||||
### Status Bar
|
||||
|
||||
Below the Color Panel is the Status Bar. It displays the pixel coordinates of the cursor when it hovers over the Canvas. When the cursor hovers over the program's interface it describes what a button does.
|
||||
|
||||
### Tool Panel
|
||||
To the left of the main workspace is the Tool Panel which showcases tools available for interacting with the canvas. When a tool is selected, using `[` / `]` adjusts the primary option in the Tool properties panel, e.g. *Size* for the Brush Tool. Adding `Shift` will adjust the secondary option, e.g. *Hardness* for the Brush Tool.
|
||||
*Hardness* refers to how sharp or abrupt the transition is between painted elements and the background, affecting edge clarity. *Feathered edges* have a softer transition with a gradual decrease in intensity, creating a smooth and blended appearance contrasting with the sharpness of higher hardness.
|
||||
|
||||
To the left of the main workspace is the Tool Panel which showcases tools available for interacting with the canvas. When a tool is selected, using `[` / `]` adjusts the primary option in the Tool properties panel, e.g. _Size_ for the Brush Tool. Adding `Shift` will adjust the secondary option, e.g. _Hardness_ for the Brush Tool.
|
||||
_Hardness_ refers to how sharp or abrupt the transition is between painted elements and the background, affecting edge clarity. _Feathered edges_ have a softer transition with a gradual decrease in intensity, creating a smooth and blended appearance contrasting with the sharpness of higher hardness.
|
||||
|
||||
#### Move Tool (`M`)
|
||||
|
||||
Moves layers. Select layers either in the Layers Panel or on the canvas. Layers below the top layer can be selected on the canvas if the top layer doesn't fill the entire canvas.
|
||||
|
||||
#### Pen Tool (`N`)
|
||||
|
||||
Paints with a square brush, by default 1px with 100% hardness. Increasing the thickness results in a larger square with 100% hardness. Useful for making pixel art. To draw a straight line, make a mark, hold `Shift` and click elsewhere.
|
||||
|
||||
#### Brush Tool (`P`)
|
||||
|
||||
Paints with a round brush, by default 20px with feathered edges. Size and Hardness can be adjusted. Useful for a more natural appearance. To draw a straight line, make a mark, hold `Shift` and click elsewhere.
|
||||
|
||||
#### Bucket Tool (`Shift+B`)
|
||||
|
||||
Will fill a closed shape, otherwise it will fill the whole layer.
|
||||
|
||||
#### Spray Tool (`Shift+S`)
|
||||
|
||||
Creates a textured effect by scattering pixels randomly within the round brush. The size of and density (how closely packed the pixels are painted) of the spray can be adjusted. Useful for creating fading effects.
|
||||
|
||||
#### Pick Tool (`O`)
|
||||
Will make any selected color the primary color. By default, it samples only the active layer unless the option *Sample all layers* is selected. Quickly use at any time by holding `Alt`.
|
||||
|
||||
Will make any selected color the primary color. By default, it samples only the active layer unless the option _Sample all layers_ is selected. Quickly use at any time by holding `Alt`.
|
||||
|
||||
#### Erase Tool (`Shift+E`)
|
||||
Erases pixels from the current layer. Has two modes: Pencil (square brush with 100% hardness) and Brush (circular with adjustable hardness). Enabling *Use secondary color* will apply the secondary color instead of making that part of the layer transparent.
|
||||
|
||||
Erases pixels from the current layer. Has two modes: Pencil (square brush with 100% hardness) and Brush (circular with adjustable hardness). Enabling _Use secondary color_ will apply the secondary color instead of making that part of the layer transparent.
|
||||
|
||||
#### Line Tool (`Ctrl+Shift+L`)
|
||||
|
||||
Creates a vector line that is rasterized (converted into a pixel equivalent) upon releasing the mouse. To constrain the angle to 22.5° increments hold `Shift` whilst drawing the line.
|
||||
|
||||
#### Rectangle Tool (`Ctrl+Shift+R`)
|
||||
|
||||
Draws a vector rectangle that is rasterized upon releasing the mouse. To draw a square hold `Shift` whilst drawing the shape.
|
||||
|
||||
Options:
|
||||
* **Outline** - Rectangle with no fill. The line thickness can be adjusted.
|
||||
* **Fill** - Filled with the primary color.
|
||||
* **Gradient** - Filled with a gradient between the primary and secondary colors, from left-to-right.
|
||||
* **Rounded** - Draws a vector square with rounded corners that is rasterized upon releasing the mouse. Adjust the corner radius before drawing, as it cannot be changed afterward.
|
||||
* **Anti-alias** - Smoothens jagged edges for a more polished appearance.
|
||||
* **Aspect ratio** - Sets the ratio of width and height (e.g. `1` x `1` for a square).
|
||||
|
||||
- **Outline** - Rectangle with no fill. The line thickness can be adjusted.
|
||||
- **Fill** - Filled with the primary color.
|
||||
- **Gradient** - Filled with a gradient between the primary and secondary colors, from left-to-right.
|
||||
- **Rounded** - Draws a vector square with rounded corners that is rasterized upon releasing the mouse. Adjust the corner radius before drawing, as it cannot be changed afterward.
|
||||
- **Anti-alias** - Smoothens jagged edges for a more polished appearance.
|
||||
- **Aspect ratio** - Sets the ratio of width and height (e.g. `1` x `1` for a square).
|
||||
|
||||
#### Ellipse Tool (`Ctrl+Shift+E`)
|
||||
|
||||
Draws a vector ellipse that is rasterized upon releasing the mouse. To draw a circle hold `Shift` whilst drawing the shape. Has many of the same options as the Rectangle Tool.
|
||||
|
||||
#### Text Tool (`Ctrl+Shift+T`)
|
||||
|
||||
Click to place the text and start typing. Use `Shift+Enter` to create a new line. Press `Esc` to cancel. The text will use the primary color. Choosing a different color will change the color of the text. Modify the font and font size in the Tool properties. Adjust the text's position while editing. Once you press `Enter` or click away from the text, it will be rasterized and become non-editable.
|
||||
|
||||
#### Zoom Tool (`Z`)
|
||||
|
||||
Left-click to zoom-in, right-click to zoom-out. Adjust the increment size in the Tool properties.
|
||||
|
||||
#### Selection Tools
|
||||
Select All with `Ctrl+A`. Press `Esc` to clear a selection. Invert a selection in the *Edit* menu.
|
||||
|
||||
Select All with `Ctrl+A`. Press `Esc` to clear a selection. Invert a selection in the _Edit_ menu.
|
||||
|
||||
Modes:
|
||||
* **Set** - Making an initial selection.
|
||||
* **Add** - Expands the selection area with each new selection, including merging areas.
|
||||
* **Subtract** - Removes areas from selection.
|
||||
* **Intersect** - Keeps the overlap with other selections.
|
||||
|
||||
- **Set** - Making an initial selection.
|
||||
- **Add** - Expands the selection area with each new selection, including merging areas.
|
||||
- **Subtract** - Removes areas from selection.
|
||||
- **Intersect** - Keeps the overlap with other selections.
|
||||
|
||||
##### Rectangle Select Tool (`R`)
|
||||
|
||||
Selects a rectangular-shaped area. Holding `Ctrl` will expand the selection equally on all sides.
|
||||
|
||||
##### Wand Select Tool (`W`)
|
||||
|
||||
Selects an area based on its color. Adjust the threshold for a more or less precise selection.
|
||||
|
||||
##### Polygonal Select Tool (`Shift+P`)
|
||||
Click to draw the vertices of a polygon. Hold `Shift` to constrain to 22.5° increments. It will become a selected area once a whole shape. Quickly close a shape by double-clicking. *Feathering* can be adjusted, which in this context will give rounded corners.
|
||||
|
||||
Click to draw the vertices of a polygon. Hold `Shift` to constrain to 22.5° increments. It will become a selected area once a whole shape. Quickly close a shape by double-clicking. _Feathering_ can be adjusted, which in this context will give rounded corners.
|
||||
|
||||
##### Lasso Select Tool (`L`)
|
||||
|
||||
Freehand draw a shape, which will become a selected area once whole. Letting go of the mouse will automatically close the shape.
|
||||
|
||||
#### Guide Tool (`G`)
|
||||
Create a guide line by dragging from either of the rulers surrounding the Canvas. Hold `Shift` whilst dragging to do this in 10px increments (adjustable in the Tool properties). Existing guides can be moved. Right-click on a guide to delete it or open the *Set Offset* menu to modify its orientation and offset (the distance in pixels from the top or left-hand ruler). Useful for maintaining alignment when editing. Guide lines are not visible on export.
|
||||
|
||||
Create a guide line by dragging from either of the rulers surrounding the Canvas. Hold `Shift` whilst dragging to do this in 10px increments (adjustable in the Tool properties). Existing guides can be moved. Right-click on a guide to delete it or open the _Set Offset_ menu to modify its orientation and offset (the distance in pixels from the top or left-hand ruler). Useful for maintaining alignment when editing. Guide lines are not visible on export.
|
||||
|
||||
#### Clone Tool (`C`)
|
||||
|
||||
Hold the `Alt` key and click to specify the area to clone (indicated by a green circle). Then paint the clone. Currently it can only clone from the same layer. Size and Hardness of the brush can be adjusted.
|
||||
|
||||
#### Gradient Tool (`Ctrl+G`)
|
||||
|
||||
Click and drag to create a gradient, transitioning from the primary color to transparent by default. Change it to go from the primary to the secondary color in the Tool properties. Adjust the colors in the Color Panel. Move the gradient by grabbing the middle handle and change the size and orientation with the outer handles. Hold `Shift` to constrain to a horizontal or vertical orientation. Press `Enter` to rasterize or `Esc` to cancel.
|
||||
|
||||
### Editor Panels
|
||||
To the right of the main workspace, editor panels facilitate layer configuration, tool adjustments and provide information about the colors in an image. Minimize a panel by double-clicking its name label or using the toggle. Rearrange panels by dragging the name label. Turn them into resizable windows by dragging them out or pressing the detach icon. Turn all of them into a separate window by dragging the *Editor Panels* label out or pressing its detach icon. Turn a detached window back into a panel by closing the window.
|
||||
|
||||
To the right of the main workspace, editor panels facilitate layer configuration, tool adjustments and provide information about the colors in an image. Minimize a panel by double-clicking its name label or using the toggle. Rearrange panels by dragging the name label. Turn them into resizable windows by dragging them out or pressing the detach icon. Turn all of them into a separate window by dragging the _Editor Panels_ label out or pressing its detach icon. Turn a detached window back into a panel by closing the window.
|
||||
|
||||
The default panels are:
|
||||
* **Layers** - Add, remove, reorder or manipulate layers. Adjust layers by right-clicking or in the *Layers* menu.
|
||||
* **Masks** - An overlay that controls a layer's visibility: black hides, white shows and shades of gray provide varying levels of transparency. Masks are non-destructive, allowing reversible edits without permanently altering the original image. Return to the mask menu to delete (completely remove a mask), apply (merge the mask and the underlying layer), invert (reverse the black and white contents) and clear (retain an empty mask layer).
|
||||
* **Layer properties** - Rename, show/hide or adjust the opacity of a layer.
|
||||
* **Tool properties** - Configure the settings for the currently selected tool.
|
||||
|
||||
- **Layers** - Add, remove, reorder or manipulate layers. Adjust layers by right-clicking or in the _Layers_ menu.
|
||||
- **Masks** - An overlay that controls a layer's visibility: black hides, white shows and shades of gray provide varying levels of transparency. Masks are non-destructive, allowing reversible edits without permanently altering the original image. Return to the mask menu to delete (completely remove a mask), apply (merge the mask and the underlying layer), invert (reverse the black and white contents) and clear (retain an empty mask layer).
|
||||
- **Layer properties** - Rename, show/hide or adjust the opacity of a layer.
|
||||
- **Tool properties** - Configure the settings for the currently selected tool.
|
||||
|
||||
#### Color Visualizations
|
||||
|
||||
|
||||
|
||||
Two additional editor panels that visualize color can be enabled in *View → Scopes*:
|
||||
* **Histogram** - A graph showing the range of color tones in an image, from the darkest on the left to the lightest on the right. As the cursor hovers over the canvas, a yellow line indicates where the pixels under the cursor are represented on the graph.
|
||||
* **Vectorscope** - Corresponding to the [color wheel](https://en.wikipedia.org/wiki/Color_wheel), the markings indicate the degree of Hue and Saturation in an image. The further the marking from the center, the greater the Saturation. The line going up between red and yellow is the Skin Tone Line indicating the optimal location for all skin tones. As the cursor hovers over the canvas, a circle highlights where the colors are represented on the Vectorscope.
|
||||
Two additional editor panels that visualize color can be enabled in _View → Scopes_:
|
||||
|
||||
- **Histogram** - A graph showing the range of color tones in an image, from the darkest on the left to the lightest on the right. As the cursor hovers over the canvas, a yellow line indicates where the pixels under the cursor are represented on the graph.
|
||||
- **Vectorscope** - Corresponding to the [color wheel](https://en.wikipedia.org/wiki/Color_wheel), the markings indicate the degree of Hue and Saturation in an image. The further the marking from the center, the greater the Saturation. The line going up between red and yellow is the Skin Tone Line indicating the optimal location for all skin tones. As the cursor hovers over the canvas, a circle highlights where the colors are represented on the Vectorscope.
|
||||
|
||||
### Filters
|
||||
|
||||
|
||||
|
||||
In the *Filter* menu is the Filter Gallery which enables adjustment of the whole image (by default), or a selection, by tweaking colors or applying effects.
|
||||
In the _Filter_ menu is the Filter Gallery which enables adjustment of the whole image (by default), or a selection, by tweaking colors or applying effects.
|
||||
|
||||
#### Artistic
|
||||
* **Bloom** - Adds a glow around bright areas. Adjust the glow area brightness threshold and the radius of the glow.
|
||||
|
||||
- **Bloom** - Adds a glow around bright areas. Adjust the glow area brightness threshold and the radius of the glow.
|
||||
|
||||
#### Edge Detection
|
||||
|
||||
Edge detection highlights transitions between visual elements, emphasizing object boundaries. There are two different methods of achieving this:
|
||||
* **Laplacian Cardinal** - Emphasizes horizontal and vertical edges, accentuating areas with significant intensity changes along these cardinal directions.
|
||||
* **Laplacian Diagonal** - Emphasizes and highlights diagonal edges in an image, focusing on areas with pronounced intensity changes along diagonal directions.
|
||||
|
||||
- **Laplacian Cardinal** - Emphasizes horizontal and vertical edges, accentuating areas with significant intensity changes along these cardinal directions.
|
||||
- **Laplacian Diagonal** - Emphasizes and highlights diagonal edges in an image, focusing on areas with pronounced intensity changes along diagonal directions.
|
||||
|
||||
#### Blur & Sharpen
|
||||
|
||||
Various methods exist for producing a blur, leading to varied results. They differ in how they allocate weight, which represents the value assigned to pixels determining their greater or lesser impact on the final image. The Gaussian and Box Blurs offer two choices: `3x3` and `5x5`, indicating the grid size for blur calculation. In simple terms, a larger grid results in a smoother blur.
|
||||
* **Fast Box Blur** - Quickly blurs an image by averaging the colors of pixels within a defined square area, resulting in a smoother appearance. The blur's radius can be adjusted. Enable *Asymmetric Radii* to adjust the blur along the horizontal, vertical or both axes. Enable *Use Direction and Magnitude* to adjust the blur angle and intensity. The *Approximate Gaussian Blur* option achieves a smoother blur by applying the box blur multiple times with different weights.
|
||||
* **Gaussian Blur** - Smoothens an image by gradually blending pixel colors based on a bell-shaped distribution, resulting in a softened appearance.
|
||||
* **Box Blur** - Takes more time than a Fast Box Blur by considering a broader range of neighboring pixels, resulting in a more thorough and refined smoothing.
|
||||
* **Sharpen** - Enhances the clarity and detail of an image by increasing the contrast at edges, making them more distinct.
|
||||
* **Median Filter** - Replaces each pixel's value with the median value of its neighboring pixels, providing effective noise reduction while preserving edges and details. Useful for removing dust or defective pixels from an image.
|
||||
|
||||
- **Fast Box Blur** - Quickly blurs an image by averaging the colors of pixels within a defined square area, resulting in a smoother appearance. The blur's radius can be adjusted. Enable _Asymmetric Radii_ to adjust the blur along the horizontal, vertical or both axes. Enable _Use Direction and Magnitude_ to adjust the blur angle and intensity. The _Approximate Gaussian Blur_ option achieves a smoother blur by applying the box blur multiple times with different weights.
|
||||
- **Gaussian Blur** - Smoothens an image by gradually blending pixel colors based on a bell-shaped distribution, resulting in a softened appearance.
|
||||
- **Box Blur** - Takes more time than a Fast Box Blur by considering a broader range of neighboring pixels, resulting in a more thorough and refined smoothing.
|
||||
- **Sharpen** - Enhances the clarity and detail of an image by increasing the contrast at edges, making them more distinct.
|
||||
- **Median Filter** - Replaces each pixel's value with the median value of its neighboring pixels, providing effective noise reduction while preserving edges and details. Useful for removing dust or defective pixels from an image.
|
||||
|
||||
#### Color
|
||||
* **Hue/Saturation** - Precisely adjust the colors in an image by modifying the type of color, its intensity and the amount of black/white mixed in with it.
|
||||
* **Hue** - The type of color, based on degrees of the color wheel starting from 0% (red).
|
||||
* **Saturation** - The purity of the color, from 0% (black) to 100% (pure color).
|
||||
* **Lightness** - The amount of black/white mixed in with the color, from 0% (black) to 100% (white).
|
||||
* **Grayscale** - Converts an image to black and white by removing the color information, resulting in shades of gray based on the original colors' intensity.
|
||||
* **Invert** - Transforms an image by reversing the colors, turning dark areas light and vice versa.
|
||||
* **Sepia** - Makes an image black and white while adding warm, brownish tones, creating a nostalgic or aged appearance reminiscent of old photographs. The intensity can be adjusted.
|
||||
|
||||
- **Hue/Saturation** - Precisely adjust the colors in an image by modifying the type of color, its intensity and the amount of black/white mixed in with it.
|
||||
- **Hue** - The type of color, based on degrees of the color wheel starting from 0% (red).
|
||||
- **Saturation** - The purity of the color, from 0% (black) to 100% (pure color).
|
||||
- **Lightness** - The amount of black/white mixed in with the color, from 0% (black) to 100% (white).
|
||||
- **Grayscale** - Converts an image to black and white by removing the color information, resulting in shades of gray based on the original colors' intensity.
|
||||
- **Invert** - Transforms an image by reversing the colors, turning dark areas light and vice versa.
|
||||
- **Sepia** - Makes an image black and white while adding warm, brownish tones, creating a nostalgic or aged appearance reminiscent of old photographs. The intensity can be adjusted.
|
||||
|
||||
#### Generic 5x5 Convolution
|
||||
The last option in the *Filter* menu, a Generic 5x5 Convolution filter alters an image by using a 5x5 grid of numbers to recalculate each pixel's appearance based on its nearby pixels. The *Normalize* option keeps the brightness consistent, maintaining a balanced and normalized appearance. The *Wrap* options makes sure calculations consider pixels on the other side, especially at the image edges, for a smoother effect. Without wrapping, the convolution might produce artifacts or irregularities at the image borders.
|
||||
|
||||
The last option in the _Filter_ menu, a Generic 5x5 Convolution filter alters an image by using a 5x5 grid of numbers to recalculate each pixel's appearance based on its nearby pixels. The _Normalize_ option keeps the brightness consistent, maintaining a balanced and normalized appearance. The _Wrap_ options makes sure calculations consider pixels on the other side, especially at the image edges, for a smoother effect. Without wrapping, the convolution might produce artifacts or irregularities at the image borders.
|
||||
|
||||
## Arguments
|
||||
* `file`: The image file to be edited
|
||||
|
||||
- `file`: The image file to be edited
|
||||
|
||||
## Example
|
||||
|
||||
```sh
|
||||
$ PixelPaint /home/anon/Documents/cat.jpg
|
||||
```
|
||||
|
|
|
|||
|
|
@ -27,11 +27,11 @@ Profiler can also load performance information from previously created
|
|||
|
||||
## Options
|
||||
|
||||
* `-p PID`, `--pid PID`: PID to profile
|
||||
- `-p PID`, `--pid PID`: PID to profile
|
||||
|
||||
## Arguments
|
||||
|
||||
* `perfcore-file`: Path of perfcore file to load
|
||||
- `perfcore-file`: Path of perfcore file to load
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -49,5 +49,5 @@ $ Profiler perfcore.123
|
|||
|
||||
## See also
|
||||
|
||||
* [`perfcore`(5)](help://man/5/perfcore)
|
||||
* [`profile`(1)](help://man/1/profile)
|
||||
- [`perfcore`(5)](help://man/5/perfcore)
|
||||
- [`profile`(1)](help://man/1/profile)
|
||||
|
|
|
|||
|
|
@ -17,8 +17,8 @@ SQL scripts.
|
|||
|
||||
## Arguments
|
||||
|
||||
* `script.sql`: SQL script to open, edit or run
|
||||
* `database.db`: SQL database to open and run scripts against
|
||||
- `script.sql`: SQL script to open, edit or run
|
||||
- `database.db`: SQL database to open and run scripts against
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -18,11 +18,11 @@ Its interface remains invisible in screenshots, ensuring a clean capture.
|
|||
|
||||
## Options
|
||||
|
||||
* **Whole desktop** - Capture the entire user interface, including the cursor if it's visible on the desktop.
|
||||
* **Selected area** - Click and drag to select a specific area. Release the mouse button to take a screenshot. The cursor will not be included.
|
||||
* **Edit in Pixel Paint** - Open the screenshot as a new image in [Pixel Paint](help://man/1/Applications/PixelPaint) for quick annotations.
|
||||
* **Select Folder** - Customize the destination folder for saving screenshots. By default, they are saved in the *Pictures* folder.
|
||||
- **Whole desktop** - Capture the entire user interface, including the cursor if it's visible on the desktop.
|
||||
- **Selected area** - Click and drag to select a specific area. Release the mouse button to take a screenshot. The cursor will not be included.
|
||||
- **Edit in Pixel Paint** - Open the screenshot as a new image in [Pixel Paint](help://man/1/Applications/PixelPaint) for quick annotations.
|
||||
- **Select Folder** - Customize the destination folder for saving screenshots. By default, they are saved in the _Pictures_ folder.
|
||||
|
||||
## See Also
|
||||
|
||||
* [`shot`(1)](help://man/1/shot) Command line screenshot tool with more options
|
||||
- [`shot`(1)](help://man/1/shot) Command line screenshot tool with more options
|
||||
|
|
|
|||
|
|
@ -18,26 +18,28 @@ It can be launched from the System Menu or the quick access icon to its right, v
|
|||
|
||||
Select `File → Terminal Settings` to launch the Terminal Settings dialog and display user configurable application properties. This dialog box contains two tabs: View and Terminal.
|
||||
|
||||
The *View* tab provides the most frequently sought options:
|
||||
* Adjust the Terminal font (turn off `Use system default` to select a custom font.
|
||||
* Specify background opacity, i.e. the amount to which the Terminal's background is transparent, displaying what's underneath.
|
||||
* Change the shape of the cursor from Block, to Underscore or to Vertical bar. You can also opt to enable or disable cursor's blink property.
|
||||
* To enable or disable the display of terminal scrollbar.
|
||||
The _View_ tab provides the most frequently sought options:
|
||||
|
||||
The *Terminal* tab gives less frequently used options:
|
||||
* To either enable System beep, or use Visual bell or disable bell mode altogether.
|
||||
* To change Terminal's exit behavior
|
||||
- Adjust the Terminal font (turn off `Use system default` to select a custom font.
|
||||
- Specify background opacity, i.e. the amount to which the Terminal's background is transparent, displaying what's underneath.
|
||||
- Change the shape of the cursor from Block, to Underscore or to Vertical bar. You can also opt to enable or disable cursor's blink property.
|
||||
- To enable or disable the display of terminal scrollbar.
|
||||
|
||||
Clicking on the *Apply* button will cause the currently selected options to take effect immediately.
|
||||
The _Terminal_ tab gives less frequently used options:
|
||||
|
||||
- To either enable System beep, or use Visual bell or disable bell mode altogether.
|
||||
- To change Terminal's exit behavior
|
||||
|
||||
Clicking on the _Apply_ button will cause the currently selected options to take effect immediately.
|
||||
|
||||
You can toggle Fullscreen mode by pressing F11.
|
||||
|
||||
## Options
|
||||
|
||||
* `--help`: Display help message and exit
|
||||
* `--version`: Print version
|
||||
* `-e`: Execute this command inside the terminal
|
||||
* `-k`: Keep the terminal open after the command has finished executing
|
||||
- `--help`: Display help message and exit
|
||||
- `--version`: Print version
|
||||
- `-e`: Execute this command inside the terminal
|
||||
- `-k`: Keep the terminal open after the command has finished executing
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -17,11 +17,11 @@ which allows automatic live rendering of HTML and Markdown documents.
|
|||
|
||||
## Options
|
||||
|
||||
* `--preview-mode mode`: Preview mode, one of 'none', 'html', 'markdown', 'auto'
|
||||
- `--preview-mode mode`: Preview mode, one of 'none', 'html', 'markdown', 'auto'
|
||||
|
||||
## Arguments
|
||||
|
||||
* `file[:line[:column]]`: File to edit, with optional starting line and column number
|
||||
- `file[:line[:column]]`: File to edit, with optional starting line and column number
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -24,12 +24,12 @@ The `Shell` utility does not promise POSIX `sh` interoperability.
|
|||
|
||||
## Options
|
||||
|
||||
* `-c`, `--command-string`: Executes the given string as a command and exits
|
||||
* `--skip-shellrc`: Skips running the initialization file (at `~/.shellrc`)
|
||||
* `--format`: Format shell code from the given file and print the result to standard output
|
||||
* `-f`, `--live-formatting`: Enable live formatting of the line editor buffer (in REPL mode)
|
||||
* `--keep-open`: Keep the shell open after running the specified command or file
|
||||
* `--posix`: Behave like a POSIX-compatible shell
|
||||
- `-c`, `--command-string`: Executes the given string as a command and exits
|
||||
- `--skip-shellrc`: Skips running the initialization file (at `~/.shellrc`)
|
||||
- `--format`: Format shell code from the given file and print the result to standard output
|
||||
- `-f`, `--live-formatting`: Enable live formatting of the line editor buffer (in REPL mode)
|
||||
- `--keep-open`: Keep the shell open after running the specified command or file
|
||||
- `--posix`: Behave like a POSIX-compatible shell
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -46,4 +46,4 @@ Shell foo a b c
|
|||
|
||||
## See also
|
||||
|
||||
* [`Shell-vars`(7)](help://man/7/Shell-vars) For details on local and environment variables used by the shell
|
||||
- [`Shell-vars`(7)](help://man/7/Shell-vars) For details on local and environment variables used by the shell
|
||||
|
|
|
|||
|
|
@ -16,11 +16,11 @@ While `abench` is running, it doesn't report anything to make measurements more
|
|||
|
||||
## Options
|
||||
|
||||
* `-s`, `--sample-count`: How many samples to load at maximum. This allows you to only benchmark some initial chunk of the file, which is useful when testing on quirky files that happen to be large.
|
||||
- `-s`, `--sample-count`: How many samples to load at maximum. This allows you to only benchmark some initial chunk of the file, which is useful when testing on quirky files that happen to be large.
|
||||
|
||||
## Arguments
|
||||
|
||||
* `path`: Path to audio file. As usual, the file type is determined automatically.
|
||||
- `path`: Path to audio file. As usual, the file type is determined automatically.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -24,29 +24,29 @@ By specifying `--audio-format`, `aconv` will use a different sample format for t
|
|||
|
||||
Note that `aconv` currently only supports codecs which have their own bespoke container. Therefore, the distinction does not currently matter. The names given below are the only recognized names for this codec for the command line options `--audio-codec` and `--input-audio-codec`. Some codecs can only be decoded or both encoded and decoded.
|
||||
|
||||
* `mp3` (decode): MPEG Layer III audio codec and container.
|
||||
* `wav` (decode, encode): RIFF WAVE audio codec and container. Supports sample formats `u8` and `s16le` for writing.
|
||||
* `flac` (decode, encode): Free Lossless Audio Codec and container. Supports all integer sample formats for writing.
|
||||
* `qoa` (decode): Quite Okay Audio codec and container.
|
||||
- `mp3` (decode): MPEG Layer III audio codec and container.
|
||||
- `wav` (decode, encode): RIFF WAVE audio codec and container. Supports sample formats `u8` and `s16le` for writing.
|
||||
- `flac` (decode, encode): Free Lossless Audio Codec and container. Supports all integer sample formats for writing.
|
||||
- `qoa` (decode): Quite Okay Audio codec and container.
|
||||
|
||||
### Supported Sample Formats
|
||||
|
||||
* `u8`: Unsigned 8-bit integer
|
||||
* `s16le`: Signed 16-bit integer, little endian
|
||||
* `s24le`: Signed 24-bit integer, little endian
|
||||
* `s32le`: Signed 32-bit integer, little endian
|
||||
* `f32le`: 32-bit IEEE 754 floating-point number (normalized to the range [-1, 1]), little endian
|
||||
* `f64le`: 64-bit IEEE 754 floating-point number (normalized to the range [-1, 1]), little endian
|
||||
- `u8`: Unsigned 8-bit integer
|
||||
- `s16le`: Signed 16-bit integer, little endian
|
||||
- `s24le`: Signed 24-bit integer, little endian
|
||||
- `s32le`: Signed 32-bit integer, little endian
|
||||
- `f32le`: 32-bit IEEE 754 floating-point number (normalized to the range [-1, 1]), little endian
|
||||
- `f64le`: 64-bit IEEE 754 floating-point number (normalized to the range [-1, 1]), little endian
|
||||
|
||||
## Options
|
||||
|
||||
The option format follows this general pattern: `--input_or_output-stream-parameter`, where `input_or_output` is either `input` when concerning the input stream, or omitted for the output stream (since this is the more common use case), `stream` currently is always `audio`, and `parameter` is the parameter of the stream that is changed.
|
||||
|
||||
* `-i`, `--input`: The input file to convert from. Use `-` to read from standard input.
|
||||
* `-o`, `--output`: The output file to write to. Use `-` to write to standard output.
|
||||
* `--input-audio-codec`: Overwrite the used codec and/or sample format of the input file.
|
||||
* `--audio-codec`: The codec to use for the output file.
|
||||
* `--audio-format`: The sample format to use for the output file.
|
||||
- `-i`, `--input`: The input file to convert from. Use `-` to read from standard input.
|
||||
- `-o`, `--output`: The output file to write to. Use `-` to write to standard output.
|
||||
- `--input-audio-codec`: Overwrite the used codec and/or sample format of the input file.
|
||||
- `--audio-codec`: The codec to use for the output file.
|
||||
- `--audio-format`: The sample format to use for the output file.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -63,5 +63,5 @@ $ aconv -i ~/music.wav --audio-format u8 -o -
|
|||
|
||||
## See Also
|
||||
|
||||
* [`abench`(1)](help://man/1/abench) to test audio decoders and measure their performance
|
||||
* [`aplay`(1)](help://man/1/aplay) to play audio files from the command line
|
||||
- [`abench`(1)](help://man/1/abench) to test audio decoders and measure their performance
|
||||
- [`aplay`(1)](help://man/1/aplay) to play audio files from the command line
|
||||
|
|
|
|||
|
|
@ -23,8 +23,8 @@ seconds total, not by 2 seconds.
|
|||
|
||||
## Options
|
||||
|
||||
* `-s delta_seconds`, `--set delta_seconds`: Adjust system time by
|
||||
`delta_seconds`. Must be superuser.
|
||||
- `-s delta_seconds`, `--set delta_seconds`: Adjust system time by
|
||||
`delta_seconds`. Must be superuser.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -18,8 +18,8 @@ It is primarily used to test the kernel's memory management capabilities.
|
|||
|
||||
## Options
|
||||
|
||||
* `-u`, `--size-unit`: Allocation's Size Unit (Base 2 units - B, KiB, MiB or GiB)
|
||||
* `-n`, `--sleep-time`: Number of seconds to sleep before freeing memory
|
||||
- `-u`, `--size-unit`: Allocation's Size Unit (Base 2 units - B, KiB, MiB or GiB)
|
||||
- `-n`, `--sleep-time`: Number of seconds to sleep before freeing memory
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -14,12 +14,12 @@ This program plays an audio file specified in `path` through AudioServer.
|
|||
|
||||
## Options
|
||||
|
||||
* `-l`, `--loop`: Loop playback
|
||||
* `-s`, `--sample-progress`: Switch to (old-style) sample playback progress. By default, playback is printed as played, remaining and total length, all in minutes and seconds.
|
||||
- `-l`, `--loop`: Loop playback
|
||||
- `-s`, `--sample-progress`: Switch to (old-style) sample playback progress. By default, playback is printed as played, remaining and total length, all in minutes and seconds.
|
||||
|
||||
## Arguments
|
||||
|
||||
* `path`: Path to audio file
|
||||
- `path`: Path to audio file
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -16,14 +16,14 @@ ARP stands for Address Resolution Protocol, which is used to find devices in loc
|
|||
|
||||
## Options
|
||||
|
||||
* `-s`, `--set`: Set an ARP table entry
|
||||
* `-d`, `--delete`: Delete an ARP table entry
|
||||
* `-n`, `--numeric`: Display numerical addresses. Don't resolve hostnames
|
||||
- `-s`, `--set`: Set an ARP table entry
|
||||
- `-d`, `--delete`: Delete an ARP table entry
|
||||
- `-n`, `--numeric`: Display numerical addresses. Don't resolve hostnames
|
||||
|
||||
## Arguments
|
||||
|
||||
* `address`: IPv4 protocol address
|
||||
* `hwaddress`: Hardware address
|
||||
- `address`: IPv4 protocol address
|
||||
- `hwaddress`: Hardware address
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -14,12 +14,12 @@ This program is used to send control signals to the AudioServer and the sound ha
|
|||
|
||||
## Options
|
||||
|
||||
* `-h`, `--human-readable`: Print human-readable output. If this option is not given, the output of `get` will be machine-readable and only consist of one line.
|
||||
- `-h`, `--human-readable`: Print human-readable output. If this option is not given, the output of `get` will be machine-readable and only consist of one line.
|
||||
|
||||
## Arguments
|
||||
|
||||
* `command`: The command to execute, either `get` or `set`.
|
||||
* `args`: The arguments to the command.
|
||||
- `command`: The command to execute, either `get` or `set`.
|
||||
- `args`: The arguments to the command.
|
||||
|
||||
There are two commands available: `get` reports the state of audio variables, and `set` changes these variables.
|
||||
|
||||
|
|
@ -28,9 +28,10 @@ There are two commands available: `get` reports the state of audio variables, an
|
|||
`set` expects one or more variables followed by a value to set them to, and will set the variables to the given values. A variable can be given multiple times and the last specified value will remain with the audio server.
|
||||
|
||||
The available variables are:
|
||||
* `(v)olume`: Audio server volume, in percent. Integer value.
|
||||
* `(m)ute`: Mute state. Boolean value, may be set with `0`, `false` or `1`, `true`.
|
||||
* `sample(r)ate`: Sample rate of the sound card. Integer value.
|
||||
|
||||
- `(v)olume`: Audio server volume, in percent. Integer value.
|
||||
- `(m)ute`: Mute state. Boolean value, may be set with `0`, `false` or `1`, `true`.
|
||||
- `sample(r)ate`: Sample rate of the sound card. Integer value.
|
||||
|
||||
Both commands and arguments can be abbreviated: Commands by their first letter, arguments by the letter in parenthesis.
|
||||
|
||||
|
|
|
|||
|
|
@ -15,8 +15,8 @@ file is not specified or file is `-`.
|
|||
|
||||
## Options
|
||||
|
||||
* `-d`, `--decode`: Decode data
|
||||
* `-w column`, `--wrap column`: When encoding, wrap output after `column` characters
|
||||
- `-d`, `--decode`: Decode data
|
||||
- `-w column`, `--wrap column`: When encoding, wrap output after `column` characters
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@ $ basename <path> [suffix]
|
|||
|
||||
## Arguments
|
||||
|
||||
* `path`: The path which we want to get basename of
|
||||
* `suffix`: Suffix to strip from name
|
||||
- `path`: The path which we want to get basename of
|
||||
- `suffix`: Suffix to strip from name
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@ beep allows the user to beep the PC speaker.
|
|||
|
||||
## Options
|
||||
|
||||
* `-f frequency`, `--beep-tone frequency`: Beep tone (frequency in Hz)
|
||||
* `-n N`, `--duration N`: Duration (N in milliseconds)
|
||||
- `-f frequency`, `--beep-tone frequency`: Beep tone (frequency in Hz)
|
||||
- `-n N`, `--duration N`: Duration (N in milliseconds)
|
||||
|
||||
## Notes
|
||||
|
||||
|
|
@ -35,4 +35,4 @@ $ beep -f 1000 -n 1000
|
|||
|
||||
## See also
|
||||
|
||||
* [`boot_parameters`(7)](help://man/7/boot_parameters)
|
||||
- [`boot_parameters`(7)](help://man/7/boot_parameters)
|
||||
|
|
|
|||
|
|
@ -16,14 +16,14 @@ addresses for each frame in the stack producing a backtrace.
|
|||
|
||||
**NOTE**:
|
||||
|
||||
* Kernel addresses will not be available unless you are super user.
|
||||
- Kernel addresses will not be available unless you are super user.
|
||||
|
||||
* If Kernel addresses are available, they will not be symbolicated unless
|
||||
the current user has access to the `/boot/Kernel` file.
|
||||
- If Kernel addresses are available, they will not be symbolicated unless
|
||||
the current user has access to the `/boot/Kernel` file.
|
||||
|
||||
## Arguments
|
||||
|
||||
* `pid`: Process ID
|
||||
- `pid`: Process ID
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -41,6 +41,6 @@ $ watch -n 1 -- bt 124
|
|||
|
||||
## See also
|
||||
|
||||
* [`Profiler`(1)](help://man/1/Applications/Profiler)
|
||||
- [`Profiler`(1)](help://man/1/Applications/Profiler)
|
||||
|
||||
* [`watch`(1)](help://man/1/watch)
|
||||
- [`watch`(1)](help://man/1/watch)
|
||||
|
|
|
|||
|
|
@ -22,9 +22,9 @@ Days, months and years are specified with numbers. Week starts at Sunday.
|
|||
|
||||
## Options
|
||||
|
||||
* `-s`, `--starting-day`: Specify which day should start the week. Accepts either short or long weekday names or indexes (0 being Sunday).
|
||||
* `-3`, `--three-month-view`: Display the previous, current, and next months side-by-side.
|
||||
* `-y`, `--year`: Display an entire year by laying out months on a grid. If no year number is specified, the current year is used as a default.
|
||||
- `-s`, `--starting-day`: Specify which day should start the week. Accepts either short or long weekday names or indexes (0 being Sunday).
|
||||
- `-3`, `--three-month-view`: Display the previous, current, and next months side-by-side.
|
||||
- `-y`, `--year`: Display an entire year by laying out months on a grid. If no year number is specified, the current year is used as a default.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ This program passes contents of specified `files` to standard output, in the spe
|
|||
|
||||
## Arguments
|
||||
|
||||
* `file`: Files to print
|
||||
- `file`: Files to print
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -53,6 +53,7 @@ cat test.txt test2.txt
|
|||
```
|
||||
|
||||
## See Also
|
||||
* [`head`(1)](help://man/1/head)
|
||||
* [`tail`(1)](help://man/1/tail)
|
||||
* [`cut`(1)](help://man/1/cut)
|
||||
|
||||
- [`head`(1)](help://man/1/head)
|
||||
- [`tail`(1)](help://man/1/tail)
|
||||
- [`cut`(1)](help://man/1/cut)
|
||||
|
|
|
|||
|
|
@ -21,4 +21,4 @@ if the checksums cannot be verified.
|
|||
|
||||
## Options
|
||||
|
||||
* `-c`, `--check`: Verify checksums against `file` or stdin.
|
||||
- `-c`, `--check`: Verify checksums against `file` or stdin.
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ $ chgrp <name> <path...>
|
|||
|
||||
## Options
|
||||
|
||||
* `-h`, `--no-dereference`: Don't follow symlinks
|
||||
- `-h`, `--no-dereference`: Don't follow symlinks
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -29,5 +29,5 @@ $ chgrp <name> <path...>
|
|||
|
||||
## See also
|
||||
|
||||
* [`chmod`(1)](help://man/1/chmod)
|
||||
* [`chown`(1)](help://man/1/chown)
|
||||
- [`chmod`(1)](help://man/1/chmod)
|
||||
- [`chown`(1)](help://man/1/chown)
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ A numeric mode is combination of 1 to 4 numbers. Omitted digits are assumed to b
|
|||
|
||||
## Options
|
||||
|
||||
* `-R`, `--recursive`: Change file modes recursively
|
||||
- `-R`, `--recursive`: Change file modes recursively
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -48,5 +48,5 @@ $ chmod g=r script.sh
|
|||
|
||||
## See also
|
||||
|
||||
* [`chgrp`(1)](help://man/1/chgrp)
|
||||
* [`chown`(1)](help://man/1/chown)
|
||||
- [`chgrp`(1)](help://man/1/chgrp)
|
||||
- [`chown`(1)](help://man/1/chown)
|
||||
|
|
|
|||
|
|
@ -17,9 +17,9 @@ group.
|
|||
|
||||
## Options
|
||||
|
||||
* `-h`, `--no-dereference`: Don't follow symlinks
|
||||
* `-R`, `--recursive`: Change file ownership recursively
|
||||
* `-L`: Follow symlinks while recursing into directories
|
||||
- `-h`, `--no-dereference`: Don't follow symlinks
|
||||
- `-R`, `--recursive`: Change file ownership recursively
|
||||
- `-L`: Follow symlinks while recursing into directories
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -33,5 +33,5 @@ $ chown anon:anon file
|
|||
|
||||
## See also
|
||||
|
||||
* [`chgrp`(1)](help://man/1/chgrp)
|
||||
* [`chmod`(1)](help://man/1/chmod)
|
||||
- [`chgrp`(1)](help://man/1/chgrp)
|
||||
- [`chmod`(1)](help://man/1/chmod)
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ $ chres <width> <height> [scale factor]
|
|||
|
||||
## Options
|
||||
|
||||
* `-s`, `--screen`: Screen
|
||||
- `-s`, `--screen`: Screen
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -25,4 +25,4 @@ $ chres 1920 1080 2
|
|||
|
||||
## Files
|
||||
|
||||
* `/tmp/portal/window` to communicate with WindowServer
|
||||
- `/tmp/portal/window` to communicate with WindowServer
|
||||
|
|
|
|||
|
|
@ -14,19 +14,20 @@ Compare two files and report the location of any differences. By default, execut
|
|||
|
||||
## Options
|
||||
|
||||
* `--help`: Display help message and exit
|
||||
* `-l`, `--verbose`: Output the byte number, and the differing bytes, for every difference.
|
||||
* `-s`, `--silent`: Silence output.
|
||||
- `--help`: Display help message and exit
|
||||
- `-l`, `--verbose`: Output the byte number, and the differing bytes, for every difference.
|
||||
- `-s`, `--silent`: Silence output.
|
||||
|
||||
## Arguments
|
||||
|
||||
* `file1` and `file2`: Files to compare. Use `-` as the file name to read from standard input.
|
||||
- `file1` and `file2`: Files to compare. Use `-` as the file name to read from standard input.
|
||||
|
||||
## Exit status
|
||||
|
||||
* 0 - Files are identical.
|
||||
* 1 - Files are different.
|
||||
* 2 - An error occurred.
|
||||
- 0 - Files are identical.
|
||||
- 1 - Files are different.
|
||||
- 2 - An error occurred.
|
||||
|
||||
## See also
|
||||
* [`comm`(1)](help://man/1/comm)
|
||||
|
||||
- [`comm`(1)](help://man/1/comm)
|
||||
|
|
|
|||
|
|
@ -16,18 +16,18 @@ With no options, `comm` produces a three column output, indented by tabs, of lin
|
|||
|
||||
## Options
|
||||
|
||||
* `-1`: Suppress the output of column 1 (lines unique to `file1`)
|
||||
* `-2`: Suppress the output of column 2 (lines unique to `file2`)
|
||||
* `-3`: Suppress the output of column 3 (lines common to `file1` and `file2`)
|
||||
* `-i`: Use case insensitive comparison of lines
|
||||
* `-c`, `--color`: Always print colored output even if the standard output is not a tty
|
||||
* `--no-color`: Do not print colored output
|
||||
* `-t`, `--total`: Print a summary
|
||||
- `-1`: Suppress the output of column 1 (lines unique to `file1`)
|
||||
- `-2`: Suppress the output of column 2 (lines unique to `file2`)
|
||||
- `-3`: Suppress the output of column 3 (lines common to `file1` and `file2`)
|
||||
- `-i`: Use case insensitive comparison of lines
|
||||
- `-c`, `--color`: Always print colored output even if the standard output is not a tty
|
||||
- `--no-color`: Do not print colored output
|
||||
- `-t`, `--total`: Print a summary
|
||||
|
||||
## Arguments
|
||||
|
||||
* `file1`: First file to compare. (`-` for the standard input)
|
||||
* `file2`: Second file to compare. (`-` for the standard input)
|
||||
- `file1`: First file to compare. (`-` for the standard input)
|
||||
- `file2`: Second file to compare. (`-` for the standard input)
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -50,4 +50,5 @@ $ comm -123it file1_sorted file2_sorted
|
|||
```
|
||||
|
||||
## See also
|
||||
* [`cmp`(1)](help://man/1/cmp)
|
||||
|
||||
- [`cmp`(1)](help://man/1/cmp)
|
||||
|
|
|
|||
|
|
@ -14,13 +14,13 @@ Show or modify values in the configuration files through ConfigServer.
|
|||
|
||||
## Options
|
||||
|
||||
* `-r`, `--remove`: Remove group or key
|
||||
- `-r`, `--remove`: Remove group or key
|
||||
|
||||
## Arguments
|
||||
|
||||
* `domain`: Config domain
|
||||
* `group`: Group name
|
||||
* `key`: Key name
|
||||
* `value`: Value to write
|
||||
- `domain`: Config domain
|
||||
- `group`: Group name
|
||||
- `key`: Key name
|
||||
- `value`: Value to write
|
||||
|
||||
<!-- Auto-generated through ArgsParser -->
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@ $ copy [options...] [text...]
|
|||
|
||||
## Options
|
||||
|
||||
* `-t type`, `--type type`: MIME type of data stored in clipboard. The default type is `text/plain`.
|
||||
* `-c`, `--clear`: Clear the clipboard instead of copying.
|
||||
- `-t type`, `--type type`: MIME type of data stored in clipboard. The default type is `text/plain`.
|
||||
- `-c`, `--clear`: Clear the clipboard instead of copying.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -28,4 +28,5 @@ $ copy foo
|
|||
```
|
||||
|
||||
## See also
|
||||
* [`clipboard`(5)](help://man/5/clipboard)
|
||||
|
||||
- [`clipboard`(5)](help://man/5/clipboard)
|
||||
|
|
|
|||
|
|
@ -18,9 +18,9 @@ If a directory is specified in `source`, the `-R` (recursive) flag is required.
|
|||
|
||||
## Options
|
||||
|
||||
* `-l`, `--link`: Create hard links instead of copying
|
||||
* `-R`, `-r`, `--recursive`: Copy directories recursively
|
||||
* `-v`, `--verbose`: Display what files are copied
|
||||
- `-l`, `--link`: Create hard links instead of copying
|
||||
- `-R`, `-r`, `--recursive`: Copy directories recursively
|
||||
- `-v`, `--verbose`: Display what files are copied
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -36,4 +36,5 @@ $ cp test root
|
|||
```
|
||||
|
||||
## See also
|
||||
* [`mv`(1)](help://man/1/mv)
|
||||
|
||||
- [`mv`(1)](help://man/1/mv)
|
||||
|
|
|
|||
|
|
@ -16,38 +16,39 @@ and can be used to simulate many different kinds of crashes.
|
|||
Some crash tests are only available on certain architectures.
|
||||
|
||||
Some crash tests are excluded from the `-A` test, since depending on the hardware or implementation they may or may not crash.
|
||||
- Priviledged instructions in user mode are permitted by QEMU on some architectures such as x86. Therefore, this crash may not fail. See [discussion on pull request 10042](https://github.com/SerenityOS/serenity/pull/10042#issuecomment-920408568).
|
||||
|
||||
- Priviledged instructions in user mode are permitted by QEMU on some architectures such as x86. Therefore, this crash may not fail. See [discussion on pull request 10042](https://github.com/SerenityOS/serenity/pull/10042#issuecomment-920408568).
|
||||
|
||||
## Options
|
||||
|
||||
All architectures:
|
||||
|
||||
* `-A`: Test that all of the crash types implemented on this architecture crash as expected.
|
||||
* `-s`: Perform a segmentation violation by dereferencing an invalid pointer.
|
||||
* `-i`: Execute an illegal CPU instruction.
|
||||
* `-a`: Call `abort()`.
|
||||
* `-m`: Read a pointer from uninitialized malloc memory, then read from it.
|
||||
* `-f`: Read a pointer from memory freed using `free()`, then read from it.
|
||||
* `-M`: Read a pointer from uninitialized malloc memory, then write to it.
|
||||
* `-F`: Read a pointer from memory freed using `free()`, then write to it.
|
||||
* `-r`: Write to read-only memory.
|
||||
* `-T`: Make a syscall while using an invalid stack pointer.
|
||||
* `-t`: Trigger a page fault while using an invalid stack pointer.
|
||||
* `-S`: Make a syscall from writeable memory.
|
||||
* `-y`: Make a syscall from legitimate memory (but outside syscall-code mapped region).
|
||||
* `-X`: Attempt to execute non-executable memory (Not mapped with PROT\_EXEC).
|
||||
* `-U`: Attempt to use a priviledged (kernel mode or higher) instruction in user mode.
|
||||
* `-p`: Violate `pledge()`'d promises.
|
||||
* `-n`: Perform a failing assertion.
|
||||
* `-R`: Dereference a null RefPtr.
|
||||
- `-A`: Test that all of the crash types implemented on this architecture crash as expected.
|
||||
- `-s`: Perform a segmentation violation by dereferencing an invalid pointer.
|
||||
- `-i`: Execute an illegal CPU instruction.
|
||||
- `-a`: Call `abort()`.
|
||||
- `-m`: Read a pointer from uninitialized malloc memory, then read from it.
|
||||
- `-f`: Read a pointer from memory freed using `free()`, then read from it.
|
||||
- `-M`: Read a pointer from uninitialized malloc memory, then write to it.
|
||||
- `-F`: Read a pointer from memory freed using `free()`, then write to it.
|
||||
- `-r`: Write to read-only memory.
|
||||
- `-T`: Make a syscall while using an invalid stack pointer.
|
||||
- `-t`: Trigger a page fault while using an invalid stack pointer.
|
||||
- `-S`: Make a syscall from writeable memory.
|
||||
- `-y`: Make a syscall from legitimate memory (but outside syscall-code mapped region).
|
||||
- `-X`: Attempt to execute non-executable memory (Not mapped with PROT_EXEC).
|
||||
- `-U`: Attempt to use a priviledged (kernel mode or higher) instruction in user mode.
|
||||
- `-p`: Violate `pledge()`'d promises.
|
||||
- `-n`: Perform a failing assertion.
|
||||
- `-R`: Dereference a null RefPtr.
|
||||
|
||||
x86_64 only:
|
||||
|
||||
* `-I`: Use an x86 I/O instruction in userspace.
|
||||
- `-I`: Use an x86 I/O instruction in userspace.
|
||||
|
||||
AArch64 and x86_64 only:
|
||||
|
||||
* `-d`: Perform a division by zero.
|
||||
- `-d`: Perform a division by zero.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -16,14 +16,14 @@ With no FILE, or when FILE is -, read standard input.
|
|||
|
||||
## Arguments
|
||||
|
||||
* `file`: File(s) to cut
|
||||
- `file`: File(s) to cut
|
||||
|
||||
## Options
|
||||
|
||||
* `-b` `--bytes=list`: Select only these bytes
|
||||
* `-f` `--fields=list`: select only these fields; also print any line that contains no delimiter character
|
||||
* `-d` `--delimiter=delim`: use `delim` instead of `tab` for field delimiter
|
||||
* `-s`, `only-delimited`: suppress lines which don't contain any field delimiter characters
|
||||
- `-b` `--bytes=list`: Select only these bytes
|
||||
- `-f` `--fields=list`: select only these fields; also print any line that contains no delimiter character
|
||||
- `-d` `--delimiter=delim`: use `delim` instead of `tab` for field delimiter
|
||||
- `-s`, `only-delimited`: suppress lines which don't contain any field delimiter characters
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -49,5 +49,6 @@ n
|
|||
```
|
||||
|
||||
## See Also
|
||||
* [`head`(1)](help://man/1/head)
|
||||
* [`cat`(1)](help://man/1/cat)
|
||||
|
||||
- [`head`(1)](help://man/1/head)
|
||||
- [`cat`(1)](help://man/1/cat)
|
||||
|
|
|
|||
|
|
@ -15,15 +15,15 @@ or print the system date and time in various formats.
|
|||
|
||||
## Options
|
||||
|
||||
* `-s`, `--set`: Set system date and time
|
||||
* `-u`, `--unix`: Print date as Unix timestamp
|
||||
* `-i`, `--iso-8601`: Print date in ISO 8601 format
|
||||
* `-r`, `--rfc-3339`: Print date in RFC 3339 format
|
||||
* `-R`, `--rfc-5322`: Print date in RFC 5322 format
|
||||
- `-s`, `--set`: Set system date and time
|
||||
- `-u`, `--unix`: Print date as Unix timestamp
|
||||
- `-i`, `--iso-8601`: Print date in ISO 8601 format
|
||||
- `-r`, `--rfc-3339`: Print date in RFC 3339 format
|
||||
- `-R`, `--rfc-5322`: Print date in RFC 5322 format
|
||||
|
||||
## Arguments
|
||||
|
||||
* `format-string`: Custom format to print the date in. Must start with a '+' character.
|
||||
- `format-string`: Custom format to print the date in. Must start with a '+' character.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -39,4 +39,5 @@ $ date -s 1610017485
|
|||
```
|
||||
|
||||
## See Also
|
||||
* [`ntpquery`(1)](help://man/1/ntpquery)
|
||||
|
||||
- [`ntpquery`(1)](help://man/1/ntpquery)
|
||||
|
|
|
|||
|
|
@ -14,20 +14,20 @@ $ dd if=[input_file] of=[output_file] [args...]
|
|||
|
||||
## Options
|
||||
|
||||
* `--help`: Display help message and exit
|
||||
- `--help`: Display help message and exit
|
||||
|
||||
## Arguments
|
||||
|
||||
* `if`: input file (or device) to read from (default: stdin)
|
||||
* `of`: output file (or device) to write to (default: stdout)
|
||||
* `bs`: block size (of bytes) to use (default: 512)
|
||||
* `count`: number of blocks to write
|
||||
* `seek`: number of output blocks to skip (default: 0)
|
||||
* `skip`: number of input blocks to skip (default: 0)
|
||||
* `status`: level of output (default: default)
|
||||
* `default`: error messages + final statistics
|
||||
* `none`: just error messages
|
||||
* `noxfer`: no final statistics
|
||||
- `if`: input file (or device) to read from (default: stdin)
|
||||
- `of`: output file (or device) to write to (default: stdout)
|
||||
- `bs`: block size (of bytes) to use (default: 512)
|
||||
- `count`: number of blocks to write
|
||||
- `seek`: number of output blocks to skip (default: 0)
|
||||
- `skip`: number of input blocks to skip (default: 0)
|
||||
- `status`: level of output (default: default)
|
||||
- `default`: error messages + final statistics
|
||||
- `none`: just error messages
|
||||
- `noxfer`: no final statistics
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -14,12 +14,12 @@ Compare `files` line by line.
|
|||
|
||||
## Arguments
|
||||
|
||||
* `files`: files to compare ex: `file1 file2`
|
||||
- `files`: files to compare ex: `file1 file2`
|
||||
|
||||
## Options
|
||||
|
||||
* `-u`, `-U <context>`, `--unified <context>`: Write diff in unified format with `<unified>` number of surrounding context lines (default 3).
|
||||
* `-c`, `-C <context>`, `--context <context>`: Write diff in context format with `<context>` number of surrounding context lines (default 3).
|
||||
- `-u`, `-U <context>`, `--unified <context>`: Write diff in unified format with `<unified>` number of surrounding context lines (default 3).
|
||||
- `-c`, `-C <context>`, `--context <context>`: Write diff in context format with `<context>` number of surrounding context lines (default 3).
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -10,9 +10,8 @@ $ dirname [--zero] <path...>
|
|||
|
||||
## Options
|
||||
|
||||
* `-z`, `--zero`: End each output line with \0, rather than \n
|
||||
- `-z`, `--zero`: End each output line with \0, rather than \n
|
||||
|
||||
## Arguments
|
||||
|
||||
* `path`: Path
|
||||
|
||||
- `path`: Path
|
||||
|
|
|
|||
|
|
@ -18,11 +18,11 @@ The output may be redirected to another file or utility for further processing.
|
|||
|
||||
## Options
|
||||
|
||||
* `-b`, `--block-size`: Base block size [in KiB] to be used during the utility operation, default is 256 KiB
|
||||
- `-b`, `--block-size`: Base block size [in KiB] to be used during the utility operation, default is 256 KiB
|
||||
|
||||
## Arguments
|
||||
|
||||
* `file`: File to be read
|
||||
- `file`: File to be read
|
||||
|
||||
## Warning
|
||||
|
||||
|
|
|
|||
|
|
@ -14,24 +14,24 @@ $ du [files...]
|
|||
|
||||
## Options
|
||||
|
||||
* `-a`, `--all`: Write counts for all files, not just directories
|
||||
* `--apparent-size`: Print apparent sizes, rather than disk usage
|
||||
* `-c`, `--total`: Print total size in the end
|
||||
* `-h` , `--human-readable`: Print human-readable sizes
|
||||
* `--si`: Print human-readable sizes in SI units
|
||||
* `-d N`, `--max-depth N`: Print the total for a directory or file only if it is N or fewer levels below the command line argument
|
||||
* `-s`, `--summarize`: Display only a total for each argument
|
||||
* `-t size`, `--threshold size`: Exclude entries smaller than size if positive, or entries greater than size if negative
|
||||
* `--time time-type`: Show time of time time-type of any file in the directory, or any of its subdirectories. Available choices: mtime, modification, ctime, status, use, atime, access
|
||||
* `--exclude pattern`: Exclude files that match pattern
|
||||
* `-x`, `--one-file-system`: Don't traverse directories on different file systems
|
||||
* `-X file, --exclude-from`: Exclude files that match any pattern in file
|
||||
* `--max-size`: Exclude files with size above a specified size
|
||||
* `--min-size`: Exclude files with size below a specified size
|
||||
- `-a`, `--all`: Write counts for all files, not just directories
|
||||
- `--apparent-size`: Print apparent sizes, rather than disk usage
|
||||
- `-c`, `--total`: Print total size in the end
|
||||
- `-h` , `--human-readable`: Print human-readable sizes
|
||||
- `--si`: Print human-readable sizes in SI units
|
||||
- `-d N`, `--max-depth N`: Print the total for a directory or file only if it is N or fewer levels below the command line argument
|
||||
- `-s`, `--summarize`: Display only a total for each argument
|
||||
- `-t size`, `--threshold size`: Exclude entries smaller than size if positive, or entries greater than size if negative
|
||||
- `--time time-type`: Show time of time time-type of any file in the directory, or any of its subdirectories. Available choices: mtime, modification, ctime, status, use, atime, access
|
||||
- `--exclude pattern`: Exclude files that match pattern
|
||||
- `-x`, `--one-file-system`: Don't traverse directories on different file systems
|
||||
- `-X file, --exclude-from`: Exclude files that match any pattern in file
|
||||
- `--max-size`: Exclude files with size above a specified size
|
||||
- `--min-size`: Exclude files with size below a specified size
|
||||
|
||||
## Arguments
|
||||
|
||||
* `files`: Files to print disk usage of
|
||||
- `files`: Files to print disk usage of
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -42,8 +42,8 @@ Character escape sequences and their meanings are as follows:
|
|||
|
||||
## Options
|
||||
|
||||
* `-n`: Do not output a trailing newline
|
||||
* `-e`: Interpret backslash escapes
|
||||
- `-n`: Do not output a trailing newline
|
||||
- `-e`: Interpret backslash escapes
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -14,14 +14,14 @@ $ elfdeps [-r] [-f] <path>
|
|||
|
||||
## Options
|
||||
|
||||
* `-f`, `--force-without-valid-interpreter`: Force library resolving on ELF
|
||||
- `-f`, `--force-without-valid-interpreter`: Force library resolving on ELF
|
||||
object without a valid interpreter
|
||||
* `-r`, `--max-recursion`: Max library resolving recursion
|
||||
* `-s`, `--path-only-format`: Use Path-only format printing
|
||||
- `-r`, `--max-recursion`: Max library resolving recursion
|
||||
- `-s`, `--path-only-format`: Use Path-only format printing
|
||||
|
||||
## Arguments
|
||||
|
||||
* `path`: Path to ELF object
|
||||
- `path`: Path to ELF object
|
||||
|
||||
## Security
|
||||
|
||||
|
|
|
|||
|
|
@ -10,10 +10,10 @@ $ env [--ignore-environment] [--split-string S] [--unset name] [env/command...]
|
|||
|
||||
## Options
|
||||
|
||||
* `-i`, `--ignore-environment`: Start with an empty environment
|
||||
* `-S S`, `--split-string S`: Process and split S into separate arguments; used to pass multiple arguments on shebang lines
|
||||
* `-u name`, `--unset name`: Remove variable from the environment
|
||||
- `-i`, `--ignore-environment`: Start with an empty environment
|
||||
- `-S S`, `--split-string S`: Process and split S into separate arguments; used to pass multiple arguments on shebang lines
|
||||
- `-u name`, `--unset name`: Remove variable from the environment
|
||||
|
||||
## Arguments
|
||||
|
||||
* `env/command`: Environment and commands
|
||||
- `env/command`: Environment and commands
|
||||
|
|
|
|||
|
|
@ -10,48 +10,50 @@ $ expr [--help]
|
|||
```
|
||||
|
||||
## Description
|
||||
|
||||
expr evaluates and prints the result of an expression as described below to standard output.
|
||||
|
||||
An _expression_ may be any of the following:
|
||||
- `expr1 | expr2`
|
||||
|
||||
- `expr1 | expr2`
|
||||
`expr2` if `expr1` is falsy, `expr1` otherwise.
|
||||
- `expr1 & expr2`
|
||||
- `expr1 & expr2`
|
||||
`expr1` if neither expression is falsy, `0` otherwise.
|
||||
- `expr1 < expr2`
|
||||
- `expr1 < expr2`
|
||||
`1` if `expr1` is less than `expr2`, `0` otherwise.
|
||||
- `expr1 <= expr2`
|
||||
- `expr1 <= expr2`
|
||||
`1` if `expr1` is less than or equal to `expr2`, `0` otherwise.
|
||||
- `expr1 = expr2`
|
||||
- `expr1 = expr2`
|
||||
`1` if `expr1` is equal to `expr2`, `0` otherwise.
|
||||
- `expr1 = expr2`
|
||||
- `expr1 = expr2`
|
||||
`1` if `expr1` is not equal to `expr2`, `0` otherwise.
|
||||
- `expr1 => expr2`
|
||||
- `expr1 => expr2`
|
||||
`1` if `expr1` is greater than or equal to `expr2`, `0` otherwise.
|
||||
- `expr1 > expr2`
|
||||
- `expr1 > expr2`
|
||||
`1` if `expr1` is greater than `expr2`, `0` otherwise.
|
||||
- `expr1 + expr2`
|
||||
- `expr1 + expr2`
|
||||
arithmetic integral sum of `expr1` and `expr2`.
|
||||
- `expr1 - expr2`
|
||||
- `expr1 - expr2`
|
||||
arithmetic integral difference of `expr1` and `expr2`.
|
||||
- `expr1 * expr2`
|
||||
- `expr1 * expr2`
|
||||
arithmetic integral product of `expr1` and `expr2`.
|
||||
- `expr1 / expr2`
|
||||
- `expr1 / expr2`
|
||||
arithmetic integral quotient of `expr1` divided by `expr2`.
|
||||
- `expr1 % expr2`
|
||||
- `expr1 % expr2`
|
||||
arithmetic integral quotient of `expr1` divided by `expr2`.
|
||||
- `expr1 : expr2`
|
||||
- `expr1 : expr2`
|
||||
pattern match of `expr2` as a regular expression in `expr1` - currently not implemented.
|
||||
- `match expr1 expr2`
|
||||
- `match expr1 expr2`
|
||||
same as `expr1 : expr2`.
|
||||
- `substr expr1 expr2 expr3`
|
||||
- `substr expr1 expr2 expr3`
|
||||
substring with length `expr3` of `expr1`, starting at `expr2`, indices starting at 1.
|
||||
- `index expr1 expr2`
|
||||
- `index expr1 expr2`
|
||||
index of `expr2` in `expr1`, starting at 1. 0 if not found.
|
||||
- `length expr1`
|
||||
- `length expr1`
|
||||
length of the string `expr1`
|
||||
- `+ token`
|
||||
- `+ token`
|
||||
interpret `token` as a string, regardless of whether it is a keyword or an operator.
|
||||
- `( expr )`
|
||||
- `( expr )`
|
||||
value of `expr`
|
||||
|
||||
Note that many operators will need to be escaped or quoted if used from within a shell.
|
||||
|
|
@ -59,7 +61,7 @@ Note that many operators will need to be escaped or quoted if used from within a
|
|||
|
||||
## Options
|
||||
|
||||
* `--help`: Prints usage information and exits.
|
||||
- `--help`: Prints usage information and exits.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -70,5 +72,6 @@ $ expr substr foobar 1 3 # foo
|
|||
```
|
||||
|
||||
## See also
|
||||
* [`test`(1)](help://man/1/test)
|
||||
* [`js`(1)](help://man/1/js) for evaluating more complex expressions
|
||||
|
||||
- [`test`(1)](help://man/1/test)
|
||||
- [`js`(1)](help://man/1/js) for evaluating more complex expressions
|
||||
|
|
|
|||
|
|
@ -16,13 +16,13 @@ First, an attempt is made to identify a given file based on predetermined binary
|
|||
|
||||
## Options
|
||||
|
||||
* `--help`: Display this message
|
||||
* `-b`, `--brief`: Do not prepend file names to output lines
|
||||
* `-I`, `--mime-type`: Only show mime type.
|
||||
- `--help`: Display this message
|
||||
- `-b`, `--brief`: Do not prepend file names to output lines
|
||||
- `-I`, `--mime-type`: Only show mime type.
|
||||
|
||||
## Arguments
|
||||
|
||||
* `files`: Files to identify
|
||||
- `files`: Files to identify
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -33,4 +33,3 @@ Buggie.png: PNG image data, 64 x 138
|
|||
# Identify all files in the current directory, and show only the mime type.
|
||||
$ file -I *
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -15,105 +15,106 @@ $ find [-L] [root-paths...] [commands...]
|
|||
evaluates the given commands for each found file. The commands can be used to
|
||||
both filter the set of files and to perform actions on them.
|
||||
|
||||
If no *action command* (`-print`, `-print0`, or `-exec`) is found among the
|
||||
If no _action command_ (`-print`, `-print0`, or `-exec`) is found among the
|
||||
specified commands, a `-print` command is implicitly appended.
|
||||
|
||||
## Options
|
||||
|
||||
* `-L`: Follow symlinks
|
||||
- `-L`: Follow symlinks
|
||||
|
||||
## Commands
|
||||
|
||||
* `-maxdepth n`: Do not descend more than `n` levels below each path given on
|
||||
the command line. Specifying `-maxdepth 0` has the effect of only evaluating
|
||||
each command line argument.
|
||||
* `-mindepth n`: Descend `n` levels below each path given on the command line
|
||||
before executing any commands. Specifying `-mindepth 1` has the effect of
|
||||
processing all files except the command line arguments.
|
||||
* `-type t`: Checks if the file is of the specified type, which must be one of
|
||||
`b` (for block device), `c` (character device), `d` (directory), `l` (symbolic
|
||||
link), `p` (FIFO), `f` (regular file), and `s` (socket).
|
||||
* `-links [-|+]number`: Checks if the file has the given number of hard links.
|
||||
* `-user name`: Checks if the file is owned by the given user. Instead of a user
|
||||
name, a numerical UID may be specified.
|
||||
* `-group name`: Checks if the file is owned by the given group. Instead of a
|
||||
group name, a numerical GID may be specified.
|
||||
* `-size [-|+]number[bcwkMG]`: Checks if the file uses the specified `n` units of
|
||||
space rounded up to the nearest whole unit.
|
||||
- `-maxdepth n`: Do not descend more than `n` levels below each path given on
|
||||
the command line. Specifying `-maxdepth 0` has the effect of only evaluating
|
||||
each command line argument.
|
||||
- `-mindepth n`: Descend `n` levels below each path given on the command line
|
||||
before executing any commands. Specifying `-mindepth 1` has the effect of
|
||||
processing all files except the command line arguments.
|
||||
- `-type t`: Checks if the file is of the specified type, which must be one of
|
||||
`b` (for block device), `c` (character device), `d` (directory), `l` (symbolic
|
||||
link), `p` (FIFO), `f` (regular file), and `s` (socket).
|
||||
- `-links [-|+]number`: Checks if the file has the given number of hard links.
|
||||
- `-user name`: Checks if the file is owned by the given user. Instead of a user
|
||||
name, a numerical UID may be specified.
|
||||
- `-group name`: Checks if the file is owned by the given group. Instead of a
|
||||
group name, a numerical GID may be specified.
|
||||
- `-size [-|+]number[bcwkMG]`: Checks if the file uses the specified `n` units of
|
||||
space rounded up to the nearest whole unit.
|
||||
|
||||
The '+' and '-' prefixes denote greater than and less than, i.e an exact size
|
||||
of `n` units doesn't match. Sizes are always rounded up to the nearest unit,
|
||||
empty files, while the latter will match files from 0 to 1,048,575 bytes.
|
||||
The '+' and '-' prefixes denote greater than and less than, i.e an exact size
|
||||
of `n` units doesn't match. Sizes are always rounded up to the nearest unit,
|
||||
empty files, while the latter will match files from 0 to 1,048,575 bytes.
|
||||
|
||||
The unit of space may be specified by any of these suffixes:
|
||||
The unit of space may be specified by any of these suffixes:
|
||||
|
||||
* `b`: 512-byte blocks. This is the default unit if no suffix is used.
|
||||
* `c`: bytes
|
||||
* `w`: two-byte words
|
||||
* `k`: kibibytes (1024 bytes)
|
||||
* `M`: mebibytes (1024 kibibytes)
|
||||
* `G`: gibibytes (1024 mebibytes)
|
||||
- `b`: 512-byte blocks. This is the default unit if no suffix is used.
|
||||
- `c`: bytes
|
||||
- `w`: two-byte words
|
||||
- `k`: kibibytes (1024 bytes)
|
||||
- `M`: mebibytes (1024 kibibytes)
|
||||
- `G`: gibibytes (1024 mebibytes)
|
||||
|
||||
* `-path pattern`: Checks if the full file path matches the given global-style
|
||||
pattern. This check matches against the full file name, starting from one of
|
||||
the start points given on the command line. This means that using an absolute
|
||||
path only makes sense in the case where the start point given on the command
|
||||
line is an absolute path. For example, the following command will never match
|
||||
anything:
|
||||
- `-path pattern`: Checks if the full file path matches the given global-style
|
||||
pattern. This check matches against the full file name, starting from one of
|
||||
the start points given on the command line. This means that using an absolute
|
||||
path only makes sense in the case where the start point given on the command
|
||||
line is an absolute path. For example, the following command will never match
|
||||
anything:
|
||||
|
||||
`find bar -ipath '/foo/bar/test_file' -print`
|
||||
`find bar -ipath '/foo/bar/test_file' -print`
|
||||
|
||||
The given path is compared against the current directory concatenated with the
|
||||
basename of the current file. Because such a concatenation can never end in a
|
||||
'/', specifying path argument that ends with a '/' will never match anything.
|
||||
* `-ipath pattern`: Functions identically to `-path` but is case-insensitive.
|
||||
* `-name pattern`: Checks if the file name matches the given global-style
|
||||
pattern (case sensitive).
|
||||
* `-empty`: File is either an empty regular file or a directory containing no
|
||||
files.
|
||||
* `-iname pattern`: Checks if the file name matches the given global-style
|
||||
pattern (case insensitive).
|
||||
* `-readable`: Checks if the file is readable by the current user.
|
||||
* `-writable`: Checks if the file is writable by the current user.
|
||||
* `-executable`: Checks if the file is executable, or directory is searchable,
|
||||
by the current user.
|
||||
* `-newer file`: Checks if the file last modification time is greater than that
|
||||
of the specified reference file. If `file` is a symbolic link and the `-L`
|
||||
option is in use, then the last modification time of the file pointed to by
|
||||
the symbolic link is used.
|
||||
* `-anewer file`: Checks if the file last access time is greater than that of
|
||||
the specified reference file. If `file` is a symbolic link and the `-L`
|
||||
option is in use, then the last access time of the file pointed to by the
|
||||
symbolic link is used.
|
||||
* `-cnewer file`: Checks if the file creation time is greater than that of
|
||||
the specified reference file. If `file` is a symbolic link and the `-L`
|
||||
option is in use, then the creation time of the file pointed to by the
|
||||
symbolic link is used.
|
||||
* `-gid [-|+]number`: Checks if the file is owned by a group with an ID less
|
||||
than, greater than or exactly `number`.
|
||||
* `-uid [-|+]number`: Checks if the file is owned by a user with an ID less
|
||||
than, greater than or exactly `number`.
|
||||
* `-print`: Outputs the file path, followed by a newline. Always evaluates to
|
||||
true.
|
||||
* `-print0`: Outputs the file path, followed by a zero byte. Always evaluates to
|
||||
true.
|
||||
* `-exec command... ;`: Executes the given command with any arguments provided,
|
||||
substituting the file path for any arguments specified as `{}`. The list of
|
||||
arguments must be terminated by a semicolon. Checks if the command exits
|
||||
successfully.
|
||||
* `-ok command... ;`: Behaves identically to the `-exec` command, but will
|
||||
prompt the user for confirmation before executing the given command. An
|
||||
affirmative response is any response that begins with the 'y' character.
|
||||
Any non-affirmative response will cause the command to not be executed and
|
||||
the value returned by `-ok` to be false.
|
||||
The given path is compared against the current directory concatenated with the
|
||||
basename of the current file. Because such a concatenation can never end in a
|
||||
'/', specifying path argument that ends with a '/' will never match anything.
|
||||
|
||||
- `-ipath pattern`: Functions identically to `-path` but is case-insensitive.
|
||||
- `-name pattern`: Checks if the file name matches the given global-style
|
||||
pattern (case sensitive).
|
||||
- `-empty`: File is either an empty regular file or a directory containing no
|
||||
files.
|
||||
- `-iname pattern`: Checks if the file name matches the given global-style
|
||||
pattern (case insensitive).
|
||||
- `-readable`: Checks if the file is readable by the current user.
|
||||
- `-writable`: Checks if the file is writable by the current user.
|
||||
- `-executable`: Checks if the file is executable, or directory is searchable,
|
||||
by the current user.
|
||||
- `-newer file`: Checks if the file last modification time is greater than that
|
||||
of the specified reference file. If `file` is a symbolic link and the `-L`
|
||||
option is in use, then the last modification time of the file pointed to by
|
||||
the symbolic link is used.
|
||||
- `-anewer file`: Checks if the file last access time is greater than that of
|
||||
the specified reference file. If `file` is a symbolic link and the `-L`
|
||||
option is in use, then the last access time of the file pointed to by the
|
||||
symbolic link is used.
|
||||
- `-cnewer file`: Checks if the file creation time is greater than that of
|
||||
the specified reference file. If `file` is a symbolic link and the `-L`
|
||||
option is in use, then the creation time of the file pointed to by the
|
||||
symbolic link is used.
|
||||
- `-gid [-|+]number`: Checks if the file is owned by a group with an ID less
|
||||
than, greater than or exactly `number`.
|
||||
- `-uid [-|+]number`: Checks if the file is owned by a user with an ID less
|
||||
than, greater than or exactly `number`.
|
||||
- `-print`: Outputs the file path, followed by a newline. Always evaluates to
|
||||
true.
|
||||
- `-print0`: Outputs the file path, followed by a zero byte. Always evaluates to
|
||||
true.
|
||||
- `-exec command... ;`: Executes the given command with any arguments provided,
|
||||
substituting the file path for any arguments specified as `{}`. The list of
|
||||
arguments must be terminated by a semicolon. Checks if the command exits
|
||||
successfully.
|
||||
- `-ok command... ;`: Behaves identically to the `-exec` command, but will
|
||||
prompt the user for confirmation before executing the given command. An
|
||||
affirmative response is any response that begins with the 'y' character.
|
||||
Any non-affirmative response will cause the command to not be executed and
|
||||
the value returned by `-ok` to be false.
|
||||
|
||||
The commands can be combined to form complex expressions using the following
|
||||
operators:
|
||||
|
||||
* `! command`: Logical NOT.
|
||||
* `command1 -o command2`: Logical OR.
|
||||
* `command1 -a command2`, `command1 command2`: Logical AND.
|
||||
* `( command )`: Groups commands together for operator priority purposes.
|
||||
- `! command`: Logical NOT.
|
||||
- `command1 -o command2`: Logical OR.
|
||||
- `command1 -a command2`, `command1 command2`: Logical AND.
|
||||
- `( command )`: Groups commands together for operator priority purposes.
|
||||
|
||||
Commands which take a numeric argument `n` (`-links` and `-size` for example),
|
||||
may be prefixed by a plus sign ('+') or a minus sign ('-'). A plus sign means
|
||||
|
|
@ -137,4 +138,4 @@ $ find -name \*config\*
|
|||
|
||||
## See also
|
||||
|
||||
* [`xargs`(1)](help://man/1/xargs)
|
||||
- [`xargs`(1)](help://man/1/xargs)
|
||||
|
|
|
|||
|
|
@ -14,10 +14,10 @@ Open a fortune cookie, receive a free quote for the day!
|
|||
|
||||
## Options
|
||||
|
||||
* `--color when`: Chose when to color the output. Valid options are always, never and auto (default). When color is set to auto, color codes will be emitted when stdout is a terminal
|
||||
- `--color when`: Chose when to color the output. Valid options are always, never and auto (default). When color is set to auto, color codes will be emitted when stdout is a terminal
|
||||
|
||||
## Arguments
|
||||
|
||||
* `path`: Path to JSON file with quotes (/res/fortunes.json by default)
|
||||
- `path`: Path to JSON file with quotes (/res/fortunes.json by default)
|
||||
|
||||
<!-- Auto-generated through ArgsParser -->
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ $ gml-format [--inplace] [path...]
|
|||
|
||||
## Options
|
||||
|
||||
* `-i`, `--inplace`: Write formatted contents back to file rather than standard output
|
||||
- `-i`, `--inplace`: Write formatted contents back to file rather than standard output
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -23,4 +23,5 @@ $ gml-format -i /home/anon/example.gml
|
|||
```
|
||||
|
||||
## See Also
|
||||
* [`GML`(5)](help://man/5/GML)
|
||||
|
||||
- [`GML`(5)](help://man/5/GML)
|
||||
|
|
|
|||
|
|
@ -10,25 +10,25 @@ $ grep [--recursive] [--extended-regexp] [--fixed-strings] [--regexp Pattern] [-
|
|||
|
||||
## Options
|
||||
|
||||
* `-r`, `--recursive`: Recursively scan files
|
||||
* `-E`, `--extended-regexp`: Extended regular expressions
|
||||
* `-F`, `--fixed-strings`: Treat pattern as a string, not a regexp
|
||||
* `-e Pattern`, `--regexp Pattern`: Pattern
|
||||
* `-f File`, `--file File`: Read patterns from a file
|
||||
* `-i`: Make matches case-insensitive
|
||||
* `-n`, `--line-numbers`: Output line-numbers
|
||||
* `-v`, `--invert-match`: Select non-matching lines
|
||||
* `-q`, `--quiet`: Do not write anything to standard output
|
||||
* `-s`, `--no-messages`: Suppress error messages for nonexistent or unreadable files
|
||||
* `--binary-mode`: Action to take for binary files ([binary], text, skip)
|
||||
* `-a`, `--text`: Treat binary files as text (same as --binary-mode text)
|
||||
* `-I`: Ignore binary files (same as --binary-mode skip)
|
||||
* `--color WHEN`: When to use colored output for the matching text ([auto], never, always)
|
||||
* `--no-hyperlinks`: Disable hyperlinks
|
||||
* `-c`, `--count`: Output line count instead of line contents
|
||||
- `-r`, `--recursive`: Recursively scan files
|
||||
- `-E`, `--extended-regexp`: Extended regular expressions
|
||||
- `-F`, `--fixed-strings`: Treat pattern as a string, not a regexp
|
||||
- `-e Pattern`, `--regexp Pattern`: Pattern
|
||||
- `-f File`, `--file File`: Read patterns from a file
|
||||
- `-i`: Make matches case-insensitive
|
||||
- `-n`, `--line-numbers`: Output line-numbers
|
||||
- `-v`, `--invert-match`: Select non-matching lines
|
||||
- `-q`, `--quiet`: Do not write anything to standard output
|
||||
- `-s`, `--no-messages`: Suppress error messages for nonexistent or unreadable files
|
||||
- `--binary-mode`: Action to take for binary files ([binary], text, skip)
|
||||
- `-a`, `--text`: Treat binary files as text (same as --binary-mode text)
|
||||
- `-I`: Ignore binary files (same as --binary-mode skip)
|
||||
- `--color WHEN`: When to use colored output for the matching text ([auto], never, always)
|
||||
- `--no-hyperlinks`: Disable hyperlinks
|
||||
- `-c`, `--count`: Output line count instead of line contents
|
||||
|
||||
## Arguments
|
||||
|
||||
* `file`: File(s) to process
|
||||
- `file`: File(s) to process
|
||||
|
||||
<!-- Auto-generated through ArgsParser -->
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ If no username is provided group memberships are listed for current user.
|
|||
|
||||
## Arguments
|
||||
|
||||
* `username`: username to list group memberships for
|
||||
- `username`: username to list group memberships for
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -30,5 +30,6 @@ $ groups nona anon root
|
|||
```
|
||||
|
||||
## See Also
|
||||
* [`groupdel`(8)](help://man/8/groupdel)
|
||||
* [`groupadd`(8)](help://man/8/groupadd)
|
||||
|
||||
- [`groupdel`(8)](help://man/8/groupdel)
|
||||
- [`groupadd`(8)](help://man/8/groupadd)
|
||||
|
|
|
|||
|
|
@ -12,13 +12,14 @@ $ zcat <FILES...>
|
|||
|
||||
## Options
|
||||
|
||||
* `-k`, `--keep`: Keep (don't delete) input files
|
||||
* `-c`, `--stdout`: Write to stdout, keep original files unchanged
|
||||
* `-d`, `--decompress`: Decompress
|
||||
- `-k`, `--keep`: Keep (don't delete) input files
|
||||
- `-c`, `--stdout`: Write to stdout, keep original files unchanged
|
||||
- `-d`, `--decompress`: Decompress
|
||||
|
||||
## Arguments
|
||||
|
||||
* `FILES`: Files
|
||||
- `FILES`: Files
|
||||
|
||||
## See also
|
||||
* [`tar`(1)](help://man/1/tar)
|
||||
|
||||
- [`tar`(1)](help://man/1/tar)
|
||||
|
|
|
|||
|
|
@ -10,22 +10,21 @@ $ head [option...] [file...]
|
|||
|
||||
## Description
|
||||
|
||||
Print the first 10 lines of each `file` to standard output. With more than one `file`,
|
||||
Print the first 10 lines of each `file` to standard output. With more than one `file`,
|
||||
precede each with a header giving the file name.
|
||||
|
||||
With no `file`, or when `file` is `-`, read standard input.
|
||||
|
||||
## Arguments
|
||||
|
||||
* `file`: File to process
|
||||
- `file`: File to process
|
||||
|
||||
## Options
|
||||
|
||||
* `-n` `--number=NUM`: Number of lines to print (default 10)
|
||||
* `-c` `--bytes=NUM`: Number of bytes to print
|
||||
* `-q` `--quiet`: Never print filenames
|
||||
* `-v` `--verbose`: Always print filenames
|
||||
|
||||
- `-n` `--number=NUM`: Number of lines to print (default 10)
|
||||
- `-c` `--bytes=NUM`: Number of bytes to print
|
||||
- `-q` `--quiet`: Never print filenames
|
||||
- `-v` `--verbose`: Always print filenames
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -40,5 +39,6 @@ Graphical Unix-like operating system for x86 computers.
|
|||
```
|
||||
|
||||
## See also
|
||||
* [`tail`(1)](help://man/1/tail)
|
||||
* [`cat`(1)](help://man/1/cat)
|
||||
|
||||
- [`tail`(1)](help://man/1/tail)
|
||||
- [`cat`(1)](help://man/1/cat)
|
||||
|
|
|
|||
|
|
@ -14,10 +14,10 @@ $ id [options...]
|
|||
|
||||
## Options
|
||||
|
||||
* `-u`: Print only real UID.
|
||||
* `-g`: Print only real GID.
|
||||
* `-G`: Print only all GIDs.
|
||||
* `-n`: If `-u`, `-g` or `-G` is specified, print full names instead of IDs.
|
||||
- `-u`: Print only real UID.
|
||||
- `-g`: Print only real GID.
|
||||
- `-G`: Print only all GIDs.
|
||||
- `-n`: If `-u`, `-g` or `-G` is specified, print full names instead of IDs.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -36,6 +36,6 @@ $ id -G
|
|||
|
||||
## See also
|
||||
|
||||
* [`whoami`(1)](help://man/1/whoami)
|
||||
* [`groups`(1)](help://man/1/groups)
|
||||
* [`usermod`(8)](help://man/8/usermod)
|
||||
- [`whoami`(1)](help://man/1/whoami)
|
||||
- [`groups`(1)](help://man/1/groups)
|
||||
- [`usermod`(8)](help://man/8/usermod)
|
||||
|
|
|
|||
|
|
@ -14,12 +14,13 @@ Display or modify the configuration of each network interface.
|
|||
|
||||
## Options
|
||||
|
||||
* `-i ip`, `--ipv4 ip`: Set the IP address of the selected network
|
||||
* `-a adapter`, `--adapter adapter`: Select a specific network adapter to configure
|
||||
* `-m mask`, `--mask mask`: Set the network mask of the selected network
|
||||
- `-i ip`, `--ipv4 ip`: Set the IP address of the selected network
|
||||
- `-a adapter`, `--adapter adapter`: Select a specific network adapter to configure
|
||||
- `-m mask`, `--mask mask`: Set the network mask of the selected network
|
||||
|
||||
<!-- Auto-generated through ArgsParser -->
|
||||
|
||||
## See Also
|
||||
* [`Network`(5)](help://man/5/Network)
|
||||
* [`netstat`(1)](help://man/1/netstat)
|
||||
|
||||
- [`Network`(5)](help://man/5/Network)
|
||||
- [`netstat`(1)](help://man/1/netstat)
|
||||
|
|
|
|||
|
|
@ -21,17 +21,17 @@ Run `help()` in REPL mode to see its available built-in functions.
|
|||
|
||||
## Options
|
||||
|
||||
* `-A`, `--dump-ast`: Dump the Abstract Syntax Tree after parsing the program.
|
||||
* `-d`, `--dump-bytecode`: Dump the bytecode
|
||||
* `-b`, `--run-bytecode`: Run the bytecode
|
||||
* `-p`, `--optimize-bytecode`: Optimize the bytecode
|
||||
* `-m`, `--as-module`: Treat as module
|
||||
* `-l`, `--print-last-result`: Print the result of the last statement executed.
|
||||
* `-g`, `--gc-on-every-allocation`: Run garbage collection on every allocation.
|
||||
* `-i`, `--disable-ansi-colors`: Disable ANSI colors
|
||||
* `-h`, `--disable-source-location-hints`: Disable source location hints
|
||||
* `-s`, `--no-syntax-highlight`: Disable live syntax highlighting in the REPL
|
||||
* `-c`, `--evaluate`: Evaluate the argument as a script
|
||||
- `-A`, `--dump-ast`: Dump the Abstract Syntax Tree after parsing the program.
|
||||
- `-d`, `--dump-bytecode`: Dump the bytecode
|
||||
- `-b`, `--run-bytecode`: Run the bytecode
|
||||
- `-p`, `--optimize-bytecode`: Optimize the bytecode
|
||||
- `-m`, `--as-module`: Treat as module
|
||||
- `-l`, `--print-last-result`: Print the result of the last statement executed.
|
||||
- `-g`, `--gc-on-every-allocation`: Run garbage collection on every allocation.
|
||||
- `-i`, `--disable-ansi-colors`: Disable ANSI colors
|
||||
- `-h`, `--disable-source-location-hints`: Disable source location hints
|
||||
- `-s`, `--no-syntax-highlight`: Disable live syntax highlighting in the REPL
|
||||
- `-c`, `--evaluate`: Evaluate the argument as a script
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -63,4 +63,4 @@ undefined
|
|||
|
||||
## See also
|
||||
|
||||
* [`test-js`(1)](help://man/1/test-js)
|
||||
- [`test-js`(1)](help://man/1/test-js)
|
||||
|
|
|
|||
|
|
@ -12,17 +12,17 @@ $ json [options...] [path...]
|
|||
|
||||
`json` pretty-prints a JSON file with syntax-coloring and indentation.
|
||||
|
||||
If no *path* argument is provided stdin is used.
|
||||
If no _path_ argument is provided stdin is used.
|
||||
|
||||
## Options
|
||||
|
||||
* `--help`: Display this message
|
||||
* `-i`, `--indent-size`: Size of indentations in spaces
|
||||
* `-q`, `--query`: Dotted query key
|
||||
- `--help`: Display this message
|
||||
- `-i`, `--indent-size`: Size of indentations in spaces
|
||||
- `-q`, `--query`: Dotted query key
|
||||
|
||||
## Arguments
|
||||
|
||||
* `path`: file to pretty-print
|
||||
- `path`: file to pretty-print
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -16,23 +16,26 @@ Layouts loaded from `/res/keymaps/*.json`.
|
|||
|
||||
## Options
|
||||
|
||||
* `-m keymap`, `--set-keymap keymap`: The mapping to be used
|
||||
* `-s keymaps`, `--set-keymaps keymaps`: Comma separated list of enabled mappings
|
||||
- `-m keymap`, `--set-keymap keymap`: The mapping to be used
|
||||
- `-s keymaps`, `--set-keymaps keymaps`: Comma separated list of enabled mappings
|
||||
|
||||
## Examples
|
||||
|
||||
Get name of the currently set keymap:
|
||||
|
||||
```sh
|
||||
$ keymap
|
||||
en-us
|
||||
```
|
||||
|
||||
Select a new list of keymaps:
|
||||
|
||||
```sh
|
||||
$ keymap --set-keymaps en-us,ru
|
||||
```
|
||||
|
||||
Set a keymap:
|
||||
|
||||
```sh
|
||||
$ keymap --set-keymap ru
|
||||
```
|
||||
|
|
|
|||
|
|
@ -19,26 +19,26 @@ but largely incompatible with
|
|||
|
||||
## Options
|
||||
|
||||
* `-P`, `--prompt`: Set the prompt format string. See [Prompts](#prompts) for more details.
|
||||
* `-X`, `--no-init`: Don't switch to the xterm alternate buffer on startup.
|
||||
* `-N`, `--line-numbers`: Show line numbers before printed lines.
|
||||
* `-e`, `--quit-at-eof`: Immediately exit less when the last line of the document is reached.
|
||||
* `-F`, `--quit-if-one-screen`: Exit immediately if the entire file can be displayed on one screen.
|
||||
* `-m`, `--emulate-more`: Apply `-Xe`, set the prompt to `--More--`, and disable
|
||||
scrollback. This option is automatically applied when `less` is executed as `more`
|
||||
- `-P`, `--prompt`: Set the prompt format string. See [Prompts](#prompts) for more details.
|
||||
- `-X`, `--no-init`: Don't switch to the xterm alternate buffer on startup.
|
||||
- `-N`, `--line-numbers`: Show line numbers before printed lines.
|
||||
- `-e`, `--quit-at-eof`: Immediately exit less when the last line of the document is reached.
|
||||
- `-F`, `--quit-if-one-screen`: Exit immediately if the entire file can be displayed on one screen.
|
||||
- `-m`, `--emulate-more`: Apply `-Xe`, set the prompt to `--More--`, and disable
|
||||
scrollback. This option is automatically applied when `less` is executed as `more`
|
||||
|
||||
## Commands
|
||||
|
||||
Commands may be preceded by a decimal number `N`. Currently, this feature
|
||||
does not exist, and no command use `N`.
|
||||
|
||||
| Command | Description |
|
||||
|---------|-------------|
|
||||
| `q` | Exit less. |
|
||||
| `j` or `DOWNARROW` or `ENTER` | Go to the next line. |
|
||||
| `k` or `UPARROW` | Go to the previous line. |
|
||||
| `f` or `SPACE` | Go to the next page. |
|
||||
| `b` | Go to the previous page. |
|
||||
| Command | Description |
|
||||
| ----------------------------- | ------------------------ |
|
||||
| `q` | Exit less. |
|
||||
| `j` or `DOWNARROW` or `ENTER` | Go to the next line. |
|
||||
| `k` or `UPARROW` | Go to the previous line. |
|
||||
| `f` or `SPACE` | Go to the next page. |
|
||||
| `b` | Go to the previous page. |
|
||||
|
||||
## Prompts
|
||||
|
||||
|
|
@ -49,10 +49,10 @@ A `%` followed by a letter will be replaced with the associated variable. If
|
|||
such a variable does not exist, or currently has no value, it will be replaced
|
||||
with a `?`.
|
||||
|
||||
| Variable | Description |
|
||||
|----------|-------------|
|
||||
| `%f` | Replaced with the name of the current file |
|
||||
| `%l` | Replaced with the current line number |
|
||||
| Variable | Description |
|
||||
| -------- | ------------------------------------------ |
|
||||
| `%f` | Replaced with the name of the current file |
|
||||
| `%l` | Replaced with the current line number |
|
||||
|
||||
A `?` followed by a letter acts as an if expression on the associated
|
||||
condition. `:` then acts as the else, and `.` acts as the end token. for example
|
||||
|
|
@ -61,10 +61,10 @@ otherwise, your prompt would be `?etrue:false.`. These expressions are
|
|||
arbitrarily nestable. If a condition does not exist, then it will always
|
||||
evaluate it's false branch.
|
||||
|
||||
| Condition | Description |
|
||||
|----------|-------------|
|
||||
| `?f` | True when reading from a file other than stdin. |
|
||||
| `?e` | True when at the end of a file. |
|
||||
| Condition | Description |
|
||||
| --------- | ----------------------------------------------- |
|
||||
| `?f` | True when reading from a file other than stdin. |
|
||||
| `?e` | True when at the end of a file. |
|
||||
|
||||
A `\\` followed by any character will be replaced with the literal value of the
|
||||
character. For instance, `\\%l` would render as `%l`.
|
||||
|
|
@ -77,5 +77,5 @@ All other characters are treated normally.
|
|||
|
||||
## See Also
|
||||
|
||||
* [`more`(1)](help://man/1/more) For a simpler pager that less implements.
|
||||
* [`man`(1)](help://man/1/man) For serenity's manual pager, that uses less.
|
||||
- [`more`(1)](help://man/1/more) For a simpler pager that less implements.
|
||||
- [`man`(1)](help://man/1/man) For serenity's manual pager, that uses less.
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ lsdir - list directory entries
|
|||
## Description
|
||||
|
||||
This utility will list all directory entries of a given path (or list of paths)
|
||||
and print their inode number and file type (in either POSIX DT_* format or human readable).
|
||||
and print their inode number and file type (in either POSIX DT\_\* format or human readable).
|
||||
|
||||
The utility uses `LibCore` `DirIterator` object and restrict its functionality
|
||||
to the `get_dir_entries` syscall only, to get the raw values of each directory
|
||||
|
|
@ -19,12 +19,12 @@ entry.
|
|||
|
||||
## Options
|
||||
|
||||
* `-P`, `--posix-names`: Show POSIX names for file types
|
||||
* `-t`, `--total-entries-count`: Print count of listed entries when traversing a directory
|
||||
- `-P`, `--posix-names`: Show POSIX names for file types
|
||||
- `-t`, `--total-entries-count`: Print count of listed entries when traversing a directory
|
||||
|
||||
## Arguments
|
||||
|
||||
* `path`: Directory to list
|
||||
- `path`: Directory to list
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -40,4 +40,5 @@ $ lsdir -t /proc
|
|||
```
|
||||
|
||||
## See also
|
||||
* [`ls`(1)](help://man/1/ls)
|
||||
|
||||
- [`ls`(1)](help://man/1/ls)
|
||||
|
|
|
|||
|
|
@ -12,36 +12,36 @@ $ ls [options...] [path...]
|
|||
|
||||
`ls` lists directory contents and attributes.
|
||||
|
||||
If no *path* argument is provided the current working directory is used.
|
||||
If no _path_ argument is provided the current working directory is used.
|
||||
|
||||
## Options
|
||||
|
||||
* `--help`: Display this message
|
||||
* `-a`, `--all`: Show dotfiles
|
||||
* `-A`: Do not list implied . and .. directories
|
||||
* `-B`, `--ignore-backups`: Do not list implied entries ending with ~
|
||||
* `-F`, `--classify`: Append a file type indicator to entries
|
||||
* `-p`: Append a '/' indicator to directories
|
||||
* `-d`, `--directory`: List directories themselves, not their contents
|
||||
* `-l`, `--long`: Display long info
|
||||
* `-t`: Sort files by timestamp (newest first)
|
||||
* `-S`: Sort files by size (largest first)
|
||||
* `-r`, `--reverse`: Reverse sort order
|
||||
* `-G`: Use pretty colors
|
||||
* `-i`, `--inode`: Show inode ids
|
||||
* `-I`, `--raw-inode`: Show raw inode ids if possible (see Notes to understand when this will not work)
|
||||
* `-n`, `--numeric-uid-gid`: In long format, display numeric UID/GID. Implies `-l`
|
||||
* `-o`: In long format, do not show group information. Implies `-l`
|
||||
* `-g`: In long format, do not show owner information. Implies `-l`
|
||||
* `-h`, `--human-readable`: Print human-readable sizes
|
||||
* `--si`: Print human-readable sizes in SI units
|
||||
* `-K`, `--no-hyperlinks`: Disable hyperlinks
|
||||
* `-R`, `--recursive`: List subdirectories recursively
|
||||
* `-1`: List one file per line
|
||||
- `--help`: Display this message
|
||||
- `-a`, `--all`: Show dotfiles
|
||||
- `-A`: Do not list implied . and .. directories
|
||||
- `-B`, `--ignore-backups`: Do not list implied entries ending with ~
|
||||
- `-F`, `--classify`: Append a file type indicator to entries
|
||||
- `-p`: Append a '/' indicator to directories
|
||||
- `-d`, `--directory`: List directories themselves, not their contents
|
||||
- `-l`, `--long`: Display long info
|
||||
- `-t`: Sort files by timestamp (newest first)
|
||||
- `-S`: Sort files by size (largest first)
|
||||
- `-r`, `--reverse`: Reverse sort order
|
||||
- `-G`: Use pretty colors
|
||||
- `-i`, `--inode`: Show inode ids
|
||||
- `-I`, `--raw-inode`: Show raw inode ids if possible (see Notes to understand when this will not work)
|
||||
- `-n`, `--numeric-uid-gid`: In long format, display numeric UID/GID. Implies `-l`
|
||||
- `-o`: In long format, do not show group information. Implies `-l`
|
||||
- `-g`: In long format, do not show owner information. Implies `-l`
|
||||
- `-h`, `--human-readable`: Print human-readable sizes
|
||||
- `--si`: Print human-readable sizes in SI units
|
||||
- `-K`, `--no-hyperlinks`: Disable hyperlinks
|
||||
- `-R`, `--recursive`: List subdirectories recursively
|
||||
- `-1`: List one file per line
|
||||
|
||||
## Arguments
|
||||
|
||||
* `path`: Directory to list
|
||||
- `path`: Directory to list
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -69,4 +69,5 @@ is a mounted filesystem on a directory entry, `lstat` will give the root
|
|||
inode number for that filesystem.
|
||||
|
||||
## See also
|
||||
* [`tree`(1)](help://man/1/tree) to show the contents of the directory and subdirectories in a tree visualization
|
||||
|
||||
- [`tree`(1)](help://man/1/tree) to show the contents of the directory and subdirectories in a tree visualization
|
||||
|
|
|
|||
|
|
@ -14,15 +14,16 @@ List open files of a processes. This can mean actual files in the file system, s
|
|||
|
||||
## Options
|
||||
|
||||
* `-p pid`: Select by PID
|
||||
* `-d fd`: Select by file descriptor
|
||||
* `-u login/UID`: Select by login/UID
|
||||
* `-g PGID`: Select by process group ID
|
||||
- `-p pid`: Select by PID
|
||||
- `-d fd`: Select by file descriptor
|
||||
- `-u login/UID`: Select by login/UID
|
||||
- `-g PGID`: Select by process group ID
|
||||
|
||||
## Arguments
|
||||
|
||||
* `filename`: Filename
|
||||
- `filename`: Filename
|
||||
|
||||
## See Also
|
||||
* [`pmap`(1)](help://man/1/pmap)
|
||||
* [`ps`(1)](help://man/1/ps)
|
||||
|
||||
- [`pmap`(1)](help://man/1/pmap)
|
||||
- [`ps`(1)](help://man/1/ps)
|
||||
|
|
|
|||
|
|
@ -17,20 +17,24 @@ the manual page for `man` program itself right now.
|
|||
|
||||
## Options
|
||||
|
||||
* `-P pager`, `--pager pager`: Pager to pipe the man page to
|
||||
- `-P pager`, `--pager pager`: Pager to pipe the man page to
|
||||
|
||||
## Examples
|
||||
|
||||
To open documentation for the `echo` command:
|
||||
|
||||
```sh
|
||||
$ man echo
|
||||
```
|
||||
|
||||
To open the documentation for the `mkdir` command:
|
||||
|
||||
```sh
|
||||
$ man 1 mkdir
|
||||
```
|
||||
|
||||
Conversely, to open the documentation about the `mkdir()` syscall:
|
||||
|
||||
```sh
|
||||
$ man 2 mkdir
|
||||
```
|
||||
|
|
@ -42,6 +46,6 @@ this man page should be located at `/usr/share/man/man1/man.md`.
|
|||
|
||||
## See Also
|
||||
|
||||
* [`less`(1)](help://man/1/less) For the terminal pager that `man` uses by default
|
||||
* [`Help`(1)](help://man/1/Applications/Help) To read these same man pages in a GUI
|
||||
* [`man`(7)](help://man/7/man) For an overview on how manpages are organized
|
||||
- [`less`(1)](help://man/1/less) For the terminal pager that `man` uses by default
|
||||
- [`Help`(1)](help://man/1/Applications/Help) To read these same man pages in a GUI
|
||||
- [`man`(7)](help://man/7/man) For an overview on how manpages are organized
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ standard input.
|
|||
|
||||
## Options
|
||||
|
||||
* `-H`, `--html`: Render the document into HTML.
|
||||
- `-H`, `--html`: Render the document into HTML.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -28,4 +28,5 @@ $ md --html /usr/share/man/man1/md.md
|
|||
```
|
||||
|
||||
## See Also
|
||||
* [`man`(1)](help://man/1/man) to more easily read manpages
|
||||
|
||||
- [`man`(1)](help://man/1/man) to more easily read manpages
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ $ memstat
|
|||
|
||||
## Options
|
||||
|
||||
* `-h` , `--human-readable`: Print human-readable sizes
|
||||
- `-h` , `--human-readable`: Print human-readable sizes
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -10,14 +10,14 @@ $ mkdir [options...] directories...
|
|||
|
||||
## Description
|
||||
|
||||
Create a new empty directory for each of the given *directories*.
|
||||
Create a new empty directory for each of the given _directories_.
|
||||
|
||||
## Options
|
||||
|
||||
* `-p`, `--parents`: Create parent directories if they don't exist
|
||||
* `-m`, `--mode`: Sets the permissions for the final directory (possibly altered by the process umask). The mode argument can be given in any of the formats
|
||||
accepted by the chmod(1) command. Addition and removal of permissions is relative to a default permission of 0777.
|
||||
* `-v`, `--verbose`: Print a message for each created directory
|
||||
- `-p`, `--parents`: Create parent directories if they don't exist
|
||||
- `-m`, `--mode`: Sets the permissions for the final directory (possibly altered by the process umask). The mode argument can be given in any of the formats
|
||||
accepted by the chmod(1) command. Addition and removal of permissions is relative to a default permission of 0777.
|
||||
- `-v`, `--verbose`: Print a message for each created directory
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -29,4 +29,4 @@ $ mkdir -m a=rx /tmp/foo/bar
|
|||
|
||||
## See also
|
||||
|
||||
* [`mkdir`(2)](help://man/2/mkdir)
|
||||
- [`mkdir`(2)](help://man/2/mkdir)
|
||||
|
|
|
|||
|
|
@ -17,10 +17,10 @@ as long as it contains at least 3 consecutive 'X's.
|
|||
|
||||
## Options
|
||||
|
||||
* `-d`, `--directory`: Create a temporary directory instead of a file
|
||||
* `-u`, `--dry-run`: Do not create anything, just print a unique name
|
||||
* `-q`, `--quiet`: Do not print diagnostics about file/directory creation failure
|
||||
* `-p`, `--tmpdir`: Create temporary files relative to this directory
|
||||
- `-d`, `--directory`: Create a temporary directory instead of a file
|
||||
- `-u`, `--dry-run`: Do not create anything, just print a unique name
|
||||
- `-q`, `--quiet`: Do not print diagnostics about file/directory creation failure
|
||||
- `-p`, `--tmpdir`: Create temporary files relative to this directory
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -34,5 +34,6 @@ $ mktemp -d serenity.XXXXX
|
|||
```
|
||||
|
||||
## See also
|
||||
* [`mkdir`(1)](help://man/1/mkdir) to create a regular directory
|
||||
* [`touch`(1)](help://man/1/touch) to create a regular file
|
||||
|
||||
- [`mkdir`(1)](help://man/1/mkdir) to create a regular directory
|
||||
- [`touch`(1)](help://man/1/touch) to create a regular file
|
||||
|
|
|
|||
|
|
@ -23,4 +23,4 @@ $ more
|
|||
|
||||
## See Also
|
||||
|
||||
* [`less`(1)](help://man/1/less) For the more advanced terminal pager that implements more.
|
||||
- [`less`(1)](help://man/1/less) For the more advanced terminal pager that implements more.
|
||||
|
|
|
|||
|
|
@ -15,9 +15,9 @@ $ mv [options...] <source...> <destination>
|
|||
|
||||
## Options
|
||||
|
||||
* `-f`, `--force`: Do not prompt before overwriting (not implemented for now)
|
||||
* `-n`, `--no-clobber`: Do not overwrite existing files
|
||||
* `-v`, `--verbose`: Display all moved files
|
||||
- `-f`, `--force`: Do not prompt before overwriting (not implemented for now)
|
||||
- `-n`, `--no-clobber`: Do not overwrite existing files
|
||||
- `-v`, `--verbose`: Display all moved files
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -28,4 +28,5 @@ $ mv old.txt new.txt
|
|||
```
|
||||
|
||||
## See also
|
||||
* [`cp`(1)](help://man/1/cp)
|
||||
|
||||
- [`cp`(1)](help://man/1/cp)
|
||||
|
|
|
|||
|
|
@ -14,18 +14,18 @@ Network cat: Connect to network sockets as if it were a file.
|
|||
|
||||
## Options
|
||||
|
||||
* `-I`, `--length`: Set maximum tcp receive buffer size
|
||||
* `-l`, `--listen`: Listen instead of connecting
|
||||
* `-N`: Close connection after reading stdin to the end
|
||||
* `-n`: Suppress name resolution
|
||||
* `-u`, `--udp`: UDP mode
|
||||
* `-p port`: Local port for remote connections
|
||||
* `-v`, `--verbose`: Log everything that's happening
|
||||
* `-z`, `--test-listening-service`: Test a TCP-listening service
|
||||
- `-I`, `--length`: Set maximum tcp receive buffer size
|
||||
- `-l`, `--listen`: Listen instead of connecting
|
||||
- `-N`: Close connection after reading stdin to the end
|
||||
- `-n`: Suppress name resolution
|
||||
- `-u`, `--udp`: UDP mode
|
||||
- `-p port`: Local port for remote connections
|
||||
- `-v`, `--verbose`: Log everything that's happening
|
||||
- `-z`, `--test-listening-service`: Test a TCP-listening service
|
||||
|
||||
## Arguments
|
||||
|
||||
* `target`: Address to listen on, or the address or hostname to connect to
|
||||
* `port`: Port to connect to or listen on
|
||||
- `target`: Address to listen on, or the address or hostname to connect to
|
||||
- `port`: Port to connect to or listen on
|
||||
|
||||
<!-- Auto-generated through ArgsParser -->
|
||||
|
|
|
|||
|
|
@ -14,14 +14,15 @@ Display network connections
|
|||
|
||||
## Options
|
||||
|
||||
* `-a`, `--all`: Display both listening and non-listening sockets
|
||||
* `-l`, `--list`: Display only listening sockets
|
||||
* `-t`, `--tcp`: Display only TCP network connections
|
||||
* `-u`, `--udp`: Display only UDP network connections
|
||||
* `-n`, `--numeric`: Display numerical addresses
|
||||
* `-p`, `--program`: Show the PID and name of the program to which each socket belongs
|
||||
* `-W`, `--wide`: Do not truncate IP addresses by printing out the whole symbolic host
|
||||
* `-e`, `--extend`: Display more information
|
||||
- `-a`, `--all`: Display both listening and non-listening sockets
|
||||
- `-l`, `--list`: Display only listening sockets
|
||||
- `-t`, `--tcp`: Display only TCP network connections
|
||||
- `-u`, `--udp`: Display only UDP network connections
|
||||
- `-n`, `--numeric`: Display numerical addresses
|
||||
- `-p`, `--program`: Show the PID and name of the program to which each socket belongs
|
||||
- `-W`, `--wide`: Do not truncate IP addresses by printing out the whole symbolic host
|
||||
- `-e`, `--extend`: Display more information
|
||||
|
||||
## See Also
|
||||
* [`ifconfig`(1)](help://man/1/ifconfig)
|
||||
|
||||
- [`ifconfig`(1)](help://man/1/ifconfig)
|
||||
|
|
|
|||
|
|
@ -10,14 +10,14 @@ $ nl [--body-numbering style] [--increment number] [--separator string] [--start
|
|||
|
||||
## Options
|
||||
|
||||
* `-b style`, `--body-numbering style`: Line numbering style: 't' for non-empty lines, 'a' for all lines, 'n' for no lines
|
||||
* `-i number`, `--increment number`: Line count increment
|
||||
* `-s string`, `--separator string`: Separator between line numbers and lines
|
||||
* `-v number`, `--startnum number`: Initial line number
|
||||
* `-w number`, `--width number`: Number width
|
||||
- `-b style`, `--body-numbering style`: Line numbering style: 't' for non-empty lines, 'a' for all lines, 'n' for no lines
|
||||
- `-i number`, `--increment number`: Line count increment
|
||||
- `-s string`, `--separator string`: Separator between line numbers and lines
|
||||
- `-v number`, `--startnum number`: Initial line number
|
||||
- `-w number`, `--width number`: Number width
|
||||
|
||||
## Arguments
|
||||
|
||||
* `file`: Files to process
|
||||
- `file`: Files to process
|
||||
|
||||
<!-- Auto-generated through ArgsParser -->
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@ $ nohup <utility> [args...]
|
|||
```
|
||||
|
||||
## Description
|
||||
|
||||
`nohup` will invoke `utility` given an optional list of `args`, where at the time of the invocation it will ignore the SIGHUP signal.
|
||||
|
||||
If the standard output is a tty, `utility` will append its standard output to the end of the file **nohup.out** in the current directory. If **nohup.out** fails to be created or opened for
|
||||
|
|
@ -16,15 +17,16 @@ appending, `utility`'s standard output will instead be appended to the end of th
|
|||
permission bits are set to S_IRUSR | S_IWUSR when it is created.
|
||||
|
||||
If standard error is a tty, one out of the following will occur:
|
||||
|
||||
1. If the standard output is open but not a tty, `utility` will redirect its standard error to its standard output.
|
||||
2. If the standard output is a tty or is closed, standard error shall be appended to the end of **nohup.out** as described above.
|
||||
|
||||
## Arguments
|
||||
|
||||
* `utility`: Utility to be invoked
|
||||
* `args`: Arguments to pass to `utility`
|
||||
- `utility`: Utility to be invoked
|
||||
- `args`: Arguments to pass to `utility`
|
||||
|
||||
## Exit Status
|
||||
|
||||
* 126 - `utility` was found but could not be invoked.
|
||||
* 127 - Either `utility` could not be found or an error occurred in `nohup`.
|
||||
- 126 - `utility` was found but could not be invoked.
|
||||
- 127 - Either `utility` could not be found or an error occurred in `nohup`.
|
||||
|
|
|
|||
|
|
@ -10,9 +10,9 @@ $ notify <title> <message> [icon-path]
|
|||
|
||||
## Arguments
|
||||
|
||||
* `title`: The title of notification
|
||||
* `message`: The message of notification
|
||||
* `icon-path`: Path to icon image file
|
||||
- `title`: The title of notification
|
||||
- `message`: The message of notification
|
||||
- `icon-path`: Path to icon image file
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -10,13 +10,14 @@ $ ntpquery [--adjust] [--set] [--verbose] [host]
|
|||
|
||||
## Options
|
||||
|
||||
* `-a`, `--adjust`: Gradually adjust system time (requires root)
|
||||
* `-s`, `--set`: Immediately set system time (requires root)
|
||||
* `-v`, `--verbose`: Verbose output
|
||||
- `-a`, `--adjust`: Gradually adjust system time (requires root)
|
||||
- `-s`, `--set`: Immediately set system time (requires root)
|
||||
- `-v`, `--verbose`: Verbose output
|
||||
|
||||
## Arguments
|
||||
|
||||
* `host`: NTP server
|
||||
- `host`: NTP server
|
||||
|
||||
## See Also
|
||||
* [`date`(1)](help://man/1/date)
|
||||
|
||||
- [`date`(1)](help://man/1/date)
|
||||
|
|
|
|||
|
|
@ -14,12 +14,12 @@ Modify an account password.
|
|||
|
||||
## Options
|
||||
|
||||
* `-d`, `--delete`: Delete password
|
||||
* `-l`, `--lock`: Lock password
|
||||
* `-u`, `--unlock`: Unlock password
|
||||
- `-d`, `--delete`: Delete password
|
||||
- `-l`, `--lock`: Lock password
|
||||
- `-u`, `--unlock`: Unlock password
|
||||
|
||||
## Arguments
|
||||
|
||||
* `username`: Username
|
||||
- `username`: Username
|
||||
|
||||
<!-- Auto-generated through ArgsParser -->
|
||||
|
|
|
|||
|
|
@ -10,21 +10,22 @@ $ pgrep [--count] [-d delimiter] [--ignore-case] [--list-name] [--newest] [--old
|
|||
|
||||
## Options
|
||||
|
||||
* `-c`, `--count`: Suppress normal output and print the number of matching processes
|
||||
* `-d`, `--delimiter`: Set the string used to delimit multiple pids
|
||||
* `-i`, `--ignore-case`: Make matches case-insensitive
|
||||
* `-l`, `--list-name`: List the process name in addition to its pid
|
||||
* `-n`, `--newest`: Select the most recently created process only
|
||||
* `-o`, `--oldest`: Select the least recently created process only
|
||||
* `-O`, `--older`: Select only processes older than the specified number of seconds
|
||||
* `-U uid-list`, `--uid uid-list`: Select only processes whose UID is in the given comma-separated list. Login name or numerical user ID may be used
|
||||
* `-x`, `--exact`: Select only processes whose names match the given pattern exactly
|
||||
* `-v`, `--invert-match`: Select non-matching lines
|
||||
- `-c`, `--count`: Suppress normal output and print the number of matching processes
|
||||
- `-d`, `--delimiter`: Set the string used to delimit multiple pids
|
||||
- `-i`, `--ignore-case`: Make matches case-insensitive
|
||||
- `-l`, `--list-name`: List the process name in addition to its pid
|
||||
- `-n`, `--newest`: Select the most recently created process only
|
||||
- `-o`, `--oldest`: Select the least recently created process only
|
||||
- `-O`, `--older`: Select only processes older than the specified number of seconds
|
||||
- `-U uid-list`, `--uid uid-list`: Select only processes whose UID is in the given comma-separated list. Login name or numerical user ID may be used
|
||||
- `-x`, `--exact`: Select only processes whose names match the given pattern exactly
|
||||
- `-v`, `--invert-match`: Select non-matching lines
|
||||
|
||||
## Arguments
|
||||
|
||||
* `process-name`: Process name to search for
|
||||
- `process-name`: Process name to search for
|
||||
|
||||
## See also
|
||||
* [`pidof`(1)](help://man/1/pidof)
|
||||
* [`ps`(1)](help://man/1/ps)
|
||||
|
||||
- [`pidof`(1)](help://man/1/pidof)
|
||||
- [`ps`(1)](help://man/1/ps)
|
||||
|
|
|
|||
|
|
@ -10,14 +10,15 @@ $ pidof [-s] [-o pid] [-S separator] <process-name>
|
|||
|
||||
## Options
|
||||
|
||||
* `-o pid`: Omit the given pid, or the parent process if the special value %PPID is passed
|
||||
* `-s`: Only return one pid
|
||||
* `-S separator`: Use `separator` to separate multiple pids
|
||||
- `-o pid`: Omit the given pid, or the parent process if the special value %PPID is passed
|
||||
- `-s`: Only return one pid
|
||||
- `-S separator`: Use `separator` to separate multiple pids
|
||||
|
||||
## Arguments
|
||||
|
||||
* `process-name`: Process name to search for
|
||||
- `process-name`: Process name to search for
|
||||
|
||||
## See also
|
||||
* [`pgrep`(1)](help://man/1/pgrep)
|
||||
* [`ps`(1)](help://man/1/ps)
|
||||
|
||||
- [`pgrep`(1)](help://man/1/pgrep)
|
||||
- [`ps`(1)](help://man/1/ps)
|
||||
|
|
|
|||
|
|
@ -16,14 +16,14 @@ It does not currently support installing and uninstalling packages. To install t
|
|||
|
||||
## Options
|
||||
|
||||
* `-l`, `--list-manual-ports`: Show all manually-installed ports
|
||||
* `-u`, `--update-ports-database`: Sync/Update ports database
|
||||
* `-v`, `--verbose`: Verbose output
|
||||
* `-q`, `--query-package`: Query the ports database for package name
|
||||
- `-l`, `--list-manual-ports`: Show all manually-installed ports
|
||||
- `-u`, `--update-ports-database`: Sync/Update ports database
|
||||
- `-v`, `--verbose`: Verbose output
|
||||
- `-q`, `--query-package`: Query the ports database for package name
|
||||
|
||||
## Arguments
|
||||
|
||||
* `package`: The name of the package you want to query
|
||||
- `package`: The name of the package you want to query
|
||||
|
||||
## Example
|
||||
|
||||
|
|
|
|||
|
|
@ -10,19 +10,20 @@ $ pkill [--count] [--ignore-case] [--echo] [--newest] [--oldest] [--older second
|
|||
|
||||
## Options
|
||||
|
||||
* `-c`, `--count`: Display the number of matching processes
|
||||
* `-i`, `--ignore-case`: Make matches case-insensitive
|
||||
* `-e`, `--echo`: Display what is killed
|
||||
* `-n`, `--newest`: Kill the most recently created process only
|
||||
* `-o`, `--oldest`: Select the least recently created process only
|
||||
* `-O`, `--older`: Select only processes older than the specified number of seconds
|
||||
* `-s signame`, `--signal signame`: Signal to send. The signal name or number may be used
|
||||
* `-U uid-list`, `--uid uid-list`: Select only processes whose UID is in the given comma-separated list. Login name or numerical user ID may be used
|
||||
* `-x`, `--exact`: Select only processes whose names match the given pattern exactly
|
||||
- `-c`, `--count`: Display the number of matching processes
|
||||
- `-i`, `--ignore-case`: Make matches case-insensitive
|
||||
- `-e`, `--echo`: Display what is killed
|
||||
- `-n`, `--newest`: Kill the most recently created process only
|
||||
- `-o`, `--oldest`: Select the least recently created process only
|
||||
- `-O`, `--older`: Select only processes older than the specified number of seconds
|
||||
- `-s signame`, `--signal signame`: Signal to send. The signal name or number may be used
|
||||
- `-U uid-list`, `--uid uid-list`: Select only processes whose UID is in the given comma-separated list. Login name or numerical user ID may be used
|
||||
- `-x`, `--exact`: Select only processes whose names match the given pattern exactly
|
||||
|
||||
## Arguments
|
||||
|
||||
* `process-name`: Process name to search for
|
||||
- `process-name`: Process name to search for
|
||||
|
||||
## See Also
|
||||
* [`ps`(1)](help://man/1/ps)
|
||||
|
||||
- [`ps`(1)](help://man/1/ps)
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ Print the memory map of a specified process.
|
|||
|
||||
## Options
|
||||
|
||||
* `-x`: Extended output
|
||||
- `-x`: Extended output
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -23,5 +23,6 @@ $ pmap $$
|
|||
```
|
||||
|
||||
## See also
|
||||
* [`lsof`(1)](help://man/1/lsof)
|
||||
* [`ps`(1)](help://man/1/ps)
|
||||
|
||||
- [`lsof`(1)](help://man/1/lsof)
|
||||
- [`ps`(1)](help://man/1/ps)
|
||||
|
|
|
|||
|
|
@ -12,10 +12,9 @@ $ pmemdump [-r] <offset> <length>
|
|||
|
||||
Dump a portion of the physical memory space.
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
* `-r`: Dump from /dev/mem with `read(2)` instead of doing `mmap(2)` on it.
|
||||
- `-r`: Dump from /dev/mem with `read(2)` instead of doing `mmap(2)` on it.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -35,4 +34,4 @@ offset fails.
|
|||
|
||||
## See also
|
||||
|
||||
* [`mem`(4)](help://man/4/mem)
|
||||
- [`mem`(4)](help://man/4/mem)
|
||||
|
|
|
|||
|
|
@ -13,25 +13,25 @@ $ printf <format> [arguments...]
|
|||
`printf` formats _argument_(s) according to _format_ and prints the result to standard output.
|
||||
|
||||
_format_ is similar to the C printf format string, with the following differences:
|
||||
- The format specifier `b` (`%b`) is not supported.
|
||||
- The format specifiers that require a writable pointer (e.g. `n`) are not supported.
|
||||
- The format specifier `q` (`%q`) has a different behavior, where it shall print a given string as a quoted string, which is safe to use in shell inputs.
|
||||
- Common escape sequences are interpreted, namely the following:
|
||||
|
||||
| escape | description |
|
||||
| :-: | :--- |
|
||||
| `\\\\`| literal backslash |
|
||||
| `\\"` | literal double quote |
|
||||
| `\\a` | alert (BEL) |
|
||||
| `\\b` | backspace |
|
||||
| `\\c` | Ends the format string |
|
||||
| `\\e` | escape (`\\x1b`) |
|
||||
| `\\f` | form feed |
|
||||
| `\\n` | newline |
|
||||
| `\\r` | carriage return |
|
||||
| `\\t` | tab |
|
||||
| `\\v` | vertical tab |
|
||||
- The format specifier `b` (`%b`) is not supported.
|
||||
- The format specifiers that require a writable pointer (e.g. `n`) are not supported.
|
||||
- The format specifier `q` (`%q`) has a different behavior, where it shall print a given string as a quoted string, which is safe to use in shell inputs.
|
||||
- Common escape sequences are interpreted, namely the following:
|
||||
|
||||
| escape | description |
|
||||
| :----: | :--------------------- |
|
||||
| `\\\\` | literal backslash |
|
||||
| `\\"` | literal double quote |
|
||||
| `\\a` | alert (BEL) |
|
||||
| `\\b` | backspace |
|
||||
| `\\c` | Ends the format string |
|
||||
| `\\e` | escape (`\\x1b`) |
|
||||
| `\\f` | form feed |
|
||||
| `\\n` | newline |
|
||||
| `\\r` | carriage return |
|
||||
| `\\t` | tab |
|
||||
| `\\v` | vertical tab |
|
||||
|
||||
The _format_ string is reapplied until all arguments are consumed, and a missing argument is treated as zero for numeric format specifiers, and an empty string for string format specifiers.
|
||||
|
||||
|
|
@ -50,4 +50,4 @@ $ printf '%d%d%d' 1 2 3 4 x
|
|||
|
||||
## See also
|
||||
|
||||
* [`echo`(1)](help://man/1/echo)
|
||||
- [`echo`(1)](help://man/1/echo)
|
||||
|
|
|
|||
|
|
@ -14,13 +14,13 @@ $ profile [-p PID] [-a] [-e] [-d] [-f] [-w] [-t event_type] [COMMAND_TO_PROFILE]
|
|||
|
||||
## Options
|
||||
|
||||
* `-p PID`: Target PID
|
||||
* `-a`: Profile all processes (super-user only), result at /sys/kernel/profile
|
||||
* `-e`: Enable
|
||||
* `-d`: Disable
|
||||
* `-f`: Free the profiling buffer for the associated process(es).
|
||||
* `-w`: Enable profiling and wait for user input to disable.
|
||||
* `-t event_type`: Enable tracking specific event type
|
||||
- `-p PID`: Target PID
|
||||
- `-a`: Profile all processes (super-user only), result at /sys/kernel/profile
|
||||
- `-e`: Enable
|
||||
- `-d`: Disable
|
||||
- `-f`: Free the profiling buffer for the associated process(es).
|
||||
- `-w`: Enable profiling and wait for user input to disable.
|
||||
- `-t event_type`: Enable tracking specific event type
|
||||
|
||||
Event type can be one of: sample, context_switch, page_fault, syscall, read, kmalloc and kfree.
|
||||
|
||||
|
|
@ -41,5 +41,5 @@ $ profile -t syscall -- echo "Hello friends!"
|
|||
|
||||
## See also
|
||||
|
||||
* [`Profiler`(1)](help://man/1/Applications/Profiler) GUI for viewing profiling data produced by `profile`.
|
||||
* [`strace`(1)](help://man/1/strace)
|
||||
- [`Profiler`(1)](help://man/1/Applications/Profiler) GUI for viewing profiling data produced by `profile`.
|
||||
- [`strace`(1)](help://man/1/strace)
|
||||
|
|
|
|||
|
|
@ -15,10 +15,10 @@ For each process, print its PID (process ID), to which TTY it belongs, and invok
|
|||
|
||||
## Options
|
||||
|
||||
* `-a`: Consider all processes that are associated with a TTY.
|
||||
* `-A` or `-e`: Consider all processes, not just those in the current TTY.
|
||||
* `-f`: Also print for each process: UID (as resolved username), PPID (parent PID), and STATE (Runnable, Sleeping, Selecting, Reading, etc.)
|
||||
* `-o column-format`: Specify a user-defined format, as a list of column format specifiers separated by commas or spaces.
|
||||
- `-a`: Consider all processes that are associated with a TTY.
|
||||
- `-A` or `-e`: Consider all processes, not just those in the current TTY.
|
||||
- `-f`: Also print for each process: UID (as resolved username), PPID (parent PID), and STATE (Runnable, Sleeping, Selecting, Reading, etc.)
|
||||
- `-o column-format`: Specify a user-defined format, as a list of column format specifiers separated by commas or spaces.
|
||||
|
||||
A column format specifier is of the form: `COLUMN_NAME[=COLUMN_TITLE]`.
|
||||
Where `COLUMN_NAME` is any of the following: `uid`, `pid`, `ppid`, `pgid`, `sid`, `state`, `tty`, or `cmd`.
|
||||
|
|
@ -26,11 +26,11 @@ For each process, print its PID (process ID), to which TTY it belongs, and invok
|
|||
Specifying a `COLUMN_TITLE` will change the name shown in the column header. `COLUMN_TITLE` may be blank.
|
||||
If all given column titles are blank, the column header is omitted.
|
||||
|
||||
* `-p pid-list`: Select processes matching any of the given PIDs. `pid-list` is a list of PIDs, separated by commas or spaces.
|
||||
* `--ppid pid-list`: Select processes whose PPID matches any of the given PIDs. `pid-list` is a list of PIDs, separated by commas or spaces.
|
||||
* `-q pid-list`: Only consider the given PIDs, if they exist. Output the processes in the order provided by `pid-list`. `pid-list` is a list of PIDs, separated by commas or spaces.
|
||||
* `-t tty-list`: Select processes associated with any of the given terminals. `tty-list` is a list of short TTY names (e.g: `pts:0`) or the full TTY device paths, separated by commas or spaces.
|
||||
* `-u user-list`: Select processes matching any of the given UIDs. `user-list` is a list of UIDs or login names, separated by commas or spaces.
|
||||
- `-p pid-list`: Select processes matching any of the given PIDs. `pid-list` is a list of PIDs, separated by commas or spaces.
|
||||
- `--ppid pid-list`: Select processes whose PPID matches any of the given PIDs. `pid-list` is a list of PIDs, separated by commas or spaces.
|
||||
- `-q pid-list`: Only consider the given PIDs, if they exist. Output the processes in the order provided by `pid-list`. `pid-list` is a list of PIDs, separated by commas or spaces.
|
||||
- `-t tty-list`: Select processes associated with any of the given terminals. `tty-list` is a list of short TTY names (e.g: `pts:0`) or the full TTY device paths, separated by commas or spaces.
|
||||
- `-u user-list`: Select processes matching any of the given UIDs. `user-list` is a list of UIDs or login names, separated by commas or spaces.
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -59,5 +59,6 @@ $ ps -q 42 -o cmd=
|
|||
```
|
||||
|
||||
## See Also
|
||||
* [`pmap`(1)](help://man/1/pmap)
|
||||
* [`lsof`(1)](help://man/1/lsof)
|
||||
|
||||
- [`pmap`(1)](help://man/1/pmap)
|
||||
- [`lsof`(1)](help://man/1/lsof)
|
||||
|
|
|
|||
|
|
@ -10,22 +10,22 @@ $ readelf [--all] [--file-header] [--program-headers] [--section-headers] [--hea
|
|||
|
||||
## Options
|
||||
|
||||
* `-a`, `--all`: Display all
|
||||
* `-h`, `--file-header`: Display ELF header
|
||||
* `-l`, `--program-headers`: Display program headers
|
||||
* `-S`, `--section-headers`: Display section headers
|
||||
* `-e`, `--headers`: Equivalent to: -h -l -S -s -r -d -n -u -c
|
||||
* `-s`, `--syms`: Display the symbol table
|
||||
* `--dyn-syms`: Display the dynamic symbol table
|
||||
* `-d`, `--dynamic`: Display the dynamic section
|
||||
* `-n`, `--notes`: Display core notes
|
||||
* `-r`, `--relocs`: Display relocations
|
||||
* `-u`, `--unwind`: Display unwind info
|
||||
* `-c`, `--checksec`: Display security hardening info
|
||||
* `-p section-name`, `--string-dump section-name`: Display the contents of a section as strings
|
||||
- `-a`, `--all`: Display all
|
||||
- `-h`, `--file-header`: Display ELF header
|
||||
- `-l`, `--program-headers`: Display program headers
|
||||
- `-S`, `--section-headers`: Display section headers
|
||||
- `-e`, `--headers`: Equivalent to: -h -l -S -s -r -d -n -u -c
|
||||
- `-s`, `--syms`: Display the symbol table
|
||||
- `--dyn-syms`: Display the dynamic symbol table
|
||||
- `-d`, `--dynamic`: Display the dynamic section
|
||||
- `-n`, `--notes`: Display core notes
|
||||
- `-r`, `--relocs`: Display relocations
|
||||
- `-u`, `--unwind`: Display unwind info
|
||||
- `-c`, `--checksec`: Display security hardening info
|
||||
- `-p section-name`, `--string-dump section-name`: Display the contents of a section as strings
|
||||
|
||||
## Arguments
|
||||
|
||||
* `path`: ELF path
|
||||
- `path`: ELF path
|
||||
|
||||
<!-- Auto-generated through ArgsParser -->
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue