docs: omnibus cleanup

Includes harmonizing the display of options and arguments, standardising
terminology, using the envvar directive more broadly, adding help options to all
commands that support them, simplifying some language, and tidying up multiple
formatting issues.

string documentation is not changed.
This commit is contained in:
David Adam
2022-03-12 00:18:41 +08:00
parent e23e52a8e9
commit 3a23fdf359
66 changed files with 278 additions and 143 deletions

View File

@@ -12,7 +12,7 @@ Synopsis
Description
-----------
**cd** changes the current working directory.
``cd`` changes the current working directory.
If *DIRECTORY* is given, it will become the new directory. If no parameter is given, the :envvar:`HOME` environment variable will be used.
@@ -28,6 +28,8 @@ If you make those universal variables your **cd** history is shared among all fi
As a special case, ``cd .`` is equivalent to ``cd $PWD``, which is useful in cases where a mountpoint has been recycled or a directory has been removed and recreated.
The **--help** or **-h** option displays help about using this command, and does not change the directory.
Examples
--------