Switch command docs from \section to reStructuredText

This commit is contained in:
ridiculousfish 2018-12-16 17:39:33 -08:00
parent afd035f8cc
commit c213882511
85 changed files with 255 additions and 85 deletions

View file

@ -1,4 +1,6 @@
\section abbr abbr - manage fish abbreviations
abbr - manage fish abbreviations
==========================================
\subsection abbr-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section alias alias - create a function
alias - create a function
==========================================
\subsection alias-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section and and - conditionally execute a command
and - conditionally execute a command
==========================================
\subsection and-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section argparse argparse - parse options passed to a fish script or function
argparse - parse options passed to a fish script or function
==========================================
\subsection argparse-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section begin begin - start a new block of code
begin - start a new block of code
==========================================
\subsection begin-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section bg bg - send jobs to background
bg - send jobs to background
==========================================
\subsection bg-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section bind bind - handle fish key bindings
bind - handle fish key bindings
==========================================
\subsection bind-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section block block - temporarily block delivery of events
block - temporarily block delivery of events
==========================================
\subsection block-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section break break - stop the current inner loop
break - stop the current inner loop
==========================================
\subsection break-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section breakpoint breakpoint - Launch debug mode
breakpoint - Launch debug mode
==========================================
\subsection breakpoint-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section builtin builtin - run a builtin command
builtin - run a builtin command
==========================================
\subsection builtin-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section case case - conditionally execute a block of commands
case - conditionally execute a block of commands
==========================================
\subsection case-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section cd cd - change directory
cd - change directory
==========================================
\subsection cd-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section cdh cdh - change to a recently visited directory
cdh - change to a recently visited directory
==========================================
\subsection cdh-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section command command - run a program
command - run a program
==========================================
\subsection command-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section commandline commandline - set or get the current command line buffer
commandline - set or get the current command line buffer
==========================================
\subsection commandline-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section complete complete - edit command specific tab-completions
complete - edit command specific tab-completions
==========================================
\subsection complete-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section contains contains - test if a word is present in a list
contains - test if a word is present in a list
==========================================
\subsection contains-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section continue continue - skip the remainder of the current iteration of the current inner loop
continue - skip the remainder of the current iteration of the current inner loop
==========================================
\subsection continue-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section count count - count the number of elements of an array
count - count the number of elements of an array
==========================================
\subsection count-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section dirh dirh - print directory history
dirh - print directory history
==========================================
\subsection dirh-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section dirs dirs - print directory stack
dirs - print directory stack
==========================================
\subsection dirs-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section disown disown - remove a process from the list of jobs
disown - remove a process from the list of jobs
==========================================
\subsection disown-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section echo echo - display a line of text
echo - display a line of text
==========================================
\subsection echo-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section else else - execute command if a condition is not met
else - execute command if a condition is not met
==========================================
\subsection else-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section emit emit - Emit a generic event
emit - Emit a generic event
==========================================
\subsection emit-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section end end - end a block of commands.
end - end a block of commands.
==========================================
\subsection end-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section eval eval - evaluate the specified commands
eval - evaluate the specified commands
==========================================
\subsection eval-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section exec exec - execute command in current process
exec - execute command in current process
==========================================
\subsection exec-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section exit exit - exit the shell
exit - exit the shell
==========================================
\subsection exit-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section false false - return an unsuccessful result
false - return an unsuccessful result
==========================================
\subsection false-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section fg fg - bring job to foreground
fg - bring job to foreground
==========================================
\subsection fg-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section fish fish - the friendly interactive shell
fish - the friendly interactive shell
==========================================
\subsection fish-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section fish_breakpoint_prompt fish_breakpoint_prompt - define the appearance of the command line prompt when in the context of a `breakpoint` command
fish_breakpoint_prompt - define the appearance of the command line prompt when in the context of a `breakpoint` command
==========================================
\subsection fish_breakpoint_prompt-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section fish_config fish_config - start the web-based configuration interface
fish_config - start the web-based configuration interface
==========================================
\subsection fish_config-description Description

View file

@ -1,4 +1,6 @@
\section fish_indent fish_indent - indenter and prettifier
fish_indent - indenter and prettifier
==========================================
\subsection fish_indent-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section fish_key_reader fish_key_reader - explore what characters keyboard keys send
fish_key_reader - explore what characters keyboard keys send
==========================================
\subsection fish_key_reader-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section fish_mode_prompt fish_mode_prompt - define the appearance of the mode indicator
fish_mode_prompt - define the appearance of the mode indicator
==========================================
\subsection fish_mode_prompt-synopsis Synopsis

View file

@ -1,4 +1,6 @@
\section fish_opt fish_opt - create an option spec for the argparse command
fish_opt - create an option spec for the argparse command
==========================================
\subsection fish_opt-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section fish_prompt fish_prompt - define the appearance of the command line prompt
fish_prompt - define the appearance of the command line prompt
==========================================
\subsection fish_prompt-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section fish_right_prompt fish_right_prompt - define the appearance of the right-side command line prompt
fish_right_prompt - define the appearance of the right-side command line prompt
==========================================
\subsection fish_right_prompt-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section fish_update_completions fish_update_completions - Update completions using manual pages
fish_update_completions - Update completions using manual pages
==========================================
\subsection fish_update_completions-description Description

