mirror of
https://github.com/RGBCube/serenity
synced 2025-07-27 06:57:45 +00:00
Base: man pages: document arguments, fix typos, use American English
This commit is contained in:
parent
5bd8a416ea
commit
5331ae0e93
8 changed files with 23 additions and 11 deletions
|
@ -8,6 +8,10 @@ Inspector - Serenity process inspector
|
|||
$ Inspector [pid]
|
||||
```
|
||||
|
||||
## Arguments
|
||||
|
||||
* pid: Process ID to inspect
|
||||
|
||||
## Description
|
||||
|
||||
Inspector facilitates process inspection via RPC.
|
||||
|
|
|
@ -8,6 +8,10 @@ Playground - GUI Markup Language (GML) editor
|
|||
$ Playground [file]
|
||||
```
|
||||
|
||||
## Arguments
|
||||
|
||||
* file: Path of GML file to load
|
||||
|
||||
## Description
|
||||
|
||||
Playground facilitates development of graphical user interfaces (GUI)
|
||||
|
|
|
@ -5,7 +5,7 @@ Profiler - Serenity process profiler
|
|||
## Synopsis
|
||||
|
||||
```**sh
|
||||
$ Profiler [--pid PID] [perfcore file]
|
||||
$ Profiler [--pid PID] [perfcore-file]
|
||||
```
|
||||
|
||||
## Description
|
||||
|
@ -27,6 +27,10 @@ Profiler can also load performance information from previously created
|
|||
|
||||
* `-p PID`, `--pid PID`: PID to profile
|
||||
|
||||
## Arguments
|
||||
|
||||
* perfcore-file: Path of perfcore file to load
|
||||
|
||||
## Examples
|
||||
|
||||
Profile running Shell process:
|
||||
|
|
|
@ -25,7 +25,7 @@ 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 initialisation 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
|
||||
* `-f`, `--live-formatting`: Enable live formatting of the line editor buffer (in REPL mode)
|
||||
|
||||
|
|
|
@ -15,7 +15,7 @@ $ printf <format> [arguments...]
|
|||
_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 behaviour, where it shall print a given string as a quoted string, which is safe to use in shell inputs.
|
||||
- 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 |
|
||||
|
|
|
@ -33,7 +33,7 @@ The standard input is left as-is if data is read from a file.
|
|||
* `-0`, `--null`: Split the items by zero bytes (null characters) instead of `delimiter`
|
||||
* `-d`, `--delimiter`: Set the `delimiter`, which is a newline (`\n`) by default
|
||||
* `-v`, `--verbose`: Display each expanded command on standard error before executing it
|
||||
* `-a`, `--arg-file`: Read the items from the speified file, `-` refers to standard input and is the default
|
||||
* `-a`, `--arg-file`: Read the items from the specified file, `-` refers to standard input and is the default
|
||||
* `-L`, `--line-limit`: Set `max-lines`, `0` means unlimited (which is the default)
|
||||
* `-s`, `--char-limit`: Set `max-chars`, which is `ARG_MAX` (the maximum command size supported by the system) by default
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue