h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-04-26 05:01:15 -03:00
Code Issues Packages Projects Releases Wiki Activity

docs: omnibus cleanup

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

7
doc_src/cmds/help.rst
View File

@@ -17,9 +17,10 @@ Description
If a *SECTION* is specified, the help for that command is shown.
If the BROWSER environment variable is set, it will be used to display the documentation.
Otherwise, fish will search for a suitable browser.
The **-h** or **--help** option displays help about using this command.
If the :envvar:`BROWSER`` environment variable is set, it will be used to display the documentation.
Otherwise, fish will search for a suitable browser.
To use a different browser than as described above, one can set the :envvar:`fish_help_browser` variable.
This variable may be set as a list, where the first element is the browser command and the rest are browser options.
@@ -31,4 +32,4 @@ Example
Notes
-----
Most builtin commands display their help in the terminal when given the **--help** option.
Most builtin commands, including this one, display their help in the terminal when given the **--help** option.