View file

@ -1,4 +1,6 @@
\section fish_vi_mode fish_vi_mode - Enable vi mode
fish_vi_mode - Enable vi mode
==========================================
\subsection fish_vi_mode-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section for for - perform a set of commands multiple times.
for - perform a set of commands multiple times.
==========================================
\subsection for-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section funced funced - edit a function interactively
funced - edit a function interactively
==========================================
\subsection funced-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section funcsave funcsave - save the definition of a function to the user's autoload directory
funcsave - save the definition of a function to the user's autoload directory
==========================================
\subsection funcsave-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section function function - create a function
function - create a function
==========================================
\subsection function-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section functions functions - print or erase functions
functions - print or erase functions
==========================================
\subsection functions-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section help help - display fish documentation
help - display fish documentation
==========================================
\subsection help-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section history history - Show and manipulate command history
history - Show and manipulate command history
==========================================
\subsection history-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section if if - conditionally execute a command
if - conditionally execute a command
==========================================
\subsection if-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section isatty isatty - test if a file descriptor is a tty.
isatty - test if a file descriptor is a tty.
==========================================
\subsection isatty-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section jobs jobs - print currently running jobs
jobs - print currently running jobs
==========================================
\subsection jobs-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section math math - Perform mathematics calculations
math - Perform mathematics calculations
==========================================
\subsection math-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section nextd nextd - move forward through directory history
nextd - move forward through directory history
==========================================
\subsection nextd-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section not not - negate the exit status of a job
not - negate the exit status of a job
==========================================
\subsection not-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section open open - open file in its default application
open - open file in its default application
==========================================
\subsection open-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section or or - conditionally execute a command
or - conditionally execute a command
==========================================
\subsection or-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section popd popd - move through directory stack
popd - move through directory stack
==========================================
\subsection popd-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section prevd prevd - move backward through directory history
prevd - move backward through directory history
==========================================
\subsection prevd-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section printf printf - display text according to a format string
printf - display text according to a format string
==========================================
\subsection printf-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section prompt_pwd prompt_pwd - Print pwd suitable for prompt
prompt_pwd - Print pwd suitable for prompt
==========================================
\subsection prompt_pwd-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section psub psub - perform process substitution
psub - perform process substitution
==========================================
\subsection psub-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section pushd pushd - push directory to directory stack
pushd - push directory to directory stack
==========================================
\subsection pushd-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section pwd pwd - output the current working directory
pwd - output the current working directory
==========================================
\subsection pwd-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section random random - generate random number
random - generate random number
==========================================
\subsection random-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section read read - read line of input into variables
read - read line of input into variables
==========================================
\subsection read-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section realpath realpath - Convert a path to an absolute path without symlinks
realpath - Convert a path to an absolute path without symlinks
==========================================
\subsection realpath-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section return return - stop the current inner function
return - stop the current inner function
==========================================
\subsection return-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section set set - display and change shell variables.
set - display and change shell variables.
==========================================
\subsection set-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section set_color set_color - set the terminal color
set_color - set the terminal color
==========================================
\subsection set_color-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section source source - evaluate contents of file.
source - evaluate contents of file.
==========================================
\subsection source-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section status status - query fish runtime information
status - query fish runtime information
==========================================
\subsection status-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section string string - manipulate strings
string - manipulate strings
==========================================
\subsection string-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section suspend suspend - suspend the current shell
suspend - suspend the current shell
==========================================
\subsection suspend-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section switch switch - conditionally execute a block of commands
switch - conditionally execute a block of commands
==========================================
\subsection switch-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section test test - perform tests on files and text
test - perform tests on files and text
==========================================
\subsection test-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section trap trap - perform an action when the shell receives a signal
trap - perform an action when the shell receives a signal
==========================================
\subsection trap-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section true true - return a successful result
true - return a successful result
==========================================
\subsection true-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section type type - indicate how a command would be interpreted
type - indicate how a command would be interpreted
==========================================
\subsection type-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section ulimit ulimit - set or get resource usage limits
ulimit - set or get resource usage limits
==========================================
\subsection ulimit-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section umask umask - set or get the file creation mode mask
umask - set or get the file creation mode mask
==========================================
\subsection umask-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section vared vared - interactively edit the value of an environment variable
vared - interactively edit the value of an environment variable
==========================================
\subsection vared-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section wait wait - wait for jobs to complete
wait - wait for jobs to complete
==========================================
\subsection wait-synopsis Synopsis
\fish{synopsis}

View file

@ -1,4 +1,6 @@
\section while while - perform a command multiple times
while - perform a command multiple times
==========================================
\subsection while-synopsis Synopsis
\fish{synopsis}