1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 04:17:34 +00:00

Base: Update man pages for utilities

Man pages for utilities now more closely resemble ArgsParser output
This commit is contained in:
Tim Ledbetter 2023-03-30 22:57:12 +01:00 committed by Sam Atkins
parent 37bbd20cee
commit 8f253a745e
28 changed files with 89 additions and 15 deletions

View file

@ -28,6 +28,8 @@ The `Shell` utility does not promise POSIX `sh` interoperability.
* `--skip-shellrc`: Skips running the initialization file (at `~/.shellrc`) * `--skip-shellrc`: Skips running the initialization file (at `~/.shellrc`)
* `--format`: Format shell code from the given file and print the result to standard output * `--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) * `-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 ## Examples

View file

@ -1,6 +1,6 @@
## Name ## Name
arp - display ARP cache arp - Display or modify the system ARP cache
## Synopsis ## Synopsis
@ -14,6 +14,17 @@ This program run as root displays IP and MAC addresses of devices in local netwo
ARP stands for Address Resolution Protocol, which is used to find devices in local network. ARP stands for Address Resolution Protocol, which is used to find devices in local network.
## Options
* `-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
## Examples ## Examples
```sh ```sh

View file

@ -5,7 +5,7 @@ basename - strip directory names from path
## Synopsis ## Synopsis
```**sh ```**sh
$ basename <path> $ basename <path> [suffix]
``` ```
## Description ## Description
@ -15,6 +15,7 @@ $ basename <path>
## Arguments ## Arguments
* `path`: The path which we want to get basename of * `path`: The path which we want to get basename of
* `suffix`: Suffix to strip from name
## Examples ## Examples

View file

@ -14,7 +14,7 @@ beep allows the user to beep the PC speaker.
## Options ## Options
* `-f|--beep-tone`: Beep tone (frequency in Hz) * `-f frequency`, `--beep-tone frequency`: Beep tone (frequency in Hz)
## Notes ## Notes

View file

@ -13,6 +13,10 @@ $ chgrp <name> <path>
`chgrp` called as root or as file owner changes owning group of specified `path` to `gid` or `name`. `chgrp` called as root or as file owner changes owning group of specified `path` to `gid` or `name`.
## Options
* `-h`, `--no-dereference`: Don't follow symlinks
## Examples ## Examples
```sh ```sh

View file

@ -23,6 +23,10 @@ The letters `[rwx]` controls which permission will be changes: `r` is read, `w`
A numeric mode is combination of 1 to 4 numbers. Omitted digits are assumed to be leading zeros. The first digit select the set user ID (4), set group ID (2) and restricted deletion / sticky (1) attributes. The second, third and fourth digit controls permissions of each user group: owner, owning group and others (not owner or owning group), respectively: read (4), write (2) and execute (1). A numeric mode is combination of 1 to 4 numbers. Omitted digits are assumed to be leading zeros. The first digit select the set user ID (4), set group ID (2) and restricted deletion / sticky (1) attributes. The second, third and fourth digit controls permissions of each user group: owner, owning group and others (not owner or owning group), respectively: read (4), write (2) and execute (1).
## Options
* `-R`, `--recursive`: Change file modes recursively
## Examples ## Examples
```sh ```sh

View file

@ -5,7 +5,7 @@ chown - change file owner / group
## Synopsis ## Synopsis
```**sh ```**sh
$ chown [user][:group] files... $ chown <user[:group]> <path...>
``` ```
## Description ## Description
@ -15,6 +15,12 @@ $ chown [user][:group] files...
**NOTE**: The caller must be a superuser to change user ownership. Other users can use `chown` to change the group to one of their other **NOTE**: The caller must be a superuser to change user ownership. Other users can use `chown` to change the group to one of their other
group. group.
## Options
* `-h`, `--no-dereference`: Don't follow symlinks
* `-R`, `--recursive`: Change file ownership recursively
* `-L`: Follow symlinks while recursing into directories
## Examples ## Examples
```sh ```sh

View file

@ -12,6 +12,10 @@ $ chres <width> <height> [scale factor]
`chres` changes the display resolution to <width>x<height>@<scale factor>x. `chres` changes the display resolution to <width>x<height>@<scale factor>x.
## Options
* `-s`, `--screen`: Screen
## Examples ## Examples
```sh ```sh

View file

@ -29,12 +29,13 @@ of crashes.
* `-T`: Make a syscall while using an invalid stack pointer. * `-T`: Make a syscall while using an invalid stack pointer.
* `-t`: Trigger a page fault while using an invalid stack pointer. * `-t`: Trigger a page fault while using an invalid stack pointer.
* `-S`: Make a syscall from writeable memory. * `-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). * `-X`: Attempt to execute non-executable memory (Not mapped with PROT\_EXEC).
* `-U`: Attempt to trigger an x86 User Mode Instruction Prevention fault. * `-U`: Attempt to trigger an x86 User Mode Instruction Prevention fault.
* `-I`: Use an x86 I/O instruction in userspace. * `-I`: Use an x86 I/O instruction in userspace.
* `-c`: Read the x86 TSC (Time Stamp Counter) directly.
* `-p`: Violate `pledge()`'d promises. * `-p`: Violate `pledge()`'d promises.
* `-n`: Perform a failing assertion. * `-n`: Perform a failing assertion.
* `-R`: Dereference a null RefPtr.
## Examples ## Examples

