diff options
author | Brendan Coles <bcoles@gmail.com> | 2021-03-27 03:05:18 +0000 |
---|---|---|
committer | Andreas Kling <kling@serenityos.org> | 2021-03-27 19:23:49 +0100 |
commit | 5331ae0e934645f09138ab4d0b9da5a93b847f3e (patch) | |
tree | 741fb1effcc2189917cab1ff7d993d83aff39c88 /Base | |
parent | 5bd8a416eae7998bf9bbc1bf499edfccb636848b (diff) | |
download | serenity-5331ae0e934645f09138ab4d0b9da5a93b847f3e.zip |
Base: man pages: document arguments, fix typos, use American English
Diffstat (limited to 'Base')
-rw-r--r-- | Base/usr/share/man/man1/Inspector.md | 4 | ||||
-rw-r--r-- | Base/usr/share/man/man1/Playground.md | 4 | ||||
-rw-r--r-- | Base/usr/share/man/man1/Profiler.md | 6 | ||||
-rw-r--r-- | Base/usr/share/man/man1/Shell.md | 2 | ||||
-rw-r--r-- | Base/usr/share/man/man1/printf.md | 2 | ||||
-rw-r--r-- | Base/usr/share/man/man1/xargs.md | 2 | ||||
-rw-r--r-- | Base/usr/share/man/man5/Shell.md | 8 | ||||
-rw-r--r-- | Base/usr/share/man/man7/Shell-vars.md | 6 |
8 files changed, 23 insertions, 11 deletions
diff --git a/Base/usr/share/man/man1/Inspector.md b/Base/usr/share/man/man1/Inspector.md index f3166147d2..30dd6ba86c 100644 --- a/Base/usr/share/man/man1/Inspector.md +++ b/Base/usr/share/man/man1/Inspector.md @@ -8,6 +8,10 @@ Inspector - Serenity process inspector $ Inspector [pid] ``` +## Arguments + +* pid: Process ID to inspect + ## Description Inspector facilitates process inspection via RPC. diff --git a/Base/usr/share/man/man1/Playground.md b/Base/usr/share/man/man1/Playground.md index fb933dfb42..ef633e39b5 100644 --- a/Base/usr/share/man/man1/Playground.md +++ b/Base/usr/share/man/man1/Playground.md @@ -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) diff --git a/Base/usr/share/man/man1/Profiler.md b/Base/usr/share/man/man1/Profiler.md index 8cdfb1e4d1..d6f2c6e96e 100644 --- a/Base/usr/share/man/man1/Profiler.md +++ b/Base/usr/share/man/man1/Profiler.md @@ -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: diff --git a/Base/usr/share/man/man1/Shell.md b/Base/usr/share/man/man1/Shell.md index de2a6720ea..6ece59f952 100644 --- a/Base/usr/share/man/man1/Shell.md +++ b/Base/usr/share/man/man1/Shell.md @@ -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) diff --git a/Base/usr/share/man/man1/printf.md b/Base/usr/share/man/man1/printf.md index fe90d15367..efe1f963cb 100644 --- a/Base/usr/share/man/man1/printf.md +++ b/Base/usr/share/man/man1/printf.md @@ -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 | diff --git a/Base/usr/share/man/man1/xargs.md b/Base/usr/share/man/man1/xargs.md index 977b27fe5f..79650b0bd6 100644 --- a/Base/usr/share/man/man1/xargs.md +++ b/Base/usr/share/man/man1/xargs.md @@ -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 diff --git a/Base/usr/share/man/man5/Shell.md b/Base/usr/share/man/man5/Shell.md index 896ddba8e6..b8a98bcc32 100644 --- a/Base/usr/share/man/man5/Shell.md +++ b/Base/usr/share/man/man5/Shell.md @@ -16,7 +16,7 @@ The shell operates according to the following general steps: * Should a command be executed, the shell applies the redirections, and executes the command with the flattened argument list * Should a command need waiting, the shell shall wait for the command to finish, and continue execution -Any text below is superceded by the formal grammar defined in the _formal grammar_ section. +Any text below is superseded by the formal grammar defined in the _formal grammar_ section. ## General Token Recognition @@ -172,7 +172,7 @@ Any bareword starting with a tilde (`~`) and spanning up to the first path separ ### Evaluate Evaluate expressions take the general form of a dollar sign (`$`) followed by some _expression_, which is evaluated by the rules below. - Should the _expression_ be a string, it shall be evaluated as a dynamic variable lookup by first evaluating the string, and then looking up the given variable. -- Should the _expression_ be a list or a command, it shall be converted to a command, whose output (from the standard output) shall be captured, and split to a list with the shell local variable `IFS` (or the default splitter `\n` (newline, 0x0a)). It should be noted that the shell option `inline_exec_keep_empty_segments` will determine whether empty segments in the split list shall be preserved when this expression is evaluated, this behaviour is disabled by default. +- Should the _expression_ be a list or a command, it shall be converted to a command, whose output (from the standard output) shall be captured, and split to a list with the shell local variable `IFS` (or the default splitter `\n` (newline, 0x0a)). It should be noted that the shell option `inline_exec_keep_empty_segments` will determine whether empty segments in the split list shall be preserved when this expression is evaluated, this behavior is disabled by default. ## Commands @@ -271,7 +271,7 @@ $ for index i x in * { echo file at index $i is named $x } ##### Infinite Loops Infinite loops (as denoted by the keyword `loop`) can be used to repeat a block until the block runs `break`, or the loop terminates by external sources (interrupts, program exit, and terminating signals). -The behaviour regarding SIGINT and other signals is the same as for loops (mentioned above). +The behavior regarding SIGINT and other signals is the same as for loops (mentioned above). ###### Examples ```sh @@ -348,7 +348,7 @@ match "$(make_some_value)" { ``` ### History Event Designators -History expansion may be utilised to reuse previously typed words or commands. +History expansion may be utilized to reuse previously typed words or commands. Such expressions are of the general form `!<event_designator>(:<word_designator>)`, where `event_designator` would select an entry in the shell history, and `word_designator` would select a word (or a range of words) from that entry. | Event designator | effect | diff --git a/Base/usr/share/man/man7/Shell-vars.md b/Base/usr/share/man/man7/Shell-vars.md index 5c46d90fa5..82e4153edf 100644 --- a/Base/usr/share/man/man7/Shell-vars.md +++ b/Base/usr/share/man/man7/Shell-vars.md @@ -4,10 +4,10 @@ Shell Variables - Special local and environment variables used by the Shell ## Description -The Shell uses various variables to allow for customisations of certain behavioural or visual things. +The Shell uses various variables to allow for customisations of certain behavioral or visual things. Such variables can be changed or set by the user to tweak how the shell presents things. -## Behavioural +## Behavioral 1. Output interpretations @@ -23,7 +23,7 @@ The value of this variable is used to determine which entries are kept in the Sh - `ignorespace`: Entries starting with one or more space characters are ignored - `ignoredups`: Consecutive duplicate entries are ignored -- `ignoreboth`: The behaviour of `ignorespace` and `ignoredups` is combined +- `ignoreboth`: The behavior of `ignorespace` and `ignoredups` is combined - If the variable is unset (this is the default) or has any other value than the above, no entries will be excluded from history. Note: This variable is respected by every program using `Line::Editor`, e.g. [`js`(1)](../man1/js.md). |