mirror of
https://github.com/fish-shell/fish-shell.git
synced 2025-03-15 23:22:53 +08:00
Migrate the 'synopsis' sections to .rst format
This commit is contained in:
ridiculousfish
parent
c213882511
commit
256c2dadee
@ -1,15 +1,14 @@
|
||||
abbr - manage fish abbreviations
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection abbr-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
abbr --add [SCOPE] WORD EXPANSION
|
||||
abbr --erase word
|
||||
abbr --rename [SCOPE] OLD_WORD NEW_WORD
|
||||
abbr --show
|
||||
abbr --list
|
||||
\endfish
|
||||
|
||||
\subsection abbr-description Description
|
||||
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
alias - create a function
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection alias-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
alias
|
||||
alias [OPTIONS] NAME DEFINITION
|
||||
alias [OPTIONS] NAME=DEFINITION
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection alias-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
and - conditionally execute a command
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection and-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
COMMAND1; and COMMAND2
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection and-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
argparse - parse options passed to a fish script or function
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection argparse-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
argparse [OPTIONS] OPTION_SPEC... -- [ARG...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection argparse-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
begin - start a new block of code
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection begin-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
begin; [COMMANDS...;] end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection begin-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
bg - send jobs to background
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection bg-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
bg [PID...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection bg-description Description
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
bind - handle fish key bindings
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection bind-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
bind [(-M | --mode) MODE] [(-m | --sets-mode) NEW_MODE]
|
||||
[--preset | --user]
|
||||
[(-s | --silent)] [(-k | --key)] SEQUENCE COMMAND [COMMAND...]
|
||||
@ -14,7 +14,7 @@ bind (-L | --list-modes)
|
||||
bind (-e | --erase) [(-M | --mode) MODE]
|
||||
[--preset] [--user]
|
||||
(-a | --all | [(-k | --key)] SEQUENCE [SEQUENCE...])
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection bind-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
block - temporarily block delivery of events
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection block-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
block [OPTIONS...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection block-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
break - stop the current inner loop
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection break-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection break-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
breakpoint - Launch debug mode
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection breakpoint-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
breakpoint
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection breakpoint-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
builtin - run a builtin command
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection builtin-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
builtin BUILTINNAME [OPTIONS...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection builtin-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
case - conditionally execute a block of commands
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection case-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection case-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
cd - change directory
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection cd-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
cd [DIRECTORY]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection cd-description Description
|
||||
`cd` changes the current working directory.
|
||||
|
||||
@ -2,10 +2,11 @@ cdh - change to a recently visited directory
|
||||
==========================================
|
||||
|
||||
|
||||
\subsection cdh-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
cdh [ directory ]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection cdh-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
command - run a program
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection command-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
command [OPTIONS] COMMANDNAME [ARGS...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection command-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
commandline - set or get the current command line buffer
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection commandline-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
commandline [OPTIONS] [CMD]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection commandline-description Description
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
complete - edit command specific tab-completions
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection complete-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
complete ( -c | --command | -p | --path ) COMMAND
|
||||
[( -c | --command | -p | --path ) COMMAND]...
|
||||
[( -e | --erase )]
|
||||
@ -18,7 +18,7 @@ complete ( -c | --command | -p | --path ) COMMAND
|
||||
[( -n | --condition ) CONDITION]
|
||||
[( -d | --description ) DESCRIPTION]
|
||||
complete ( -C[STRING] | --do-complete[=STRING] )
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection complete-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
contains - test if a word is present in a list
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection contains-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
contains [OPTIONS] KEY [VALUES...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection contains-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
continue - skip the remainder of the current iteration of the current inner loop
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection continue-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
LOOP_CONSTRUCT; [COMMANDS...;] continue; [COMMANDS...;] end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection continue-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
count - count the number of elements of an array
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection count-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
count $VARIABLE
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection count-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
dirh - print directory history
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection dirh-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
dirh
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection dirh-description Description
|
||||
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
dirs - print directory stack
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection dirs-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
dirs
|
||||
dirs -c
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection dirs-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
disown - remove a process from the list of jobs
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection disown-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
disown [ PID ... ]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection disown-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
echo - display a line of text
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection echo-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
echo [OPTIONS] [STRING]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection echo-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
else - execute command if a condition is not met
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection else-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection else-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
emit - Emit a generic event
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection emit-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
emit EVENT_NAME [ARGUMENTS...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection emit-description Description
|
||||
|
||||
|
||||
@ -1,15 +1,15 @@
|
||||
end - end a block of commands.
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection end-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
begin; [COMMANDS...] end
|
||||
if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end
|
||||
while CONDITION; COMMANDS...; end
|
||||
for VARNAME in [VALUES...]; COMMANDS...; end
|
||||
switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection end-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
eval - evaluate the specified commands
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection eval-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
eval [COMMANDS...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection eval-description Description
|
||||
`eval` evaluates the specified parameters as a command. If more than one parameter is specified, all parameters will be joined using a space character as a separator.
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
exec - execute command in current process
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection exec-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
exec COMMAND [OPTIONS...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection exec-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
exit - exit the shell
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection exit-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
exit [STATUS]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection exit-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
false - return an unsuccessful result
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection false-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
false
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection false-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
fg - bring job to foreground
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection fg-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
fg [PID]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection fg-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
fish - the friendly interactive shell
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection fish-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
fish [OPTIONS] [-c command] [FILE [ARGUMENTS...]]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection fish-description Description
|
||||
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
fish_breakpoint_prompt - define the appearance of the command line prompt when in the context of a `breakpoint` command
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection fish_breakpoint_prompt-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
function fish_breakpoint_prompt
|
||||
...
|
||||
end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection fish_breakpoint_prompt-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
fish_indent - indenter and prettifier
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection fish_indent-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
fish_indent [OPTIONS]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection fish_indent-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
fish_key_reader - explore what characters keyboard keys send
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection fish_key_reader-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
fish_key_reader [OPTIONS]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection fish_key_reader-description Description
|
||||
|
||||
|
||||
@ -2,7 +2,6 @@ fish_mode_prompt - define the appearance of the mode indicator
|
||||
==========================================
|
||||
|
||||
|
||||
\subsection fish_mode_prompt-synopsis Synopsis
|
||||
|
||||
The fish_mode_prompt function will output the mode indicator for use in vi-mode.
|
||||
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
fish_opt - create an option spec for the argparse command
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection fish_opt-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
fish_opt [ -h | --help ]
|
||||
fish_opt ( -s X | --short=X ) [ -l LONG | --long=LONG ] [ --long-only ] \
|
||||
[ -o | --optional-val ] [ -r | --required-val ] [ --multiple-vals ]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection fish_opt-description Description
|
||||
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
fish_prompt - define the appearance of the command line prompt
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection fish_prompt-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
function fish_prompt
|
||||
...
|
||||
end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection fish_prompt-description Description
|
||||
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
fish_right_prompt - define the appearance of the right-side command line prompt
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection fish_right_prompt-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
function fish_right_prompt
|
||||
...
|
||||
end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection fish_right_prompt-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
fish_vi_mode - Enable vi mode
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection fish_vi_mode-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
fish_vi_mode
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection fish_vi_mode-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
for - perform a set of commands multiple times.
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection for-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
for VARNAME in [VALUES...]; COMMANDS...; end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection for-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
funced - edit a function interactively
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection funced-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
funced [OPTIONS] NAME
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection funced-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
funcsave - save the definition of a function to the user's autoload directory
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection funcsave-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
funcsave FUNCTION_NAME
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection funcsave-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
function - create a function
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection function-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
function NAME [OPTIONS]; BODY; end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection function-description Description
|
||||
|
||||
|
||||
@ -1,15 +1,15 @@
|
||||
functions - print or erase functions
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection functions-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
functions [ -a | --all ] [ -n | --names ]
|
||||
functions [ -D | --details ] [ -v ] FUNCTION
|
||||
functions -c OLDNAME NEWNAME
|
||||
functions -d DESCRIPTION FUNCTION
|
||||
functions [ -e | -q ] FUNCTIONS...
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection functions-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
help - display fish documentation
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection help-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
help [SECTION]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection help-description Description
|
||||
|
||||
|
||||
@ -1,16 +1,16 @@
|
||||
history - Show and manipulate command history
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection history-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
history search [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] [ --max=n ] [ --null ] [ -R | --reverse ] [ "search string"... ]
|
||||
history delete [ --show-time ] [ --case-sensitive ] [ --exact | --prefix | --contains ] "search string"...
|
||||
history merge
|
||||
history save
|
||||
history clear
|
||||
history ( -h | --help )
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection history-description Description
|
||||
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
if - conditionally execute a command
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection if-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
if CONDITION; COMMANDS_TRUE...;
|
||||
[else if CONDITION2; COMMANDS_TRUE2...;]
|
||||
[else; COMMANDS_FALSE...;]
|
||||
end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection if-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
isatty - test if a file descriptor is a tty.
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection isatty-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
isatty [FILE DESCRIPTOR]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection isatty-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
jobs - print currently running jobs
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection jobs-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
jobs [OPTIONS] [PID]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection jobs-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
math - Perform mathematics calculations
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection math-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
math [-sN | --scale=N] [--] EXPRESSION
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection math-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
nextd - move forward through directory history
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection nextd-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
nextd [ -l | --list ] [POS]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection nextd-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
not - negate the exit status of a job
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection not-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
not COMMAND [OPTIONS...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection not-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
open - open file in its default application
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection open-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
open FILES...
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection open-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
or - conditionally execute a command
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection or-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
COMMAND1; or COMMAND2
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection or-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
popd - move through directory stack
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection popd-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
popd
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection popd-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
prevd - move backward through directory history
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection prevd-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
prevd [ -l | --list ] [POS]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection prevd-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
printf - display text according to a format string
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection printf-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
printf format [argument...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection printf-description Description
|
||||
printf formats the string FORMAT with ARGUMENT, and displays the result.
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
prompt_pwd - Print pwd suitable for prompt
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection prompt_pwd-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
prompt_pwd
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection prompt_pwd-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
psub - perform process substitution
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection psub-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
COMMAND1 ( COMMAND2 | psub [-F | --fifo] [-f | --file] [-s SUFFIX])
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection psub-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
pushd - push directory to directory stack
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection pushd-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
pushd [DIRECTORY]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection pushd-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
pwd - output the current working directory
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection pwd-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
pwd
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection pwd-description Description
|
||||
|
||||
|
||||
@ -1,15 +1,15 @@
|
||||
random - generate random number
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection random-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
random
|
||||
random SEED
|
||||
random START END
|
||||
random START STEP END
|
||||
random choice [ITEMS...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection random-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
read - read line of input into variables
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection read-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
read [OPTIONS] [VARIABLE ...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection read-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
realpath - Convert a path to an absolute path without symlinks
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection realpath-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
realpath path
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection realpath-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
return - stop the current inner function
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection return-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection return-description Description
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
set - display and change shell variables.
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection set-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
set [SCOPE_OPTIONS]
|
||||
set [OPTIONS] VARIABLE_NAME VALUES...
|
||||
set [OPTIONS] VARIABLE_NAME[INDICES]... VALUES...
|
||||
@ -11,7 +11,7 @@ set ( -q | --query ) [SCOPE_OPTIONS] VARIABLE_NAMES...
|
||||
set ( -e | --erase ) [SCOPE_OPTIONS] VARIABLE_NAME
|
||||
set ( -e | --erase ) [SCOPE_OPTIONS] VARIABLE_NAME[INDICES]...
|
||||
set ( -S | --show ) [SCOPE_OPTIONS] [VARIABLE_NAME]...
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection set-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
set_color - set the terminal color
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection set_color-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
set_color [OPTIONS] VALUE
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection set_color-description Description
|
||||
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
source - evaluate contents of file.
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection source-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
source FILENAME [ARGUMENTS...]
|
||||
somecommand | source
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection source-description Description
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
status - query fish runtime information
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection status-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
status
|
||||
status is-login
|
||||
status is-interactive
|
||||
@ -21,7 +21,7 @@ status stack-trace
|
||||
status job-control CONTROL-TYPE
|
||||
status features
|
||||
status test-feature FEATURE
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection status-description Description
|
||||
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
string - manipulate strings
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection string-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
string escape [(-n | --no-quoted)] [--style=xxx] [STRING...]
|
||||
string join [(-q | --quiet)] SEP [STRING...]
|
||||
string join0 [(-q | --quiet)] [STRING...]
|
||||
@ -25,7 +25,7 @@ string trim [(-l | --left)] [(-r | --right)] [(-c | --chars CHARS)]
|
||||
[(-q | --quiet)] [STRING...]
|
||||
string unescape [--style=xxx] [STRING...]
|
||||
string upper [(-q | --quiet)] [STRING...]
|
||||
\endfish
|
||||
|
||||
|
||||
|
||||
\subsection string-description Description
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
suspend - suspend the current shell
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection suspend-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
suspend [--force]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection suspend-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
switch - conditionally execute a block of commands
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection switch-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection switch-description Description
|
||||
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
test - perform tests on files and text
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection test-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
test [EXPRESSION]
|
||||
[ [EXPRESSION] ]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection test-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
trap - perform an action when the shell receives a signal
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection trap-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
trap [OPTIONS] [[ARG] REASON ... ]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection trap-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
true - return a successful result
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection true-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
true
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection true-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
type - indicate how a command would be interpreted
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection type-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
type [OPTIONS] NAME [NAME ...]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection type-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
ulimit - set or get resource usage limits
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection ulimit-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
ulimit [OPTIONS] [LIMIT]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection ulimit-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
umask - set or get the file creation mode mask
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection umask-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
umask [OPTIONS] [MASK]
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection umask-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
vared - interactively edit the value of an environment variable
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection vared-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
vared VARIABLE_NAME
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection vared-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
wait - wait for jobs to complete
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection wait-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
wait [-n | --any] [PID | PROCESS_NAME] ...
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection wait-description Description
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
while - perform a command multiple times
|
||||
==========================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
\subsection while-synopsis Synopsis
|
||||
\fish{synopsis}
|
||||
while CONDITION; COMMANDS...; end
|
||||
\endfish
|
||||
|
||||
|
||||
\subsection while-description Description
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user