View file

@ -24,7 +24,6 @@ With no FILE, or when FILE is -, read standard input.
* `-f` `--fields=list`: select only these fields; also print any line that contains no delimiter character * `-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 * `-d` `--delimiter=delim`: use `delim` instead of `tab` for field delimiter
## Examples ## Examples
```sh ```sh

View file

@ -18,10 +18,16 @@ $ dd if=[input_file] of=[output_file] [args...]
## Arguments ## Arguments
* `if`: input file (or device) to read from * `if`: input file (or device) to read from (default: stdin)
* `of`: output file (or device) to write to * `of`: output file (or device) to write to (default: stdout)
* `bs`: block size (of bytes) to use * `bs`: block size (of bytes) to use (default: 512)
* `count`: number of blocks to write * `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 ## Examples

View file

@ -16,6 +16,8 @@ $ du [files...]
* `-a`, `--all`: Write counts for all files, not just directories * `-a`, `--all`: Write counts for all files, not just directories
* `--apparent-size`: Print apparent sizes, rather than disk usage * `--apparent-size`: Print apparent sizes, rather than disk usage
* `-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 * `-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 * `-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 * `-t size`, `--threshold size`: Exclude entries smaller than size if positive, or entries greater than size if negative

View file

@ -15,6 +15,7 @@ specified jail index.
## Options ## Options
* `-E`, `--preserve-env`: Preserve user environment when running command
* `-i`, `--jail-index`: Use an already existing jail with its index * `-i`, `--jail-index`: Use an already existing jail with its index
* `-n`, `--jail-name`: Create a new jail with a provided name * `-n`, `--jail-name`: Create a new jail with a provided name

View file

@ -14,6 +14,11 @@ The `keymap` utility can be used to configure the list of selected keyboard layo
Layouts loaded from `/res/keymaps/*.json`. 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
## Examples ## Examples
Get name of the currently set keymap: Get name of the currently set keymap:

View file

@ -30,6 +30,7 @@ If no *path* argument is provided the current working directory is used.
* `-n`, `--numeric-uid-gid`: In long format, display numeric UID/GID * `-n`, `--numeric-uid-gid`: In long format, display numeric UID/GID
* `-o`, In long format, do not show group information * `-o`, In long format, do not show group information
* `-h`, `--human-readable`: Print human-readable sizes * `-h`, `--human-readable`: Print human-readable sizes
* `--si`: Print human-readable sizes in SI units
* `-K`, `--no-hyperlinks`: Disable hyperlinks * `-K`, `--no-hyperlinks`: Disable hyperlinks
* `-R`, `--recursive`: List subdirectories recursively * `-R`, `--recursive`: List subdirectories recursively
* `-1`: List one file per line * `-1`: List one file per line

View file

@ -15,6 +15,10 @@ $ man section page
or man pages for short, from the SerenityOS manual. You're reading or man pages for short, from the SerenityOS manual. You're reading
the manual page for `man` program itself right now. the manual page for `man` program itself right now.
## Options
* `-P pager`, `--pager pager`: Pager to pipe the man page to
## Examples ## Examples
To open documentation for the `echo` command: To open documentation for the `echo` command:

View file

@ -17,7 +17,7 @@ standard input.
## Options ## Options
* `--html`: Render the document into HTML. * `-H`, `--html`: Render the document into HTML.
## Examples ## Examples

View file

@ -16,6 +16,7 @@ $ mv [options...] <source...> <destination>
## Options ## Options
* `-f`, `--force`: Do not prompt before overwriting (not implemented for now) * `-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 * `-v`, `--verbose`: Display all moved files
## Examples ## Examples

View file

@ -19,6 +19,7 @@ If a directory is specified in `path`, the `-r` (recursive) flag is required. Ot
* `-r`, `--recursive`: Remove files and directories recursively * `-r`, `--recursive`: Remove files and directories recursively
* `-f`, `--force`: Do not prompt before removing * `-f`, `--force`: Do not prompt before removing
* `-v`, `--verbose`: Display what files are removed * `-v`, `--verbose`: Display what files are removed
* `--no-preserve-root`: Do not treat '/' specially
## Examples ## Examples

View file

@ -18,7 +18,6 @@ When called with no user-specified, `su` defaults to switch to the *root* user.
## Options: ## Options:
* `-`, `-l`, `--login`: Start the shell as it was a real login * `-`, `-l`, `--login`: Start the shell as it was a real login
* `-c`, `--command`: Execute a command using `/bin/sh` instead of starting an interactive shell * `-c`, `--command`: Execute a command using `/bin/sh` instead of starting an interactive shell
## Arguments ## Arguments

View file

@ -22,6 +22,8 @@ Files may also be compressed and decompressed using GNU Zip (GZIP) compression.
* `-t`, `--list`: List contents * `-t`, `--list`: List contents
* `-v`, `--verbose`: Print paths * `-v`, `--verbose`: Print paths
* `-z`, `--gzip`: Compress or decompress file using gzip * `-z`, `--gzip`: Compress or decompress file using gzip
* `--lzma`: Compress or decompress file using lzma
* `-J`, `--xz`: Compress or decompress file using xz
* `--no-auto-compress`: Do not use the archive suffix to select the compression algorithm * `--no-auto-compress`: Do not use the archive suffix to select the compression algorithm
* `-C DIRECTORY`, `--directory DIRECTORY`: Directory to extract to/create from * `-C DIRECTORY`, `--directory DIRECTORY`: Directory to extract to/create from
* `-f FILE`, `--file FILE`: Archive file * `-f FILE`, `--file FILE`: Archive file

View file

@ -24,7 +24,13 @@ You can disable output from `dbgln()` calls by setting the `DISABLE_DBG_OUTPUT`
## Options ## Options
* `-t`, `--show-time`: Show duration of each test * `-t`, `--show-time`: Show duration of each test
* `-p`, `--show-progress`: Show progress with OSC 9 (true, false)
* `-j`, `--json`: Show results as JSON
* `--per-file`: Show detailed per-file results as JSON (implies -j)
* `-g`, `--collect-often`: Collect garbage after every allocation * `-g`, `--collect-often`: Collect garbage after every allocation
* `-b`, `--run-bytecode`: Use the bytecode interpreter
* `-d`, `--dump-bytecode`: Dump the bytecode
* `-f glob`, `--filter glob`: Only run tests matching the given glob
* `--test262-parser-tests`: Run test262 parser tests * `--test262-parser-tests`: Run test262 parser tests
## Examples ## Examples

View file

@ -18,6 +18,7 @@ system call.
* `-s`: Print the system name * `-s`: Print the system name
* `-n`: Print the node name (hostname) * `-n`: Print the node name (hostname)
* `-r`: Print the system release version * `-r`: Print the system release version
* `-v`: Print the version of the release
* `-m`: Print the machine type * `-m`: Print the machine type
* `-a`: Print all of the above * `-a`: Print all of the above

View file

@ -17,8 +17,9 @@ Filter out repeated adjacent lines from INPUT (or standard input) and write to O
* `-c`, `--count`: Precede each line with its number of occurrences. * `-c`, `--count`: Precede each line with its number of occurrences.
* `-d`, `--repeated`: Only print repeated lines. * `-d`, `--repeated`: Only print repeated lines.
* `-u`, `--unique`: Only print unique lines (default). * `-u`, `--unique`: Only print unique lines (default).
* `-i`, `--ignore-case`: Ignore case when comparing lines.
* `-f N`, `--skip-fields N`: Skip first N fields of each line before comparing. * `-f N`, `--skip-fields N`: Skip first N fields of each line before comparing.
* `-c N`, `--skip-chars N`: Skip first N chars of each line before comparing. * `-s N`, `--skip-chars N`: Skip first N chars of each line before comparing.
* `--help`: Display help message and exit. * `--help`: Display help message and exit.
* `--version`: Print version. * `--version`: Print version.

View file

@ -16,6 +16,11 @@ The program is compatible with the PKZIP file format specification.
The optional [files] argument can be used to only extract specific files within the archive (using wildcards) during the unzip process. A `_` can be used as a single-character wildcard, and `*` can be used as a variable-length wildcard. The optional [files] argument can be used to only extract specific files within the archive (using wildcards) during the unzip process. A `_` can be used as a single-character wildcard, and `*` can be used as a variable-length wildcard.
## Options
* `-d path`, `--output-directory path`: Directory to receive the archive output
* `-q`, `--quiet`: Be less verbose
## Examples ## Examples
```sh ```sh

View file

@ -17,6 +17,7 @@ list available wallpapers in the `/res/wallpapers/` directory.
* `-a`, `--show-all`: Show all wallpapers * `-a`, `--show-all`: Show all wallpapers
* `-c`, `--show-current`: Show current wallpaper * `-c`, `--show-current`: Show current wallpaper
* `-r`, `--set-random`: Set random wallpaper
## Examples ## Examples

View file

@ -15,9 +15,10 @@ aggregated error code.
## Options ## Options
* '-n': Interval between executions, in seconds. By default, the program is run every 2 seconds. * `-n seconds`: Interval between executions, in seconds. By default, the program is run every 2 seconds.
* '-t': Don't print the title bar. * `-t`, `--no-title`: Don't print the title bar.
* '-b': Beep each time the command exits with a non-zero status * `-b`, `--beep`: Beep each time the command exits with a non-zero status.
* `-f file`, `--file file`: Run command whenever this file changes. Can be used multiple times.
## Exit Values ## Exit Values

View file

@ -14,6 +14,11 @@ zip will pack the specified files into a zip archive, compressing them when poss
The program is compatible with the PKZIP file format specification. The program is compatible with the PKZIP file format specification.
## Options
* `-r`, `--recurse-paths`: Travel the directory structure recursively
* `-f`, `--force`: Overwrite existing zip file
## Examples ## Examples
```sh ```sh