diff --git a/sphinx_doc_src/cmds/abbr.rst b/sphinx_doc_src/cmds/abbr.rst index 6b30925d2..638ad7b93 100644 --- a/sphinx_doc_src/cmds/abbr.rst +++ b/sphinx_doc_src/cmds/abbr.rst @@ -1,3 +1,5 @@ +.. _cmd-abbr: + abbr - manage fish abbreviations ================================ diff --git a/sphinx_doc_src/cmds/alias.rst b/sphinx_doc_src/cmds/alias.rst index ff1e87757..3fd043ed7 100644 --- a/sphinx_doc_src/cmds/alias.rst +++ b/sphinx_doc_src/cmds/alias.rst @@ -1,3 +1,5 @@ +.. _cmd-alias: + alias - create a function ========================= diff --git a/sphinx_doc_src/cmds/and.rst b/sphinx_doc_src/cmds/and.rst index 1b80978ad..4a6b211e3 100644 --- a/sphinx_doc_src/cmds/and.rst +++ b/sphinx_doc_src/cmds/and.rst @@ -1,3 +1,5 @@ +.. _cmd-and: + and - conditionally execute a command ===================================== diff --git a/sphinx_doc_src/cmds/argparse.rst b/sphinx_doc_src/cmds/argparse.rst index d00afa6a7..05a773336 100644 --- a/sphinx_doc_src/cmds/argparse.rst +++ b/sphinx_doc_src/cmds/argparse.rst @@ -1,3 +1,5 @@ +.. _cmd-argparse: + argparse - parse options passed to a fish script or function ============================================================ diff --git a/sphinx_doc_src/cmds/begin.rst b/sphinx_doc_src/cmds/begin.rst index 101d7e89b..b903b7408 100644 --- a/sphinx_doc_src/cmds/begin.rst +++ b/sphinx_doc_src/cmds/begin.rst @@ -1,3 +1,5 @@ +.. _cmd-begin: + begin - start a new block of code ================================= diff --git a/sphinx_doc_src/cmds/bg.rst b/sphinx_doc_src/cmds/bg.rst index fd4aead37..2c5da16fe 100644 --- a/sphinx_doc_src/cmds/bg.rst +++ b/sphinx_doc_src/cmds/bg.rst @@ -1,3 +1,5 @@ +.. _cmd-bg: + bg - send jobs to background ============================ diff --git a/sphinx_doc_src/cmds/bind.rst b/sphinx_doc_src/cmds/bind.rst index ff270cd83..e6a7b0656 100644 --- a/sphinx_doc_src/cmds/bind.rst +++ b/sphinx_doc_src/cmds/bind.rst @@ -1,3 +1,5 @@ +.. _cmd-bind: + bind - handle fish key bindings =============================== diff --git a/sphinx_doc_src/cmds/block.rst b/sphinx_doc_src/cmds/block.rst index e825b6b32..61dee85df 100644 --- a/sphinx_doc_src/cmds/block.rst +++ b/sphinx_doc_src/cmds/block.rst @@ -1,3 +1,5 @@ +.. _cmd-block: + block - temporarily block delivery of events ============================================ diff --git a/sphinx_doc_src/cmds/break.rst b/sphinx_doc_src/cmds/break.rst index 3af73d731..2de9dc959 100644 --- a/sphinx_doc_src/cmds/break.rst +++ b/sphinx_doc_src/cmds/break.rst @@ -1,3 +1,5 @@ +.. _cmd-break: + break - stop the current inner loop =================================== diff --git a/sphinx_doc_src/cmds/breakpoint.rst b/sphinx_doc_src/cmds/breakpoint.rst index e1bca933e..c51d2fa1c 100644 --- a/sphinx_doc_src/cmds/breakpoint.rst +++ b/sphinx_doc_src/cmds/breakpoint.rst @@ -1,3 +1,5 @@ +.. _cmd-breakpoint: + breakpoint - Launch debug mode ============================== diff --git a/sphinx_doc_src/cmds/builtin.rst b/sphinx_doc_src/cmds/builtin.rst index ff6643724..8649961cb 100644 --- a/sphinx_doc_src/cmds/builtin.rst +++ b/sphinx_doc_src/cmds/builtin.rst @@ -1,3 +1,5 @@ +.. _cmd-builtin: + builtin - run a builtin command =============================== diff --git a/sphinx_doc_src/cmds/case.rst b/sphinx_doc_src/cmds/case.rst index 2568f4fd0..a5f0c85ae 100644 --- a/sphinx_doc_src/cmds/case.rst +++ b/sphinx_doc_src/cmds/case.rst @@ -1,3 +1,5 @@ +.. _cmd-case: + case - conditionally execute a block of commands ================================================ diff --git a/sphinx_doc_src/cmds/cd.rst b/sphinx_doc_src/cmds/cd.rst index 5090449e1..8984d1794 100644 --- a/sphinx_doc_src/cmds/cd.rst +++ b/sphinx_doc_src/cmds/cd.rst @@ -1,3 +1,5 @@ +.. _cmd-cd: + cd - change directory ===================== diff --git a/sphinx_doc_src/cmds/cdh.rst b/sphinx_doc_src/cmds/cdh.rst index d013107f1..90ad1df5a 100644 --- a/sphinx_doc_src/cmds/cdh.rst +++ b/sphinx_doc_src/cmds/cdh.rst @@ -1,3 +1,5 @@ +.. _cmd-cdh: + cdh - change to a recently visited directory ============================================ diff --git a/sphinx_doc_src/cmds/command.rst b/sphinx_doc_src/cmds/command.rst index 8fc7c5dc5..69e25c8dd 100644 --- a/sphinx_doc_src/cmds/command.rst +++ b/sphinx_doc_src/cmds/command.rst @@ -1,3 +1,5 @@ +.. _cmd-command: + command - run a program ======================= diff --git a/sphinx_doc_src/cmds/commandline.rst b/sphinx_doc_src/cmds/commandline.rst index 7782c02d2..67e35cb7d 100644 --- a/sphinx_doc_src/cmds/commandline.rst +++ b/sphinx_doc_src/cmds/commandline.rst @@ -1,3 +1,5 @@ +.. _cmd-commandline: + commandline - set or get the current command line buffer ======================================================== diff --git a/sphinx_doc_src/cmds/complete.rst b/sphinx_doc_src/cmds/complete.rst index d1e3f1cec..0f7bdeaa4 100644 --- a/sphinx_doc_src/cmds/complete.rst +++ b/sphinx_doc_src/cmds/complete.rst @@ -1,3 +1,5 @@ +.. _cmd-complete: + complete - edit command specific tab-completions ================================================ diff --git a/sphinx_doc_src/cmds/contains.rst b/sphinx_doc_src/cmds/contains.rst index 081e15fd3..32b0354f4 100644 --- a/sphinx_doc_src/cmds/contains.rst +++ b/sphinx_doc_src/cmds/contains.rst @@ -1,3 +1,5 @@ +.. _cmd-contains: + contains - test if a word is present in a list ============================================== diff --git a/sphinx_doc_src/cmds/continue.rst b/sphinx_doc_src/cmds/continue.rst index b5cac1b57..d31c9e545 100644 --- a/sphinx_doc_src/cmds/continue.rst +++ b/sphinx_doc_src/cmds/continue.rst @@ -1,3 +1,5 @@ +.. _cmd-continue: + continue - skip the remainder of the current iteration of the current inner loop ================================================================================ diff --git a/sphinx_doc_src/cmds/count.rst b/sphinx_doc_src/cmds/count.rst index 981acc915..566c140b0 100644 --- a/sphinx_doc_src/cmds/count.rst +++ b/sphinx_doc_src/cmds/count.rst @@ -1,3 +1,5 @@ +.. _cmd-count: + count - count the number of elements of an array ================================================ diff --git a/sphinx_doc_src/cmds/dirh.rst b/sphinx_doc_src/cmds/dirh.rst index 2b9749521..7dd874b7b 100644 --- a/sphinx_doc_src/cmds/dirh.rst +++ b/sphinx_doc_src/cmds/dirh.rst @@ -1,3 +1,5 @@ +.. _cmd-dirh: + dirh - print directory history ============================== diff --git a/sphinx_doc_src/cmds/dirs.rst b/sphinx_doc_src/cmds/dirs.rst index d888489e4..f5f9440dc 100644 --- a/sphinx_doc_src/cmds/dirs.rst +++ b/sphinx_doc_src/cmds/dirs.rst @@ -1,3 +1,5 @@ +.. _cmd-dirs: + dirs - print directory stack ============================ diff --git a/sphinx_doc_src/cmds/disown.rst b/sphinx_doc_src/cmds/disown.rst index 58d8d9ad3..f423b4563 100644 --- a/sphinx_doc_src/cmds/disown.rst +++ b/sphinx_doc_src/cmds/disown.rst @@ -1,3 +1,5 @@ +.. _cmd-disown: + disown - remove a process from the list of jobs =============================================== diff --git a/sphinx_doc_src/cmds/echo.rst b/sphinx_doc_src/cmds/echo.rst index 065023e3c..003761187 100644 --- a/sphinx_doc_src/cmds/echo.rst +++ b/sphinx_doc_src/cmds/echo.rst @@ -1,3 +1,5 @@ +.. _cmd-echo: + echo - display a line of text ============================= diff --git a/sphinx_doc_src/cmds/else.rst b/sphinx_doc_src/cmds/else.rst index 71523a694..bfda1527e 100644 --- a/sphinx_doc_src/cmds/else.rst +++ b/sphinx_doc_src/cmds/else.rst @@ -1,3 +1,5 @@ +.. _cmd-else: + else - execute command if a condition is not met ================================================ diff --git a/sphinx_doc_src/cmds/emit.rst b/sphinx_doc_src/cmds/emit.rst index 1a5cbc386..85dbc2a5e 100644 --- a/sphinx_doc_src/cmds/emit.rst +++ b/sphinx_doc_src/cmds/emit.rst @@ -1,3 +1,5 @@ +.. _cmd-emit: + emit - Emit a generic event =========================== diff --git a/sphinx_doc_src/cmds/end.rst b/sphinx_doc_src/cmds/end.rst index e1e7b2182..9da25489f 100644 --- a/sphinx_doc_src/cmds/end.rst +++ b/sphinx_doc_src/cmds/end.rst @@ -1,3 +1,5 @@ +.. _cmd-end: + end - end a block of commands. ============================== diff --git a/sphinx_doc_src/cmds/eval.rst b/sphinx_doc_src/cmds/eval.rst index f34dbd767..e3d7d8e5e 100644 --- a/sphinx_doc_src/cmds/eval.rst +++ b/sphinx_doc_src/cmds/eval.rst @@ -1,3 +1,5 @@ +.. _cmd-eval: + eval - evaluate the specified commands ====================================== diff --git a/sphinx_doc_src/cmds/exec.rst b/sphinx_doc_src/cmds/exec.rst index 8acc7d6be..7ad7b422d 100644 --- a/sphinx_doc_src/cmds/exec.rst +++ b/sphinx_doc_src/cmds/exec.rst @@ -1,3 +1,5 @@ +.. _cmd-exec: + exec - execute command in current process ========================================= diff --git a/sphinx_doc_src/cmds/exit.rst b/sphinx_doc_src/cmds/exit.rst index 2f3f75594..e5155c76d 100644 --- a/sphinx_doc_src/cmds/exit.rst +++ b/sphinx_doc_src/cmds/exit.rst @@ -1,3 +1,5 @@ +.. _cmd-exit: + exit - exit the shell ===================== diff --git a/sphinx_doc_src/cmds/false.rst b/sphinx_doc_src/cmds/false.rst index d972f5864..67fd17a22 100644 --- a/sphinx_doc_src/cmds/false.rst +++ b/sphinx_doc_src/cmds/false.rst @@ -1,3 +1,5 @@ +.. _cmd-false: + false - return an unsuccessful result ===================================== diff --git a/sphinx_doc_src/cmds/fg.rst b/sphinx_doc_src/cmds/fg.rst index f5c8a7d73..88a7b1aca 100644 --- a/sphinx_doc_src/cmds/fg.rst +++ b/sphinx_doc_src/cmds/fg.rst @@ -1,3 +1,5 @@ +.. _cmd-fg: + fg - bring job to foreground ============================ diff --git a/sphinx_doc_src/cmds/fish.rst b/sphinx_doc_src/cmds/fish.rst index b3b8a090b..572ed360f 100644 --- a/sphinx_doc_src/cmds/fish.rst +++ b/sphinx_doc_src/cmds/fish.rst @@ -1,3 +1,5 @@ +.. _cmd-fish: + fish - the friendly interactive shell ===================================== diff --git a/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst b/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst index 51cfc020c..1c2722e63 100644 --- a/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst +++ b/sphinx_doc_src/cmds/fish_breakpoint_prompt.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_breakpoint_prompt: + fish_breakpoint_prompt - define the prompt when stopped at a breakpoint ======================================================================= diff --git a/sphinx_doc_src/cmds/fish_config.rst b/sphinx_doc_src/cmds/fish_config.rst index 386797299..7b2c57b76 100644 --- a/sphinx_doc_src/cmds/fish_config.rst +++ b/sphinx_doc_src/cmds/fish_config.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_config: + fish_config - start the web-based configuration interface ========================================================= diff --git a/sphinx_doc_src/cmds/fish_git_prompt.rst b/sphinx_doc_src/cmds/fish_git_prompt.rst index 221feefa8..9a589aa1b 100644 --- a/sphinx_doc_src/cmds/fish_git_prompt.rst +++ b/sphinx_doc_src/cmds/fish_git_prompt.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_git_prompt: + fish_git_prompt - output git information for use in a prompt ============================================================ diff --git a/sphinx_doc_src/cmds/fish_hg_prompt.rst b/sphinx_doc_src/cmds/fish_hg_prompt.rst index 5c8a1a0cb..f0d1d0caa 100644 --- a/sphinx_doc_src/cmds/fish_hg_prompt.rst +++ b/sphinx_doc_src/cmds/fish_hg_prompt.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_hg_prompt: + fish_hg_prompt - output mercurial information for use in a prompt ================================================================= diff --git a/sphinx_doc_src/cmds/fish_indent.rst b/sphinx_doc_src/cmds/fish_indent.rst index 56dd7e798..081265f87 100644 --- a/sphinx_doc_src/cmds/fish_indent.rst +++ b/sphinx_doc_src/cmds/fish_indent.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_indent: + fish_indent - indenter and prettifier ===================================== diff --git a/sphinx_doc_src/cmds/fish_key_reader.rst b/sphinx_doc_src/cmds/fish_key_reader.rst index ea8f4d4c3..265aa6ab3 100644 --- a/sphinx_doc_src/cmds/fish_key_reader.rst +++ b/sphinx_doc_src/cmds/fish_key_reader.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_key_reader: + fish_key_reader - explore what characters keyboard keys send ============================================================ diff --git a/sphinx_doc_src/cmds/fish_mode_prompt.rst b/sphinx_doc_src/cmds/fish_mode_prompt.rst index 88e1cb2e7..83588ec04 100644 --- a/sphinx_doc_src/cmds/fish_mode_prompt.rst +++ b/sphinx_doc_src/cmds/fish_mode_prompt.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_mode_prompt: + fish_mode_prompt - define the appearance of the mode indicator ============================================================== diff --git a/sphinx_doc_src/cmds/fish_opt.rst b/sphinx_doc_src/cmds/fish_opt.rst index dc8639978..35d3222a8 100644 --- a/sphinx_doc_src/cmds/fish_opt.rst +++ b/sphinx_doc_src/cmds/fish_opt.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_opt: + fish_opt - create an option spec for the argparse command ========================================================= diff --git a/sphinx_doc_src/cmds/fish_prompt.rst b/sphinx_doc_src/cmds/fish_prompt.rst index f89edadcd..f11c6036d 100644 --- a/sphinx_doc_src/cmds/fish_prompt.rst +++ b/sphinx_doc_src/cmds/fish_prompt.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_prompt: + fish_prompt - define the appearance of the command line prompt ============================================================== diff --git a/sphinx_doc_src/cmds/fish_right_prompt.rst b/sphinx_doc_src/cmds/fish_right_prompt.rst index 55237d703..c2c66b8a2 100644 --- a/sphinx_doc_src/cmds/fish_right_prompt.rst +++ b/sphinx_doc_src/cmds/fish_right_prompt.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_right_prompt: + fish_right_prompt - define the appearance of the right-side command line prompt =============================================================================== diff --git a/sphinx_doc_src/cmds/fish_svn_prompt.rst b/sphinx_doc_src/cmds/fish_svn_prompt.rst index 5770585f8..f3d450590 100644 --- a/sphinx_doc_src/cmds/fish_svn_prompt.rst +++ b/sphinx_doc_src/cmds/fish_svn_prompt.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_svn_prompt: + fish_svn_prompt - output svn information for use in a prompt ============================================================ diff --git a/sphinx_doc_src/cmds/fish_update_completions.rst b/sphinx_doc_src/cmds/fish_update_completions.rst index b269d56bf..b3f75b585 100644 --- a/sphinx_doc_src/cmds/fish_update_completions.rst +++ b/sphinx_doc_src/cmds/fish_update_completions.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_update_completions: + fish_update_completions - Update completions using manual pages =============================================================== diff --git a/sphinx_doc_src/cmds/fish_vcs_prompt.rst b/sphinx_doc_src/cmds/fish_vcs_prompt.rst index 92a7d72ab..8ab93d32f 100644 --- a/sphinx_doc_src/cmds/fish_vcs_prompt.rst +++ b/sphinx_doc_src/cmds/fish_vcs_prompt.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_vcs_prompt: + fish_vcs_prompt - output vcs information for use in a prompt ============================================================ diff --git a/sphinx_doc_src/cmds/fish_vi_mode.rst b/sphinx_doc_src/cmds/fish_vi_mode.rst index 590538b3b..61d8bb713 100644 --- a/sphinx_doc_src/cmds/fish_vi_mode.rst +++ b/sphinx_doc_src/cmds/fish_vi_mode.rst @@ -1,3 +1,5 @@ +.. _cmd-fish_vi_mode: + fish_vi_mode - Enable vi mode ============================= diff --git a/sphinx_doc_src/cmds/for.rst b/sphinx_doc_src/cmds/for.rst index cfb02bf01..4c06c5912 100644 --- a/sphinx_doc_src/cmds/for.rst +++ b/sphinx_doc_src/cmds/for.rst @@ -1,3 +1,5 @@ +.. _cmd-for: + for - perform a set of commands multiple times. =============================================== diff --git a/sphinx_doc_src/cmds/funced.rst b/sphinx_doc_src/cmds/funced.rst index 2f33c6906..df205b015 100644 --- a/sphinx_doc_src/cmds/funced.rst +++ b/sphinx_doc_src/cmds/funced.rst @@ -1,3 +1,5 @@ +.. _cmd-funced: + funced - edit a function interactively ====================================== diff --git a/sphinx_doc_src/cmds/funcsave.rst b/sphinx_doc_src/cmds/funcsave.rst index fad1550b6..a93f23814 100644 --- a/sphinx_doc_src/cmds/funcsave.rst +++ b/sphinx_doc_src/cmds/funcsave.rst @@ -1,3 +1,5 @@ +.. _cmd-funcsave: + funcsave - save the definition of a function to the user's autoload directory ============================================================================= diff --git a/sphinx_doc_src/cmds/function.rst b/sphinx_doc_src/cmds/function.rst index 093f46ee0..d95e2b357 100644 --- a/sphinx_doc_src/cmds/function.rst +++ b/sphinx_doc_src/cmds/function.rst @@ -1,3 +1,5 @@ +.. _cmd-function: + function - create a function ============================ diff --git a/sphinx_doc_src/cmds/functions.rst b/sphinx_doc_src/cmds/functions.rst index abb1d4398..44bad3035 100644 --- a/sphinx_doc_src/cmds/functions.rst +++ b/sphinx_doc_src/cmds/functions.rst @@ -1,3 +1,5 @@ +.. _cmd-functions: + functions - print or erase functions ==================================== diff --git a/sphinx_doc_src/cmds/help.rst b/sphinx_doc_src/cmds/help.rst index 314f3c0fc..24ea5b75d 100644 --- a/sphinx_doc_src/cmds/help.rst +++ b/sphinx_doc_src/cmds/help.rst @@ -1,3 +1,5 @@ +.. _cmd-help: + help - display fish documentation ================================= diff --git a/sphinx_doc_src/cmds/history.rst b/sphinx_doc_src/cmds/history.rst index 3056f262e..af239e7d1 100644 --- a/sphinx_doc_src/cmds/history.rst +++ b/sphinx_doc_src/cmds/history.rst @@ -1,3 +1,5 @@ +.. _cmd-history: + history - Show and manipulate command history ============================================= diff --git a/sphinx_doc_src/cmds/if.rst b/sphinx_doc_src/cmds/if.rst index ba90693ba..7e5c0fa4c 100644 --- a/sphinx_doc_src/cmds/if.rst +++ b/sphinx_doc_src/cmds/if.rst @@ -1,3 +1,5 @@ +.. _cmd-if: + if - conditionally execute a command ==================================== diff --git a/sphinx_doc_src/cmds/isatty.rst b/sphinx_doc_src/cmds/isatty.rst index 744003049..1d4711c36 100644 --- a/sphinx_doc_src/cmds/isatty.rst +++ b/sphinx_doc_src/cmds/isatty.rst @@ -1,3 +1,5 @@ +.. _cmd-isatty: + isatty - test if a file descriptor is a tty. ============================================ diff --git a/sphinx_doc_src/cmds/jobs.rst b/sphinx_doc_src/cmds/jobs.rst index b2da7b6dc..1c0f435cc 100644 --- a/sphinx_doc_src/cmds/jobs.rst +++ b/sphinx_doc_src/cmds/jobs.rst @@ -1,3 +1,5 @@ +.. _cmd-jobs: + jobs - print currently running jobs =================================== diff --git a/sphinx_doc_src/cmds/math.rst b/sphinx_doc_src/cmds/math.rst index 254055047..b5107ead5 100644 --- a/sphinx_doc_src/cmds/math.rst +++ b/sphinx_doc_src/cmds/math.rst @@ -1,3 +1,5 @@ +.. _cmd-math: + math - Perform mathematics calculations ======================================= diff --git a/sphinx_doc_src/cmds/nextd.rst b/sphinx_doc_src/cmds/nextd.rst index df8e10a05..4bb862b5b 100644 --- a/sphinx_doc_src/cmds/nextd.rst +++ b/sphinx_doc_src/cmds/nextd.rst @@ -1,3 +1,5 @@ +.. _cmd-nextd: + nextd - move forward through directory history ============================================== diff --git a/sphinx_doc_src/cmds/not.rst b/sphinx_doc_src/cmds/not.rst index 524f69605..55931a70b 100644 --- a/sphinx_doc_src/cmds/not.rst +++ b/sphinx_doc_src/cmds/not.rst @@ -1,3 +1,5 @@ +.. _cmd-not: + not - negate the exit status of a job ===================================== diff --git a/sphinx_doc_src/cmds/open.rst b/sphinx_doc_src/cmds/open.rst index b4e5ac63d..092a9f57d 100644 --- a/sphinx_doc_src/cmds/open.rst +++ b/sphinx_doc_src/cmds/open.rst @@ -1,3 +1,5 @@ +.. _cmd-open: + open - open file in its default application =========================================== diff --git a/sphinx_doc_src/cmds/or.rst b/sphinx_doc_src/cmds/or.rst index 258d22158..9d5436139 100644 --- a/sphinx_doc_src/cmds/or.rst +++ b/sphinx_doc_src/cmds/or.rst @@ -1,3 +1,5 @@ +.. _cmd-or: + or - conditionally execute a command ==================================== diff --git a/sphinx_doc_src/cmds/popd.rst b/sphinx_doc_src/cmds/popd.rst index 945912777..772dbb690 100644 --- a/sphinx_doc_src/cmds/popd.rst +++ b/sphinx_doc_src/cmds/popd.rst @@ -1,3 +1,5 @@ +.. _cmd-popd: + popd - move through directory stack =================================== diff --git a/sphinx_doc_src/cmds/prevd.rst b/sphinx_doc_src/cmds/prevd.rst index 10a749803..b96338c51 100644 --- a/sphinx_doc_src/cmds/prevd.rst +++ b/sphinx_doc_src/cmds/prevd.rst @@ -1,3 +1,5 @@ +.. _cmd-prevd: + prevd - move backward through directory history =============================================== diff --git a/sphinx_doc_src/cmds/printf.rst b/sphinx_doc_src/cmds/printf.rst index 6c1717be0..10a4b4821 100644 --- a/sphinx_doc_src/cmds/printf.rst +++ b/sphinx_doc_src/cmds/printf.rst @@ -1,3 +1,5 @@ +.. _cmd-printf: + printf - display text according to a format string ================================================== diff --git a/sphinx_doc_src/cmds/prompt_pwd.rst b/sphinx_doc_src/cmds/prompt_pwd.rst index 3d9ac5b37..5af850c94 100644 --- a/sphinx_doc_src/cmds/prompt_pwd.rst +++ b/sphinx_doc_src/cmds/prompt_pwd.rst @@ -1,3 +1,5 @@ +.. _cmd-prompt_pwd: + prompt_pwd - Print pwd suitable for prompt ========================================== diff --git a/sphinx_doc_src/cmds/psub.rst b/sphinx_doc_src/cmds/psub.rst index f61a183f2..d63edb3d0 100644 --- a/sphinx_doc_src/cmds/psub.rst +++ b/sphinx_doc_src/cmds/psub.rst @@ -1,3 +1,5 @@ +.. _cmd-psub: + psub - perform process substitution =================================== diff --git a/sphinx_doc_src/cmds/pushd.rst b/sphinx_doc_src/cmds/pushd.rst index a524ac93f..82cc1a0bc 100644 --- a/sphinx_doc_src/cmds/pushd.rst +++ b/sphinx_doc_src/cmds/pushd.rst @@ -1,3 +1,5 @@ +.. _cmd-pushd: + pushd - push directory to directory stack ========================================= diff --git a/sphinx_doc_src/cmds/pwd.rst b/sphinx_doc_src/cmds/pwd.rst index 0521514a5..1cf815a0f 100644 --- a/sphinx_doc_src/cmds/pwd.rst +++ b/sphinx_doc_src/cmds/pwd.rst @@ -1,3 +1,5 @@ +.. _cmd-pwd: + pwd - output the current working directory ========================================== diff --git a/sphinx_doc_src/cmds/random.rst b/sphinx_doc_src/cmds/random.rst index 9b5a19ab2..916aae5d0 100644 --- a/sphinx_doc_src/cmds/random.rst +++ b/sphinx_doc_src/cmds/random.rst @@ -1,3 +1,5 @@ +.. _cmd-random: + random - generate random number =============================== diff --git a/sphinx_doc_src/cmds/read.rst b/sphinx_doc_src/cmds/read.rst index a420b5382..0aca5e884 100644 --- a/sphinx_doc_src/cmds/read.rst +++ b/sphinx_doc_src/cmds/read.rst @@ -1,3 +1,5 @@ +.. _cmd-read: + read - read line of input into variables ======================================== diff --git a/sphinx_doc_src/cmds/realpath.rst b/sphinx_doc_src/cmds/realpath.rst index 859c6458b..2fee264de 100644 --- a/sphinx_doc_src/cmds/realpath.rst +++ b/sphinx_doc_src/cmds/realpath.rst @@ -1,3 +1,5 @@ +.. _cmd-realpath: + realpath - Convert a path to an absolute path without symlinks ============================================================== diff --git a/sphinx_doc_src/cmds/return.rst b/sphinx_doc_src/cmds/return.rst index 6de7c1dd7..3ad6cc315 100644 --- a/sphinx_doc_src/cmds/return.rst +++ b/sphinx_doc_src/cmds/return.rst @@ -1,3 +1,5 @@ +.. _cmd-return: + return - stop the current inner function ======================================== diff --git a/sphinx_doc_src/cmds/set.rst b/sphinx_doc_src/cmds/set.rst index dd588c1f8..4e4c2845c 100644 --- a/sphinx_doc_src/cmds/set.rst +++ b/sphinx_doc_src/cmds/set.rst @@ -1,3 +1,5 @@ +.. _cmd-set: + set - display and change shell variables. ========================================= diff --git a/sphinx_doc_src/cmds/set_color.rst b/sphinx_doc_src/cmds/set_color.rst index e616fb58e..b9dc44761 100644 --- a/sphinx_doc_src/cmds/set_color.rst +++ b/sphinx_doc_src/cmds/set_color.rst @@ -1,3 +1,5 @@ +.. _cmd-set_color: + set_color - set the terminal color ================================== diff --git a/sphinx_doc_src/cmds/source.rst b/sphinx_doc_src/cmds/source.rst index 21fd13b2b..2d07e24ce 100644 --- a/sphinx_doc_src/cmds/source.rst +++ b/sphinx_doc_src/cmds/source.rst @@ -1,3 +1,5 @@ +.. _cmd-source: + source - evaluate contents of file. =================================== diff --git a/sphinx_doc_src/cmds/status.rst b/sphinx_doc_src/cmds/status.rst index 397933939..c058e5986 100644 --- a/sphinx_doc_src/cmds/status.rst +++ b/sphinx_doc_src/cmds/status.rst @@ -1,3 +1,5 @@ +.. _cmd-status: + status - query fish runtime information ======================================= diff --git a/sphinx_doc_src/cmds/string.rst b/sphinx_doc_src/cmds/string.rst index 4009588e3..b7fa6752c 100644 --- a/sphinx_doc_src/cmds/string.rst +++ b/sphinx_doc_src/cmds/string.rst @@ -1,3 +1,5 @@ +.. _cmd-string: + string - manipulate strings =========================== diff --git a/sphinx_doc_src/cmds/suspend.rst b/sphinx_doc_src/cmds/suspend.rst index 7e1b92129..5c8c69a47 100644 --- a/sphinx_doc_src/cmds/suspend.rst +++ b/sphinx_doc_src/cmds/suspend.rst @@ -1,3 +1,5 @@ +.. _cmd-suspend: + suspend - suspend the current shell =================================== diff --git a/sphinx_doc_src/cmds/switch.rst b/sphinx_doc_src/cmds/switch.rst index d0a106b2f..3613d68e8 100644 --- a/sphinx_doc_src/cmds/switch.rst +++ b/sphinx_doc_src/cmds/switch.rst @@ -1,3 +1,5 @@ +.. _cmd-switch: + switch - conditionally execute a block of commands ================================================== diff --git a/sphinx_doc_src/cmds/test.rst b/sphinx_doc_src/cmds/test.rst index 834415e32..0c8914398 100644 --- a/sphinx_doc_src/cmds/test.rst +++ b/sphinx_doc_src/cmds/test.rst @@ -1,3 +1,5 @@ +.. _cmd-test: + test - perform tests on files and text ====================================== diff --git a/sphinx_doc_src/cmds/trap.rst b/sphinx_doc_src/cmds/trap.rst index 318fbd1b4..dbe8ce890 100644 --- a/sphinx_doc_src/cmds/trap.rst +++ b/sphinx_doc_src/cmds/trap.rst @@ -1,3 +1,5 @@ +.. _cmd-trap: + trap - perform an action when the shell receives a signal ========================================================= diff --git a/sphinx_doc_src/cmds/true.rst b/sphinx_doc_src/cmds/true.rst index c8607d6ff..c6aa4d889 100644 --- a/sphinx_doc_src/cmds/true.rst +++ b/sphinx_doc_src/cmds/true.rst @@ -1,3 +1,5 @@ +.. _cmd-true: + true - return a successful result ================================= diff --git a/sphinx_doc_src/cmds/type.rst b/sphinx_doc_src/cmds/type.rst index 5f2347084..31e5ccf70 100644 --- a/sphinx_doc_src/cmds/type.rst +++ b/sphinx_doc_src/cmds/type.rst @@ -1,3 +1,5 @@ +.. _cmd-type: + type - indicate how a command would be interpreted ================================================== diff --git a/sphinx_doc_src/cmds/ulimit.rst b/sphinx_doc_src/cmds/ulimit.rst index 846e06993..ce03ba10e 100644 --- a/sphinx_doc_src/cmds/ulimit.rst +++ b/sphinx_doc_src/cmds/ulimit.rst @@ -1,3 +1,5 @@ +.. _cmd-ulimit: + ulimit - set or get resource usage limits ========================================= diff --git a/sphinx_doc_src/cmds/umask.rst b/sphinx_doc_src/cmds/umask.rst index ff18bfac2..bafbca7aa 100644 --- a/sphinx_doc_src/cmds/umask.rst +++ b/sphinx_doc_src/cmds/umask.rst @@ -1,3 +1,5 @@ +.. _cmd-umask: + umask - set or get the file creation mode mask ============================================== diff --git a/sphinx_doc_src/cmds/vared.rst b/sphinx_doc_src/cmds/vared.rst index 2fb29bf98..aec694ab6 100644 --- a/sphinx_doc_src/cmds/vared.rst +++ b/sphinx_doc_src/cmds/vared.rst @@ -1,3 +1,5 @@ +.. _cmd-vared: + vared - interactively edit the value of an environment variable =============================================================== diff --git a/sphinx_doc_src/cmds/wait.rst b/sphinx_doc_src/cmds/wait.rst index 763d42191..6268d616b 100644 --- a/sphinx_doc_src/cmds/wait.rst +++ b/sphinx_doc_src/cmds/wait.rst @@ -1,3 +1,5 @@ +.. _cmd-wait: + wait - wait for jobs to complete ================================ diff --git a/sphinx_doc_src/cmds/while.rst b/sphinx_doc_src/cmds/while.rst index ccc022857..0bc41f9d8 100644 --- a/sphinx_doc_src/cmds/while.rst +++ b/sphinx_doc_src/cmds/while.rst @@ -1,3 +1,5 @@ +.. _cmd-while: + while - perform a command multiple times ======================================== diff --git a/sphinx_doc_src/conf.py b/sphinx_doc_src/conf.py index 52a49debb..edf1b4a29 100644 --- a/sphinx_doc_src/conf.py +++ b/sphinx_doc_src/conf.py @@ -144,14 +144,15 @@ latex_documents = [ # -- Options for manual page output ------------------------------------------ -def get_command_description(path): - """ Return the description for a command, by parsing its first line """ +def get_command_description(path, name): + """ Return the description for a command, by parsing its synopsis line """ with open(path) as fd: - title = fd.readline() - if ' - ' not in title: - raise SphinxWarning('No description in file %s' % os.path.basename(path)) - _, desc = title.split(' - ', 1) - return desc.strip() + for line in fd: + if line.startswith(name + " - "): + _, desc = line.split(' - ', 1) + return desc.strip() + raise SphinxWarning('No description in file %s' % os.path.basename(path)) + # One entry per manual page. List of tuples @@ -163,7 +164,7 @@ man_pages = [ for path in sorted(glob.glob('cmds/*')): docname = strip_ext(path) cmd = os.path.basename(docname) - man_pages.append((docname, cmd, get_command_description(path), '', 1)) + man_pages.append((docname, cmd, get_command_description(path, cmd), '', 1)) # -- Options for Texinfo output ----------------------------------------------