diff --git a/doc_src/cmds/help.rst b/doc_src/cmds/help.rst index 4373318db..1b6af322b 100644 --- a/doc_src/cmds/help.rst +++ b/doc_src/cmds/help.rst @@ -6,25 +6,27 @@ help - display fish documentation Synopsis -------- -:: - - help [SECTION] +``help`` [*SECTION*] Description ----------- ``help`` displays the fish help documentation. -If a ``SECTION`` is specified, the help for that command is shown. +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. - -If you prefer to use a different browser (other than as described above) for fish help, you can set the 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. - -Note that most builtin commands display their help in the terminal when given the ``--help`` option. +If the 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. Example ------- ``help fg`` shows the documentation for the :ref:`fg ` builtin. + +Notes +----- + +Most builtin commands display their help in the terminal when given the **--help** option. diff --git a/doc_src/cmds/history.rst b/doc_src/cmds/history.rst index 79e58b08a..d5ff6c4a5 100644 --- a/doc_src/cmds/history.rst +++ b/doc_src/cmds/history.rst @@ -6,15 +6,12 @@ history - show and manipulate command history Synopsis -------- -:: - - history [ search ] [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] [ --max=n ] [ --null ] [ -R | --reverse ] [ "search string"... ] - history delete [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] "search string"... - history merge - history save - history clear - history clear-session - history ( -h | --help ) +| ``history`` [**search**] [**--show-time** **--case-sensitive**] + \ \ [**--exact** | **--prefix** | **--contains**] [**--max** *n*] [**--null** **--reverse**] + \ \ [ *SEARCH_STRING...* ] +| ``history`` **delete** [**--show-time** **--case-sensitive**] + \ \ [**--exact** | **--prefix** | **--contains**] *SEARCH_STRING...* +| ``history`` { **merge** | **save** | **clear** | **clear_session** } Description -----------