diff --git a/sphinx_doc_src/faq.rst b/sphinx_doc_src/faq.rst index 35742d8b9..e08a58e55 100644 --- a/sphinx_doc_src/faq.rst +++ b/sphinx_doc_src/faq.rst @@ -3,7 +3,7 @@ Frequently asked questions How do I set or clear an environment variable? ---------------------------------------------- -Use the ``set`` command:: +Use the `set `__ command:: set -x key value set -e key @@ -26,7 +26,7 @@ The prompt is the output of the ``fish_prompt`` function. Put it in ``~/.config/ end -You can also use the Web configuration tool, ``fish_config``, to preview and choose from a gallery of sample prompts. +You can also use the Web configuration tool, `fish_config `__, to preview and choose from a gallery of sample prompts. How do I run a command from history? @@ -93,7 +93,7 @@ If you are just interested in success or failure, you can run the command direct end -See the documentation for ``test`` and ``if`` for more information. +See the documentation for `test `__ and `if `__ for more information. ~~ How do I set an environment variable for just one command? @@ -154,7 +154,7 @@ variables. This means that the global value takes precedence over the universal value. To avoid this problem, consider changing the setting which fish inherits. If this is not possible, -add a statement to your user initialization file (usually +add a statement to your `user initialization file `__ (usually ``~/.config/fish/config.fish``):: set -gx EDITOR vim @@ -162,12 +162,12 @@ add a statement to your user initialization file (usua How do I customize my syntax highlighting colors? ------------------------------------------------- -Use the web configuration tool, ``fish_config``, or alter the ``fish_color`` family of environment variables. +Use the web configuration tool, `fish_config `__, or alter the `fish_color family of environment variables `__. ~~ How do I update man page completions? ------------------------------------- -Use the ``fish_update_completions`` command. +Use the `fish_update_completions `__ command. ~~ I accidentally entered a directory path and fish changed directory. What happened? @@ -177,7 +177,7 @@ If fish is unable to locate a command with a given name, and it starts with '``. The open command doesn't work. ------------------------------ -The ``open`` command uses the MIME type database and the ``.desktop`` files used by Gnome and KDE to identify filetypes and default actions. If at least one of these environments is installed, but the open command is not working, this probably means that the relevant files are installed in a non-standard location. Consider asking for more help. +The ``open`` command uses the MIME type database and the ``.desktop`` files used by Gnome and KDE to identify filetypes and default actions. If at least one of these environments is installed, but the open command is not working, this probably means that the relevant files are installed in a non-standard location. Consider `asking for more help `__. How do I make fish my default shell? diff --git a/sphinx_doc_src/index.rst b/sphinx_doc_src/index.rst index 11d27c5be..96e5b4424 100644 --- a/sphinx_doc_src/index.rst +++ b/sphinx_doc_src/index.rst @@ -719,7 +719,7 @@ Examples: - ``**`` matches any files and directories in the current directory and all of its subdirectories. -Note that for most commands, if any wildcard fails to expand, the command is not executed, ```$status`` <#variables-status>`_ is set to nonzero, and a warning is printed. This behavior is consistent with setting ``shopt -s failglob`` in bash. There are exactly 3 exceptions, namely `set `_, `count `_ and `for `_. Their globs are permitted to expand to zero arguments, as with ``shopt -s nullglob`` in bash. +Note that for most commands, if any wildcard fails to expand, the command is not executed, `$status <#variables-status>`_ is set to nonzero, and a warning is printed. This behavior is consistent with setting ``shopt -s failglob`` in bash. There are exactly 3 exceptions, namely `set `_, `count `_ and `for `_. Their globs are permitted to expand to zero arguments, as with ``shopt -s nullglob`` in bash. Examples:: @@ -1191,7 +1191,7 @@ The user can change the settings of ``fish`` by changing the values of certain v - ``fish_ambiguous_width`` controls the computed width of ambiguous East Asian characters. This should be set to 1 if your terminal emulator renders these characters as single-width (typical), or 2 if double-width. -- ``fish_escape_delay_ms`` overrides the default timeout of 30ms after seeing an escape character before giving up on matching a key binding. See the documentation for the `bind `__ builtin command. This delay facilitates using escape as a meta key. +- ``fish_escape_delay_ms`` overrides the default timeout of 30ms after seeing an escape character before giving up on matching a key binding. See the documentation for the `bind `__ builtin command. This delay facilitates using escape as a meta key. - ``fish_greeting``, the greeting message printed on startup. @@ -1627,7 +1627,7 @@ Configuration files are evaluated in the following order: If there are multiple files with the same name in these directories, only the first will be executed. They are executed in order of their filename, sorted (like globs) in a natural order (i.e. "01" sorts before "2"). -- System-wide configuration files, where administrators can include initialization that should be run for all users on the system - similar to ``/etc/profile`` for POSIX-style shells - in ``$__fish_sysconf_dir``` (usually ``/etc/fish/config.fish``); +- System-wide configuration files, where administrators can include initialization that should be run for all users on the system - similar to ``/etc/profile`` for POSIX-style shells - in ``$__fish_sysconf_dir` (usually /etc/fish/config.fish``); - User initialization, usually in `~/.config/fish/config.fish` (controlled by the ``XDG_CONFIG_HOME`` environment variable, and accessible as ``$__fish_config_dir``). These paths are controlled by parameters set at build, install, or run time, and may vary from the defaults listed above. diff --git a/sphinx_doc_src/tutorial.rst b/sphinx_doc_src/tutorial.rst index 01503482b..ef64c480f 100644 --- a/sphinx_doc_src/tutorial.rst +++ b/sphinx_doc_src/tutorial.rst @@ -338,7 +338,7 @@ You can iterate over a list (or a slice) with a for loop:: entry: /usr/local/bin -Lists adjacent to other lists or strings are expanded as cartesian products unless quoted (see Variable expansion):: +Lists adjacent to other lists or strings are expanded as `cartesian products `__ unless quoted (see `Variable expansion `__):: >_ set a 1 2 3 >_ set 1 a b c @@ -350,7 +350,7 @@ Lists adjacent to other lists or strings are expanded as Brace expansion. +This is similar to `Brace expansion `__. Command Substitutions --------------------- @@ -445,7 +445,7 @@ Use ``if``, ``else if``, and ``else`` to conditionally execute code, based on th end -To compare strings or numbers or check file properties (whether a file exists or is writeable and such), use test, like +To compare strings or numbers or check file properties (whether a file exists or is writeable and such), use `test `__, like @@ -650,7 +650,7 @@ This is the preferred way to define your prompt as well:: end -See the documentation for funced and funcsave for ways to create these files automatically. +See the documentation for `funced `__ and `funcsave `__ for ways to create these files automatically. Universal Variables -------------------