diff --git a/sphinx_doc_src/cmds/fish.rst b/sphinx_doc_src/cmds/fish.rst index 35cd9599b..cb92df6ec 100644 --- a/sphinx_doc_src/cmds/fish.rst +++ b/sphinx_doc_src/cmds/fish.rst @@ -12,7 +12,7 @@ fish [OPTIONS] [-c command] [FILE [ARGUMENTS...]] Description ----------- -``fish`` is a command-line shell written mainly with interactive use in mind. The full manual is available in HTML by using the :ref:`help ` command from inside fish. +``fish`` is a command-line shell written mainly with interactive use in mind. The :ref:`full manual ` is available in HTML by using the :ref:`help ` command from inside fish. The following options are available: diff --git a/sphinx_doc_src/cmds/funcsave.rst b/sphinx_doc_src/cmds/funcsave.rst index a93f23814..34f9d63a8 100644 --- a/sphinx_doc_src/cmds/funcsave.rst +++ b/sphinx_doc_src/cmds/funcsave.rst @@ -14,4 +14,4 @@ Description ``funcsave`` saves the current definition of a function to a file in the fish configuration directory. This function will be automatically loaded by current and future fish sessions. This can be useful if you have interactively created a new function and wish to save it for later use. -Note that because fish loads functions on-demand, saved functions will not function as event handlers until they are run or sourced otherwise. To activate an event handler for every new shell, add the function to your shell initialization file instead of using ``funcsave``. +Note that because fish loads functions on-demand, saved functions will not function as :ref:`event handlers ` until they are run or sourced otherwise. To activate an event handler for every new shell, add the function to your :ref:`shell initialization file ` instead of using ``funcsave``. diff --git a/sphinx_doc_src/cmds/if.rst b/sphinx_doc_src/cmds/if.rst index cb44727fd..617f94f7d 100644 --- a/sphinx_doc_src/cmds/if.rst +++ b/sphinx_doc_src/cmds/if.rst @@ -19,7 +19,7 @@ Description You can use :ref:`and ` or :ref:`or ` in the condition. See the second example below. -The exit status of the last foreground command to exit can always be accessed using the $status variable. +The exit status of the last foreground command to exit can always be accessed using the :ref:`$status ` variable. Example ------- diff --git a/sphinx_doc_src/cmds/or.rst b/sphinx_doc_src/cmds/or.rst index f7037dfd0..1cbdb8178 100644 --- a/sphinx_doc_src/cmds/or.rst +++ b/sphinx_doc_src/cmds/or.rst @@ -17,7 +17,7 @@ Description ``or`` statements may be used as part of the condition in an :ref:`and ` or :ref:`while ` block. See the documentation for :ref:`if ` and :ref:`while ` for examples. -``or`` does not change the current exit status itself, but the command it runs most likely will. The exit status of the last foreground command to exit can always be accessed using the $status variable. +``or`` does not change the current exit status itself, but the command it runs most likely will. The exit status of the last foreground command to exit can always be accessed using the :ref:`$status ` variable. Example ------- diff --git a/sphinx_doc_src/cmds/set.rst b/sphinx_doc_src/cmds/set.rst index 4e4c2845c..df051318c 100644 --- a/sphinx_doc_src/cmds/set.rst +++ b/sphinx_doc_src/cmds/set.rst @@ -18,7 +18,7 @@ set ( -S | --show ) [SCOPE_OPTIONS] [VARIABLE_NAME]... Description ----------- -``set`` manipulates shell variables. +``set`` manipulates :ref:`shell variables `. If set is called with no arguments, the names and values of all shell variables are printed in sorted order. If some of the scope or export flags have been given, only the variables matching the specified scope are printed. diff --git a/sphinx_doc_src/cmds/test.rst b/sphinx_doc_src/cmds/test.rst index 0c8914398..cbdd6e65d 100644 --- a/sphinx_doc_src/cmds/test.rst +++ b/sphinx_doc_src/cmds/test.rst @@ -189,7 +189,7 @@ which is logically equivalent to the following: Standards --------- -``test`` implements a subset of the IEEE Std 1003.1-2008 (POSIX.1) standard. The following exceptions apply: +``test`` implements a subset of the `IEEE Std 1003.1-2008 (POSIX.1) standard `__. The following exceptions apply: - The ``<`` and ``>`` operators for comparing strings are not implemented. diff --git a/sphinx_doc_src/cmds/trap.rst b/sphinx_doc_src/cmds/trap.rst index dbe8ce890..770135cc5 100644 --- a/sphinx_doc_src/cmds/trap.rst +++ b/sphinx_doc_src/cmds/trap.rst @@ -12,7 +12,7 @@ trap [OPTIONS] [[ARG] REASON ... ] Description ----------- -``trap`` is a wrapper around the fish event delivery framework. It exists for backwards compatibility with POSIX shells. For other uses, it is recommended to define an event handler. +``trap`` is a wrapper around the fish event delivery framework. It exists for backwards compatibility with POSIX shells. For other uses, it is recommended to define an :ref:`event handler `. The following parameters are available: diff --git a/sphinx_doc_src/index.rst b/sphinx_doc_src/index.rst index c7dfa73c9..49aca598f 100644 --- a/sphinx_doc_src/index.rst +++ b/sphinx_doc_src/index.rst @@ -1,4 +1,5 @@ .. highlight:: fish +.. _intro: Introduction ============ diff --git a/sphinx_doc_src/tutorial.rst b/sphinx_doc_src/tutorial.rst index e985c8c2d..b98ef5061 100644 --- a/sphinx_doc_src/tutorial.rst +++ b/sphinx_doc_src/tutorial.rst @@ -696,4 +696,4 @@ with ``/bin/bash``, ``/bin/tcsh`` or ``/bin/zsh`` as appropriate in the steps ab Ready for more? --------------- -If you want to learn more about fish, there is lots of detailed documentation, an official mailing list, the IRC channel \#fish on ``irc.oftc.net``, and the github page. +If you want to learn more about fish, there is :ref:`lots of detailed documentation `, an `official mailing list `__, the IRC channel \#fish on ``irc.oftc.net``, and the `github page `__.