diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 8f542847a..d1957f658 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -919,7 +919,7 @@ Notable improvements and fixes which expands ``!!`` to the last history item, anywhere on the command line, mimicking other shells' history expansion. - See :ref:`the documentation ` for more. + See :doc:`the documentation ` for more. - ``path`` gained a new ``mtime`` subcommand to print the modification time stamp for files. For example, this can be used to handle cache file ages (:issue:`9057`):: > touch foo @@ -1344,7 +1344,7 @@ Scripting improvements two 'blue ' -- ``$fish_user_paths`` is now automatically deduplicated to fix a common user error of appending to it in config.fish when it is universal (:issue:`8117`). :ref:`fish_add_path ` remains the recommended way to add to $PATH. +- ``$fish_user_paths`` is now automatically deduplicated to fix a common user error of appending to it in config.fish when it is universal (:issue:`8117`). :doc:`fish_add_path ` remains the recommended way to add to $PATH. - ``return`` can now be used outside functions. In scripts, it does the same thing as ``exit``. In interactive mode,it sets ``$status`` without exiting (:issue:`8148`). - An oversight prevented all syntax checks from running on commands given to ``fish -c`` (:issue:`8171`). This includes checks such as ``exec`` not being allowed in a pipeline, and ``$$`` not being a valid variable. Generally, another error was generated anyway. - ``fish_indent`` now correctly reformats tokens that end with a backslash followed by a newline (:issue:`8197`). diff --git a/doc_src/cmds/_.rst b/doc_src/cmds/_.rst index ad0809b21..57ddea8f7 100644 --- a/doc_src/cmds/_.rst +++ b/doc_src/cmds/_.rst @@ -1,5 +1,3 @@ -.. _cmd-_: - _ - call fish's translations ============================ diff --git a/doc_src/cmds/abbr.rst b/doc_src/cmds/abbr.rst index 91f952d25..7f0457623 100644 --- a/doc_src/cmds/abbr.rst +++ b/doc_src/cmds/abbr.rst @@ -1,5 +1,3 @@ -.. _cmd-abbr: - abbr - manage fish abbreviations ================================ diff --git a/doc_src/cmds/alias.rst b/doc_src/cmds/alias.rst index e18af0136..8110692b3 100644 --- a/doc_src/cmds/alias.rst +++ b/doc_src/cmds/alias.rst @@ -1,5 +1,3 @@ -.. _cmd-alias: - alias - create a function ========================= diff --git a/doc_src/cmds/and.rst b/doc_src/cmds/and.rst index a703e01de..b9bcb4505 100644 --- a/doc_src/cmds/and.rst +++ b/doc_src/cmds/and.rst @@ -1,5 +1,3 @@ -.. _cmd-and: - and - conditionally execute a command ===================================== diff --git a/doc_src/cmds/argparse.rst b/doc_src/cmds/argparse.rst index f415cbb98..fb6766218 100644 --- a/doc_src/cmds/argparse.rst +++ b/doc_src/cmds/argparse.rst @@ -1,5 +1,3 @@ -.. _cmd-argparse: - argparse - parse options passed to a fish script or function ============================================================ diff --git a/doc_src/cmds/begin.rst b/doc_src/cmds/begin.rst index cf86c2848..a916e848b 100644 --- a/doc_src/cmds/begin.rst +++ b/doc_src/cmds/begin.rst @@ -1,5 +1,3 @@ -.. _cmd-begin: - begin - start a new block of code ================================= diff --git a/doc_src/cmds/bg.rst b/doc_src/cmds/bg.rst index 51cba507d..15408b787 100644 --- a/doc_src/cmds/bg.rst +++ b/doc_src/cmds/bg.rst @@ -1,5 +1,3 @@ -.. _cmd-bg: - bg - send jobs to background ============================ diff --git a/doc_src/cmds/bind.rst b/doc_src/cmds/bind.rst index d2fa48dea..a3c0d4fb0 100644 --- a/doc_src/cmds/bind.rst +++ b/doc_src/cmds/bind.rst @@ -1,5 +1,3 @@ -.. _cmd-bind: - bind - handle fish key bindings =============================== Synopsis diff --git a/doc_src/cmds/block.rst b/doc_src/cmds/block.rst index d08625bc5..608276bea 100644 --- a/doc_src/cmds/block.rst +++ b/doc_src/cmds/block.rst @@ -1,5 +1,3 @@ -.. _cmd-block: - block - temporarily block delivery of events ============================================ diff --git a/doc_src/cmds/break.rst b/doc_src/cmds/break.rst index 0f58753b1..5b23aae54 100644 --- a/doc_src/cmds/break.rst +++ b/doc_src/cmds/break.rst @@ -1,5 +1,3 @@ -.. _cmd-break: - break - stop the current inner loop =================================== diff --git a/doc_src/cmds/breakpoint.rst b/doc_src/cmds/breakpoint.rst index 48c225e5f..41936775d 100644 --- a/doc_src/cmds/breakpoint.rst +++ b/doc_src/cmds/breakpoint.rst @@ -1,5 +1,3 @@ -.. _cmd-breakpoint: - breakpoint - launch debug mode ============================== diff --git a/doc_src/cmds/builtin.rst b/doc_src/cmds/builtin.rst index dfc40fd3a..6a52a8621 100644 --- a/doc_src/cmds/builtin.rst +++ b/doc_src/cmds/builtin.rst @@ -1,5 +1,3 @@ -.. _cmd-builtin: - builtin - run a builtin command =============================== diff --git a/doc_src/cmds/case.rst b/doc_src/cmds/case.rst index e971108b8..10bb69003 100644 --- a/doc_src/cmds/case.rst +++ b/doc_src/cmds/case.rst @@ -1,5 +1,3 @@ -.. _cmd-case: - case - conditionally execute a block of commands ================================================ diff --git a/doc_src/cmds/cd.rst b/doc_src/cmds/cd.rst index d2de7c7ba..afc64e74a 100644 --- a/doc_src/cmds/cd.rst +++ b/doc_src/cmds/cd.rst @@ -1,5 +1,3 @@ -.. _cmd-cd: - cd - change directory ===================== diff --git a/doc_src/cmds/cdh.rst b/doc_src/cmds/cdh.rst index c7c500fc5..0eef29058 100644 --- a/doc_src/cmds/cdh.rst +++ b/doc_src/cmds/cdh.rst @@ -1,5 +1,3 @@ -.. _cmd-cdh: - cdh - change to a recently visited directory ============================================ diff --git a/doc_src/cmds/command.rst b/doc_src/cmds/command.rst index 1653a6b8b..6147a383f 100644 --- a/doc_src/cmds/command.rst +++ b/doc_src/cmds/command.rst @@ -1,5 +1,3 @@ -.. _cmd-command: - command - run a program ======================= diff --git a/doc_src/cmds/commandline.rst b/doc_src/cmds/commandline.rst index 942eeaf4c..e5a3a39ec 100644 --- a/doc_src/cmds/commandline.rst +++ b/doc_src/cmds/commandline.rst @@ -1,5 +1,3 @@ -.. _cmd-commandline: - commandline - set or get the current command line buffer ======================================================== diff --git a/doc_src/cmds/complete.rst b/doc_src/cmds/complete.rst index b72221faf..84ab6fe05 100644 --- a/doc_src/cmds/complete.rst +++ b/doc_src/cmds/complete.rst @@ -1,5 +1,3 @@ -.. _cmd-complete: - complete - edit command-specific tab-completions ================================================ @@ -16,7 +14,7 @@ Description ``complete`` defines, removes or lists completions for a command. -For an introduction to writing your own completions, see :ref:`Writing your own completions ` in +For an introduction to writing your own completions, see :doc:`Writing your own completions <../completions>` in the fish manual. The following options are available: diff --git a/doc_src/cmds/contains.rst b/doc_src/cmds/contains.rst index fa8bf8435..556c00df3 100644 --- a/doc_src/cmds/contains.rst +++ b/doc_src/cmds/contains.rst @@ -1,5 +1,3 @@ -.. _cmd-contains: - contains - test if a word is present in a list ============================================== diff --git a/doc_src/cmds/continue.rst b/doc_src/cmds/continue.rst index 5b4f9e5b7..c6d0f9b41 100644 --- a/doc_src/cmds/continue.rst +++ b/doc_src/cmds/continue.rst @@ -1,5 +1,3 @@ -.. _cmd-continue: - continue - skip the remainder of the current iteration of the current inner loop ================================================================================ diff --git a/doc_src/cmds/count.rst b/doc_src/cmds/count.rst index 657dc8467..4269bda32 100644 --- a/doc_src/cmds/count.rst +++ b/doc_src/cmds/count.rst @@ -1,5 +1,3 @@ -.. _cmd-count: - count - count the number of elements of a list ================================================ diff --git a/doc_src/cmds/dirh.rst b/doc_src/cmds/dirh.rst index fa8850b1b..0078fcd07 100644 --- a/doc_src/cmds/dirh.rst +++ b/doc_src/cmds/dirh.rst @@ -1,5 +1,3 @@ -.. _cmd-dirh: - dirh - print directory history ============================== diff --git a/doc_src/cmds/dirs.rst b/doc_src/cmds/dirs.rst index 61fa5aeaf..aff762efe 100644 --- a/doc_src/cmds/dirs.rst +++ b/doc_src/cmds/dirs.rst @@ -1,5 +1,3 @@ -.. _cmd-dirs: - dirs - print directory stack ============================ diff --git a/doc_src/cmds/disown.rst b/doc_src/cmds/disown.rst index 964de0b21..a044c08b5 100644 --- a/doc_src/cmds/disown.rst +++ b/doc_src/cmds/disown.rst @@ -1,5 +1,3 @@ -.. _cmd-disown: - disown - remove a process from the list of jobs =============================================== diff --git a/doc_src/cmds/echo.rst b/doc_src/cmds/echo.rst index e5a74d0ea..18dfe7c8b 100644 --- a/doc_src/cmds/echo.rst +++ b/doc_src/cmds/echo.rst @@ -1,5 +1,3 @@ -.. _cmd-echo: - echo - display a line of text ============================= diff --git a/doc_src/cmds/else.rst b/doc_src/cmds/else.rst index 24b399aed..f22c87ca6 100644 --- a/doc_src/cmds/else.rst +++ b/doc_src/cmds/else.rst @@ -1,5 +1,3 @@ -.. _cmd-else: - else - execute command if a condition is not met ================================================ diff --git a/doc_src/cmds/emit.rst b/doc_src/cmds/emit.rst index e2fc4100a..64cf74cc6 100644 --- a/doc_src/cmds/emit.rst +++ b/doc_src/cmds/emit.rst @@ -1,5 +1,3 @@ -.. _cmd-emit: - emit - emit a generic event =========================== diff --git a/doc_src/cmds/end.rst b/doc_src/cmds/end.rst index 6298a7d39..2b54412eb 100644 --- a/doc_src/cmds/end.rst +++ b/doc_src/cmds/end.rst @@ -1,5 +1,3 @@ -.. _cmd-end: - end - end a block of commands ============================= diff --git a/doc_src/cmds/eval.rst b/doc_src/cmds/eval.rst index e995b5200..3f1cfcd1a 100644 --- a/doc_src/cmds/eval.rst +++ b/doc_src/cmds/eval.rst @@ -1,5 +1,3 @@ -.. _cmd-eval: - eval - evaluate the specified commands ====================================== diff --git a/doc_src/cmds/exec.rst b/doc_src/cmds/exec.rst index f16a45cfd..2556c10be 100644 --- a/doc_src/cmds/exec.rst +++ b/doc_src/cmds/exec.rst @@ -1,5 +1,3 @@ -.. _cmd-exec: - exec - execute command in current process ========================================= diff --git a/doc_src/cmds/exit.rst b/doc_src/cmds/exit.rst index 2c2189f37..c79f58c61 100644 --- a/doc_src/cmds/exit.rst +++ b/doc_src/cmds/exit.rst @@ -1,6 +1,3 @@ -.. _cmd-exit: -.. program::exit - exit - exit the shell ===================== diff --git a/doc_src/cmds/export.rst b/doc_src/cmds/export.rst index 8ca11eefe..ed3e0e773 100644 --- a/doc_src/cmds/export.rst +++ b/doc_src/cmds/export.rst @@ -1,5 +1,3 @@ -.. _cmd-export: - export - compatibility function for exporting variables ======================================================= diff --git a/doc_src/cmds/false.rst b/doc_src/cmds/false.rst index fda05765f..08e083334 100644 --- a/doc_src/cmds/false.rst +++ b/doc_src/cmds/false.rst @@ -1,5 +1,3 @@ -.. _cmd-false: - false - return an unsuccessful result ===================================== diff --git a/doc_src/cmds/fg.rst b/doc_src/cmds/fg.rst index e2a5b4325..ea76d7f77 100644 --- a/doc_src/cmds/fg.rst +++ b/doc_src/cmds/fg.rst @@ -1,5 +1,3 @@ -.. _cmd-fg: - fg - bring job to foreground ============================ diff --git a/doc_src/cmds/fish.rst b/doc_src/cmds/fish.rst index 69af56a2b..e5f9a48d9 100644 --- a/doc_src/cmds/fish.rst +++ b/doc_src/cmds/fish.rst @@ -1,6 +1,3 @@ -.. _cmd-fish: -.. program::fish - fish - the friendly interactive shell ===================================== @@ -18,7 +15,7 @@ Description :command:`fish` is a command-line shell written mainly with interactive use in mind. This page briefly describes the options for invoking :command:`fish`. The :ref:`full manual ` is available in HTML by using the :command:`help` command from inside fish, and in the `fish-doc(1)` man page. -The :ref:`tutorial ` is available as HTML via ``help tutorial`` or in `man fish-tutorial`. +The :doc:`tutorial <../tutorial>` is available as HTML via ``help tutorial`` or in `man fish-tutorial`. The following options are available: diff --git a/doc_src/cmds/fish_add_path.rst b/doc_src/cmds/fish_add_path.rst index c43066f8e..c0c58a957 100644 --- a/doc_src/cmds/fish_add_path.rst +++ b/doc_src/cmds/fish_add_path.rst @@ -1,6 +1,3 @@ -.. _cmd-fish_add_path: -.. program::fish_add_path - fish_add_path - add to the path ============================================================== diff --git a/doc_src/cmds/fish_breakpoint_prompt.rst b/doc_src/cmds/fish_breakpoint_prompt.rst index e8f73efe7..5069b6491 100644 --- a/doc_src/cmds/fish_breakpoint_prompt.rst +++ b/doc_src/cmds/fish_breakpoint_prompt.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_breakpoint_prompt: - fish_breakpoint_prompt - define the prompt when stopped at a breakpoint ======================================================================= diff --git a/doc_src/cmds/fish_clipboard_copy.rst b/doc_src/cmds/fish_clipboard_copy.rst index 481d36e34..15159bac0 100644 --- a/doc_src/cmds/fish_clipboard_copy.rst +++ b/doc_src/cmds/fish_clipboard_copy.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_clipboard_copy: - fish_clipboard_copy - copy text to the system's clipboard ============================================================== diff --git a/doc_src/cmds/fish_clipboard_paste.rst b/doc_src/cmds/fish_clipboard_paste.rst index 2022a0693..c7bb35334 100644 --- a/doc_src/cmds/fish_clipboard_paste.rst +++ b/doc_src/cmds/fish_clipboard_paste.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_clipboard_paste: - fish_clipboard_paste - get text from the system's clipboard ============================================================== diff --git a/doc_src/cmds/fish_command_not_found.rst b/doc_src/cmds/fish_command_not_found.rst index 007f4ef00..48a215a8a 100644 --- a/doc_src/cmds/fish_command_not_found.rst +++ b/doc_src/cmds/fish_command_not_found.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_command_not_found: - fish_command_not_found - what to do when a command wasn't found =============================================================== diff --git a/doc_src/cmds/fish_config.rst b/doc_src/cmds/fish_config.rst index 9fbe63485..cbd12e703 100644 --- a/doc_src/cmds/fish_config.rst +++ b/doc_src/cmds/fish_config.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_config: - fish_config - start the web-based configuration interface ========================================================= diff --git a/doc_src/cmds/fish_default_key_bindings.rst b/doc_src/cmds/fish_default_key_bindings.rst index 0a14402c7..48206badc 100644 --- a/doc_src/cmds/fish_default_key_bindings.rst +++ b/doc_src/cmds/fish_default_key_bindings.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_default_key_bindings: - fish_default_key_bindings - set emacs key bindings for fish =============================================================== diff --git a/doc_src/cmds/fish_git_prompt.rst b/doc_src/cmds/fish_git_prompt.rst index 7e1518d6a..98ee7e035 100644 --- a/doc_src/cmds/fish_git_prompt.rst +++ b/doc_src/cmds/fish_git_prompt.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_git_prompt: - fish_git_prompt - output git information for use in a prompt ============================================================ diff --git a/doc_src/cmds/fish_greeting.rst b/doc_src/cmds/fish_greeting.rst index c4d744e55..3b1e5af0b 100644 --- a/doc_src/cmds/fish_greeting.rst +++ b/doc_src/cmds/fish_greeting.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_greeting: - fish_greeting - display a welcome message in interactive shells =============================================================== diff --git a/doc_src/cmds/fish_hg_prompt.rst b/doc_src/cmds/fish_hg_prompt.rst index c200aa88b..143f5d84b 100644 --- a/doc_src/cmds/fish_hg_prompt.rst +++ b/doc_src/cmds/fish_hg_prompt.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_hg_prompt: - fish_hg_prompt - output Mercurial information for use in a prompt ================================================================= diff --git a/doc_src/cmds/fish_indent.rst b/doc_src/cmds/fish_indent.rst index 5c2ae7b4a..4ace72404 100644 --- a/doc_src/cmds/fish_indent.rst +++ b/doc_src/cmds/fish_indent.rst @@ -1,6 +1,3 @@ -.. _cmd-fish_indent: -.. program::fish_indent - fish_indent - indenter and prettifier ===================================== diff --git a/doc_src/cmds/fish_is_root_user.rst b/doc_src/cmds/fish_is_root_user.rst index 9bfb73ba5..3a3738607 100644 --- a/doc_src/cmds/fish_is_root_user.rst +++ b/doc_src/cmds/fish_is_root_user.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_is_root_user: - fish_is_root_user - check if the current user is root ===================================================== diff --git a/doc_src/cmds/fish_key_reader.rst b/doc_src/cmds/fish_key_reader.rst index 89d1371b7..4ab2b8ebc 100644 --- a/doc_src/cmds/fish_key_reader.rst +++ b/doc_src/cmds/fish_key_reader.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_key_reader: - fish_key_reader - explore what characters keyboard keys send ============================================================ diff --git a/doc_src/cmds/fish_mode_prompt.rst b/doc_src/cmds/fish_mode_prompt.rst index 4af5a3401..18f2bcc62 100644 --- a/doc_src/cmds/fish_mode_prompt.rst +++ b/doc_src/cmds/fish_mode_prompt.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_mode_prompt: - fish_mode_prompt - define the appearance of the mode indicator ============================================================== diff --git a/doc_src/cmds/fish_opt.rst b/doc_src/cmds/fish_opt.rst index 08624246a..55be65946 100644 --- a/doc_src/cmds/fish_opt.rst +++ b/doc_src/cmds/fish_opt.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_opt: - fish_opt - create an option specification for the argparse command ================================================================== diff --git a/doc_src/cmds/fish_prompt.rst b/doc_src/cmds/fish_prompt.rst index fd3611415..2f7373305 100644 --- a/doc_src/cmds/fish_prompt.rst +++ b/doc_src/cmds/fish_prompt.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_prompt: - fish_prompt - define the appearance of the command line prompt ============================================================== diff --git a/doc_src/cmds/fish_right_prompt.rst b/doc_src/cmds/fish_right_prompt.rst index f43b5f5d7..4908392a3 100644 --- a/doc_src/cmds/fish_right_prompt.rst +++ b/doc_src/cmds/fish_right_prompt.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_right_prompt: - fish_right_prompt - define the appearance of the right-side command line prompt =============================================================================== diff --git a/doc_src/cmds/fish_should_add_to_history.rst b/doc_src/cmds/fish_should_add_to_history.rst index 76c75e6e1..b3bbf846d 100644 --- a/doc_src/cmds/fish_should_add_to_history.rst +++ b/doc_src/cmds/fish_should_add_to_history.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_should_add_to_history: - fish_should_add_to_history - decide whether a command should be added to the history ==================================================================================== diff --git a/doc_src/cmds/fish_status_to_signal.rst b/doc_src/cmds/fish_status_to_signal.rst index 4d81db8c1..fc60a86c1 100644 --- a/doc_src/cmds/fish_status_to_signal.rst +++ b/doc_src/cmds/fish_status_to_signal.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_status_to_signal: - fish_status_to_signal - convert exit codes to human-friendly signals ==================================================================== diff --git a/doc_src/cmds/fish_svn_prompt.rst b/doc_src/cmds/fish_svn_prompt.rst index 68507a448..d9a8eb832 100644 --- a/doc_src/cmds/fish_svn_prompt.rst +++ b/doc_src/cmds/fish_svn_prompt.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_svn_prompt: - fish_svn_prompt - output Subversion information for use in a prompt =================================================================== diff --git a/doc_src/cmds/fish_title.rst b/doc_src/cmds/fish_title.rst index 35f63cb7e..4a2ec822c 100644 --- a/doc_src/cmds/fish_title.rst +++ b/doc_src/cmds/fish_title.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_title: - fish_title - define the terminal's title ======================================== diff --git a/doc_src/cmds/fish_update_completions.rst b/doc_src/cmds/fish_update_completions.rst index 340dbb343..a054bf82e 100644 --- a/doc_src/cmds/fish_update_completions.rst +++ b/doc_src/cmds/fish_update_completions.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_update_completions: - fish_update_completions - update completions using manual pages =============================================================== diff --git a/doc_src/cmds/fish_vcs_prompt.rst b/doc_src/cmds/fish_vcs_prompt.rst index 62667db95..9a44cbe24 100644 --- a/doc_src/cmds/fish_vcs_prompt.rst +++ b/doc_src/cmds/fish_vcs_prompt.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_vcs_prompt: - fish_vcs_prompt - output version control system information for use in a prompt =============================================================================== diff --git a/doc_src/cmds/fish_vi_key_bindings.rst b/doc_src/cmds/fish_vi_key_bindings.rst index 1d123632a..d9005ca4f 100644 --- a/doc_src/cmds/fish_vi_key_bindings.rst +++ b/doc_src/cmds/fish_vi_key_bindings.rst @@ -1,5 +1,3 @@ -.. _cmd-fish_vi_key_bindings: - fish_vi_key_bindings - set vi key bindings for fish =============================================================== diff --git a/doc_src/cmds/for.rst b/doc_src/cmds/for.rst index 5cde91f5c..92ff56735 100644 --- a/doc_src/cmds/for.rst +++ b/doc_src/cmds/for.rst @@ -1,5 +1,3 @@ -.. _cmd-for: - for - perform a set of commands multiple times ============================================== diff --git a/doc_src/cmds/funced.rst b/doc_src/cmds/funced.rst index 7f0a671e2..02c0df10e 100644 --- a/doc_src/cmds/funced.rst +++ b/doc_src/cmds/funced.rst @@ -1,5 +1,3 @@ -.. _cmd-funced: - funced - edit a function interactively ====================================== diff --git a/doc_src/cmds/funcsave.rst b/doc_src/cmds/funcsave.rst index e0eb4519b..5839d5d1f 100644 --- a/doc_src/cmds/funcsave.rst +++ b/doc_src/cmds/funcsave.rst @@ -1,5 +1,3 @@ -.. _cmd-funcsave: - funcsave - save the definition of a function to the user's autoload directory ============================================================================= diff --git a/doc_src/cmds/function.rst b/doc_src/cmds/function.rst index 764f9a7e9..daad2cef4 100644 --- a/doc_src/cmds/function.rst +++ b/doc_src/cmds/function.rst @@ -1,5 +1,3 @@ -.. _cmd-function: - function - create a function ============================ diff --git a/doc_src/cmds/functions.rst b/doc_src/cmds/functions.rst index 269f302a3..addbfd250 100644 --- a/doc_src/cmds/functions.rst +++ b/doc_src/cmds/functions.rst @@ -1,5 +1,3 @@ -.. _cmd-functions: - functions - print or erase functions ==================================== diff --git a/doc_src/cmds/help.rst b/doc_src/cmds/help.rst index 248e9cede..2f45ab0d9 100644 --- a/doc_src/cmds/help.rst +++ b/doc_src/cmds/help.rst @@ -1,5 +1,3 @@ -.. _cmd-help: - help - display fish documentation ================================= diff --git a/doc_src/cmds/history.rst b/doc_src/cmds/history.rst index 004280721..6b2fdc3dd 100644 --- a/doc_src/cmds/history.rst +++ b/doc_src/cmds/history.rst @@ -1,5 +1,3 @@ -.. _cmd-history: - history - show and manipulate command history ============================================= diff --git a/doc_src/cmds/if.rst b/doc_src/cmds/if.rst index 274845afe..78b8d922e 100644 --- a/doc_src/cmds/if.rst +++ b/doc_src/cmds/if.rst @@ -1,5 +1,3 @@ -.. _cmd-if: - if - conditionally execute a command ==================================== diff --git a/doc_src/cmds/isatty.rst b/doc_src/cmds/isatty.rst index 857a09c5e..989aef69f 100644 --- a/doc_src/cmds/isatty.rst +++ b/doc_src/cmds/isatty.rst @@ -1,5 +1,3 @@ -.. _cmd-isatty: - isatty - test if a file descriptor is a terminal ================================================ diff --git a/doc_src/cmds/jobs.rst b/doc_src/cmds/jobs.rst index 358a17a23..f7b8e4367 100644 --- a/doc_src/cmds/jobs.rst +++ b/doc_src/cmds/jobs.rst @@ -1,5 +1,3 @@ -.. _cmd-jobs: - jobs - print currently running jobs =================================== diff --git a/doc_src/cmds/math.rst b/doc_src/cmds/math.rst index 2c39b3228..3fffcbe6b 100644 --- a/doc_src/cmds/math.rst +++ b/doc_src/cmds/math.rst @@ -1,5 +1,3 @@ -.. _cmd-math: - math - perform mathematics calculations ======================================= diff --git a/doc_src/cmds/nextd.rst b/doc_src/cmds/nextd.rst index 630fe2c54..b0d4852c0 100644 --- a/doc_src/cmds/nextd.rst +++ b/doc_src/cmds/nextd.rst @@ -1,5 +1,3 @@ -.. _cmd-nextd: - nextd - move forward through directory history ============================================== diff --git a/doc_src/cmds/not.rst b/doc_src/cmds/not.rst index f609d708c..c361c0e73 100644 --- a/doc_src/cmds/not.rst +++ b/doc_src/cmds/not.rst @@ -1,5 +1,3 @@ -.. _cmd-not: - not - negate the exit status of a job ===================================== diff --git a/doc_src/cmds/open.rst b/doc_src/cmds/open.rst index 9f9875d27..f717af85e 100644 --- a/doc_src/cmds/open.rst +++ b/doc_src/cmds/open.rst @@ -1,5 +1,3 @@ -.. _cmd-open: - open - open file in its default application =========================================== diff --git a/doc_src/cmds/or.rst b/doc_src/cmds/or.rst index cddba9919..8e5c348d0 100644 --- a/doc_src/cmds/or.rst +++ b/doc_src/cmds/or.rst @@ -1,5 +1,3 @@ -.. _cmd-or: - or - conditionally execute a command ==================================== diff --git a/doc_src/cmds/path.rst b/doc_src/cmds/path.rst index 461204398..6652c1762 100644 --- a/doc_src/cmds/path.rst +++ b/doc_src/cmds/path.rst @@ -1,5 +1,3 @@ -.. _cmd-path: - path - manipulate and check paths ================================= diff --git a/doc_src/cmds/popd.rst b/doc_src/cmds/popd.rst index dafb5ed97..805b601ed 100644 --- a/doc_src/cmds/popd.rst +++ b/doc_src/cmds/popd.rst @@ -1,5 +1,3 @@ -.. _cmd-popd: - popd - move through directory stack =================================== diff --git a/doc_src/cmds/prevd.rst b/doc_src/cmds/prevd.rst index 790420abc..f63c65920 100644 --- a/doc_src/cmds/prevd.rst +++ b/doc_src/cmds/prevd.rst @@ -1,5 +1,3 @@ -.. _cmd-prevd: - prevd - move backward through directory history =============================================== diff --git a/doc_src/cmds/printf.rst b/doc_src/cmds/printf.rst index 8da7408b6..7dd31ec96 100644 --- a/doc_src/cmds/printf.rst +++ b/doc_src/cmds/printf.rst @@ -1,5 +1,3 @@ -.. _cmd-printf: - printf - display text according to a format string ================================================== diff --git a/doc_src/cmds/prompt_hostname.rst b/doc_src/cmds/prompt_hostname.rst index 386e62138..ec96aa43e 100644 --- a/doc_src/cmds/prompt_hostname.rst +++ b/doc_src/cmds/prompt_hostname.rst @@ -1,5 +1,3 @@ -.. _cmd-prompt_hostname: - prompt_hostname - print the hostname, shortened for use in the prompt ===================================================================== diff --git a/doc_src/cmds/prompt_login.rst b/doc_src/cmds/prompt_login.rst index d95631ab2..6631751db 100644 --- a/doc_src/cmds/prompt_login.rst +++ b/doc_src/cmds/prompt_login.rst @@ -1,5 +1,3 @@ -.. _cmd-prompt_login: - prompt_login - describe the login suitable for prompt ===================================================== diff --git a/doc_src/cmds/prompt_pwd.rst b/doc_src/cmds/prompt_pwd.rst index 8cfc09460..c62646c4a 100644 --- a/doc_src/cmds/prompt_pwd.rst +++ b/doc_src/cmds/prompt_pwd.rst @@ -1,5 +1,3 @@ -.. _cmd-prompt_pwd: - prompt_pwd - print pwd suitable for prompt ========================================== diff --git a/doc_src/cmds/psub.rst b/doc_src/cmds/psub.rst index 92aa1587e..2a4f2c94f 100644 --- a/doc_src/cmds/psub.rst +++ b/doc_src/cmds/psub.rst @@ -1,5 +1,3 @@ -.. _cmd-psub: - psub - perform process substitution =================================== diff --git a/doc_src/cmds/pushd.rst b/doc_src/cmds/pushd.rst index e9c466384..ca41b8f9d 100644 --- a/doc_src/cmds/pushd.rst +++ b/doc_src/cmds/pushd.rst @@ -1,5 +1,3 @@ -.. _cmd-pushd: - pushd - push directory to directory stack ========================================= diff --git a/doc_src/cmds/pwd.rst b/doc_src/cmds/pwd.rst index 565426a54..3aa7011a7 100644 --- a/doc_src/cmds/pwd.rst +++ b/doc_src/cmds/pwd.rst @@ -1,5 +1,3 @@ -.. _cmd-pwd: - pwd - output the current working directory ========================================== diff --git a/doc_src/cmds/random.rst b/doc_src/cmds/random.rst index a1ad74058..b4780b19c 100644 --- a/doc_src/cmds/random.rst +++ b/doc_src/cmds/random.rst @@ -1,5 +1,3 @@ -.. _cmd-random: - random - generate random number =============================== diff --git a/doc_src/cmds/read.rst b/doc_src/cmds/read.rst index adc7b31c4..ad5f60e69 100644 --- a/doc_src/cmds/read.rst +++ b/doc_src/cmds/read.rst @@ -1,5 +1,3 @@ -.. _cmd-read: - read - read line of input into variables ======================================== diff --git a/doc_src/cmds/realpath.rst b/doc_src/cmds/realpath.rst index 543389e15..1097a529b 100644 --- a/doc_src/cmds/realpath.rst +++ b/doc_src/cmds/realpath.rst @@ -1,6 +1,3 @@ -.. _cmd-realpath: -.. program::realpath - realpath - convert a path to an absolute path without symlinks ============================================================== diff --git a/doc_src/cmds/return.rst b/doc_src/cmds/return.rst index 08cfdfc8a..2b17a7f5e 100644 --- a/doc_src/cmds/return.rst +++ b/doc_src/cmds/return.rst @@ -1,6 +1,3 @@ -.. _cmd-return: -.. program::return: - return - stop the current inner function ======================================== diff --git a/doc_src/cmds/set.rst b/doc_src/cmds/set.rst index 4cbc704f5..9344d47b7 100644 --- a/doc_src/cmds/set.rst +++ b/doc_src/cmds/set.rst @@ -1,5 +1,3 @@ -.. _cmd-set: - set - display and change shell variables ======================================== diff --git a/doc_src/cmds/set_color.rst b/doc_src/cmds/set_color.rst index a2a83b3ed..d3736a9a0 100644 --- a/doc_src/cmds/set_color.rst +++ b/doc_src/cmds/set_color.rst @@ -1,5 +1,3 @@ -.. _cmd-set_color: - set_color - set the terminal color ================================== diff --git a/doc_src/cmds/source.rst b/doc_src/cmds/source.rst index 60519a57a..159fd5e70 100644 --- a/doc_src/cmds/source.rst +++ b/doc_src/cmds/source.rst @@ -1,5 +1,3 @@ -.. _cmd-source: - source - evaluate contents of file ================================== diff --git a/doc_src/cmds/status.rst b/doc_src/cmds/status.rst index b952a16e2..64c9b8f65 100644 --- a/doc_src/cmds/status.rst +++ b/doc_src/cmds/status.rst @@ -1,5 +1,3 @@ -.. _cmd-status: - status - query fish runtime information ======================================= diff --git a/doc_src/cmds/string-length.rst b/doc_src/cmds/string-length.rst index 6f59b6fdb..12056a5fe 100644 --- a/doc_src/cmds/string-length.rst +++ b/doc_src/cmds/string-length.rst @@ -1,5 +1,3 @@ -.. _cmd-string-length: - string-length - print string lengths ==================================== diff --git a/doc_src/cmds/string-shorten.rst b/doc_src/cmds/string-shorten.rst index 0e24bf058..800b9a55a 100644 --- a/doc_src/cmds/string-shorten.rst +++ b/doc_src/cmds/string-shorten.rst @@ -88,7 +88,7 @@ See Also .. BEGIN SEEALSO -- :ref:`string`'s ``pad`` subcommand does the inverse of this command, adding padding to a specific width instead. +- :doc:`string pad ` does the inverse of this command, adding padding to a specific width instead. - The :doc:`printf ` command can do simple padding, for example ``printf %10s\n`` works like ``string pad -w10``. diff --git a/doc_src/cmds/string.rst b/doc_src/cmds/string.rst index 653029965..507f2b3f8 100644 --- a/doc_src/cmds/string.rst +++ b/doc_src/cmds/string.rst @@ -1,5 +1,3 @@ -.. _cmd-string: - string - manipulate strings =========================== @@ -51,8 +49,6 @@ Most subcommands accept a **-q** or **--quiet** switch, which suppresses the usu The following subcommands are available. -.. _cmd-string-collect: - "collect" subcommand -------------------- @@ -236,9 +232,6 @@ Examples :start-after: BEGIN EXAMPLES :end-before: END EXAMPLES -.. _cmd-string-split: -.. _cmd-string-split0: - "split" and "split0" subcommands -------------------------------- diff --git a/doc_src/cmds/suspend.rst b/doc_src/cmds/suspend.rst index 529beef71..8cbe0f5bf 100644 --- a/doc_src/cmds/suspend.rst +++ b/doc_src/cmds/suspend.rst @@ -1,5 +1,3 @@ -.. _cmd-suspend: - suspend - suspend the current shell =================================== diff --git a/doc_src/cmds/switch.rst b/doc_src/cmds/switch.rst index a52083df3..e540e8829 100644 --- a/doc_src/cmds/switch.rst +++ b/doc_src/cmds/switch.rst @@ -1,5 +1,3 @@ -.. _cmd-switch: - switch - conditionally execute a block of commands ================================================== diff --git a/doc_src/cmds/test.rst b/doc_src/cmds/test.rst index 1e26d2c01..2772aa07b 100644 --- a/doc_src/cmds/test.rst +++ b/doc_src/cmds/test.rst @@ -1,5 +1,3 @@ -.. _cmd-test: - test - perform tests on files and text ====================================== diff --git a/doc_src/cmds/time.rst b/doc_src/cmds/time.rst index bd6db6241..546c995c0 100644 --- a/doc_src/cmds/time.rst +++ b/doc_src/cmds/time.rst @@ -1,5 +1,3 @@ -.. _cmd-time: - time - measure how long a command or block takes ================================================ diff --git a/doc_src/cmds/trap.rst b/doc_src/cmds/trap.rst index 5289c731f..34f61bef2 100644 --- a/doc_src/cmds/trap.rst +++ b/doc_src/cmds/trap.rst @@ -1,5 +1,3 @@ -.. _cmd-trap: - trap - perform an action when the shell receives a signal ========================================================= diff --git a/doc_src/cmds/true.rst b/doc_src/cmds/true.rst index c3a6d515e..05fca7d5c 100644 --- a/doc_src/cmds/true.rst +++ b/doc_src/cmds/true.rst @@ -1,5 +1,3 @@ -.. _cmd-true: - true - return a successful result ================================= diff --git a/doc_src/cmds/type.rst b/doc_src/cmds/type.rst index 0f8c5ba9a..1d09c0b36 100644 --- a/doc_src/cmds/type.rst +++ b/doc_src/cmds/type.rst @@ -1,5 +1,3 @@ -.. _cmd-type: - type - locate a command and describe its type ============================================= diff --git a/doc_src/cmds/ulimit.rst b/doc_src/cmds/ulimit.rst index 2fdedeb69..2102b39b6 100644 --- a/doc_src/cmds/ulimit.rst +++ b/doc_src/cmds/ulimit.rst @@ -1,5 +1,3 @@ -.. _cmd-ulimit: - ulimit - set or get resource usage limits ========================================= diff --git a/doc_src/cmds/umask.rst b/doc_src/cmds/umask.rst index 1e0897dde..74dbe4b0b 100644 --- a/doc_src/cmds/umask.rst +++ b/doc_src/cmds/umask.rst @@ -1,5 +1,3 @@ -.. _cmd-umask: - umask - set or get the file creation mode mask ============================================== diff --git a/doc_src/cmds/vared.rst b/doc_src/cmds/vared.rst index db10c3d96..eb0e420d8 100644 --- a/doc_src/cmds/vared.rst +++ b/doc_src/cmds/vared.rst @@ -1,5 +1,3 @@ -.. _cmd-vared: - vared - interactively edit the value of an environment variable =============================================================== diff --git a/doc_src/cmds/wait.rst b/doc_src/cmds/wait.rst index 215424655..a11405236 100644 --- a/doc_src/cmds/wait.rst +++ b/doc_src/cmds/wait.rst @@ -1,5 +1,3 @@ -.. _cmd-wait: - wait - wait for jobs to complete ================================ diff --git a/doc_src/cmds/while.rst b/doc_src/cmds/while.rst index 09d2e8690..ce9277d1d 100644 --- a/doc_src/cmds/while.rst +++ b/doc_src/cmds/while.rst @@ -1,5 +1,3 @@ -.. _cmd-while: - while - perform a set of commands multiple times ================================================ diff --git a/doc_src/commands.rst b/doc_src/commands.rst index 62438998c..48ecfd476 100644 --- a/doc_src/commands.rst +++ b/doc_src/commands.rst @@ -1,7 +1,5 @@ -.. _commands: - Commands -============ +======== This is a list of all the commands fish ships with. diff --git a/doc_src/completions.rst b/doc_src/completions.rst index 30e79e40d..e4ef2b83c 100644 --- a/doc_src/completions.rst +++ b/doc_src/completions.rst @@ -1,5 +1,3 @@ -.. _completion-own: - Writing your own completions ============================ diff --git a/doc_src/design.rst b/doc_src/design.rst index 3f84c107b..9997bf2bd 100644 --- a/doc_src/design.rst +++ b/doc_src/design.rst @@ -1,5 +1,3 @@ -.. _design: - Design ====== diff --git a/doc_src/faq.rst b/doc_src/faq.rst index 4a1a02434..d5d11d4bd 100644 --- a/doc_src/faq.rst +++ b/doc_src/faq.rst @@ -4,7 +4,7 @@ Frequently asked questions What is the equivalent to this thing from bash (or other shells)? ----------------------------------------------------------------- -See :ref:`Fish for bash users ` +See :doc:`Fish for bash users ` How do I set or clear an environment variable? ---------------------------------------------- diff --git a/doc_src/fish_for_bash_users.rst b/doc_src/fish_for_bash_users.rst index 49b9cb14c..67abcf1ba 100644 --- a/doc_src/fish_for_bash_users.rst +++ b/doc_src/fish_for_bash_users.rst @@ -1,5 +1,3 @@ -.. _fish_for_bash_users: - Fish for bash users =================== diff --git a/doc_src/index.rst b/doc_src/index.rst index 1d1a5a43f..23f95b047 100644 --- a/doc_src/index.rst +++ b/doc_src/index.rst @@ -21,13 +21,13 @@ This page explains how to install and set up fish and where to get more informat Where to go? ============ -If this is your first time using fish, see the :ref:`tutorial `. +If this is your first time using fish, see the :doc:`tutorial `. -If you are already familiar with other shells like bash and want to see the scripting differences, see :ref:`Fish For Bash Users `. +If you are already familiar with other shells like bash and want to see the scripting differences, see :doc:`Fish For Bash Users `. -For an overview of fish's scripting language, see :ref:`The Fish Language `. If it would be useful in a script file, it's here. +For an overview of fish's scripting language, see :doc:`The Fish Language `. If it would be useful in a script file, it's here. -For information on using fish interactively, see :ref:`Interactive use `. If it's about key presses, syntax highlighting or anything else that needs an interactive terminal session, look here. +For information on using fish interactively, see :doc:`Interactive use `. If it's about key presses, syntax highlighting or anything else that needs an interactive terminal session, look here. If you need to install fish first, read on, the rest of this document will tell you how to get, install and configure fish. diff --git a/doc_src/interactive.rst b/doc_src/interactive.rst index 7e745d833..dd079ca5d 100644 --- a/doc_src/interactive.rst +++ b/doc_src/interactive.rst @@ -1,11 +1,9 @@ -.. _interactive: - Interactive use =============== Fish prides itself on being really nice to use interactively. That's down to a few features we'll explain in the next few sections. -Fish is used by giving commands in the fish language, see :ref:`The Fish Language ` for information on that. +Fish is used by giving commands in the fish language, see :doc:`The Fish Language ` for information on that. Help ---- @@ -54,7 +52,7 @@ It also provides a large number of program specific scripted completions. Most o - ``apt``, ``rpm`` and ``yum`` show installed or installable packages -You can also write your own completions or install some you got from someone else. For that, see :ref:`Writing your own completions `. +You can also write your own completions or install some you got from someone else. For that, see :doc:`Writing your own completions `. Completion scripts are loaded on demand, like :ref:`functions are `. The difference is the ``$fish_complete_path`` :ref:`list ` is used instead of ``$fish_function_path``. Typically you can drop new completions in ~/.config/fish/completions/name-of-command.fish and fish will find them automatically. diff --git a/doc_src/language.rst b/doc_src/language.rst index ffafae99c..37c388889 100644 --- a/doc_src/language.rst +++ b/doc_src/language.rst @@ -1,12 +1,9 @@ - -.. _language: - The fish language ================= This document is a comprehensive overview of fish's scripting language. -For interactive features see :ref:`Interactive use `. +For interactive features see :doc:`Interactive use `. .. _syntax: @@ -914,7 +911,7 @@ If there is nothing between a brace and a comma or two commas, it's interpreted To use a "," as an element, :ref:`quote ` or :ref:`escape ` it. -The very first character of a command token is never interpreted as expanding brace, because it's the beginning of a :ref:`compound statement `:: +The very first character of a command token is never interpreted as expanding brace, because it's the beginning of a :doc:`compound statement `:: > {echo hello, && echo world} hello, @@ -1881,7 +1878,7 @@ Fish includes a number of commands in the shell directly. We call these "builtin For a list of all builtins, use ``builtin -n``. -For a list of all builtins, functions and commands shipped with fish, see the :ref:`list of commands `. The documentation is also available by using the ``--help`` switch. +For a list of all builtins, functions and commands shipped with fish, see the :doc:`list of commands `. The documentation is also available by using the ``--help`` switch. Command lookup -------------- diff --git a/doc_src/tutorial.rst b/doc_src/tutorial.rst index c8f3394d0..dad147058 100644 --- a/doc_src/tutorial.rst +++ b/doc_src/tutorial.rst @@ -1,7 +1,5 @@ .. highlight:: fish-docs-samples -.. _tutorial: - Tutorial ======== @@ -39,11 +37,11 @@ This tutorial assumes a basic understanding of command line shells and Unix comm If you have a strong understanding of other shells, and want to know what fish does differently, search for the magic phrase *unlike other shells*, which is used to call out important differences. -Or, if you want a quick overview over the differences to other shells like Bash, see :ref:`Fish For Bash Users `. +Or, if you want a quick overview over the differences to other shells like Bash, see :doc:`Fish For Bash Users `. -For the full, detailed description of how to use fish interactively, see :ref:`Interactive Use `. +For the full, detailed description of how to use fish interactively, see :doc:`Interactive Use `. -For a comprehensive description of fish's scripting language, see :ref:`The Fish Language`. +For a comprehensive description of fish's scripting language, see :doc:`The Fish Language `. Running Commands ---------------- @@ -581,7 +579,7 @@ You can see the source for any function by passing its name to ``functions``:: For more, see :ref:`Functions `. -.. [#] There is a function called :doc:`alias `, but it's just a shortcut to make functions. fish also provides :ref:`abbreviations `, through the :ref:`abbr ` command. +.. [#] There is a function called :doc:`alias `, but it's just a shortcut to make functions. fish also provides :ref:`abbreviations `, through the :doc:`abbr ` command. Loops -----