h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-05-05 13:31:15 -03:00
Code Issues Packages Projects Releases Wiki Activity

Make line length, wrapping and spacing consistent

Browse Source
This commit is contained in:
Mark Griffiths
2014-08-19 13:41:23 +01:00
parent d7308fecbe
commit 137abd0cfa
72 changed files with 807 additions and 1292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
doc_src/complete.txt
View File

@@ -34,62 +34,43 @@ options, the same styles as the GNU version of the getopt
library. These styles are:
- Short options, like '`-a`'. Short options are a single character long, are preceded by a single hyphen and may be grouped together (like '`-la`', which is equivalent to '`-l -a`'). Option arguments may be specified in the following parameter ('`-w 32`') or by appending the option with the value ('`-w32`').
- Old style long options, like '`-Wall`'. Old style long options can be more than one character long, are preceded by a single hyphen and may not be grouped together. Option arguments are specified in the following parameter ('`-ao null`').
- GNU style long options, like '`--colors`'. GNU style long options can be more than one character long, are preceded by two hyphens, and may not be grouped together. Option arguments may be specified in the following parameter ('`--quoting-style`') or by appending the option with a '`=`' and the value ('`--quoting-style=shell`'). GNU style long options may be abbreviated so long as the abbreviation is unique ('`--h`') is equivalent to '`--help`' if help is the only long option beginning with an 'h').
The options for specifying command name, command path, or command
switches may all be used multiple times to specify multiple commands
which have the same completion or multiple switches accepted by a
command.
The options for specifying command name, command path, or command switches may all be used multiple times to specify multiple commands which have the same completion or multiple switches accepted by a command.
The \c -w or \c --wraps options causes the specified command to inherit
completions from another command. The inheriting command is said to
"wrap" the inherited command. The wrapping command may have its own
completions in addition to inherited ones. A command may wrap multiple
commands, and wrapping is transitive: if A wraps B, and B wraps C,
then A automatically inherits all of C's completions. Wrapping can
be removed using the \c -e or \c --erase options.
The `-w` or `--wraps` options causes the specified command to inherit completions from another command. The inheriting command is said to "wrap" the inherited command. The wrapping command may have its own completions in addition to inherited ones. A command may wrap multiple commands, and wrapping is transitive: if A wraps B, and B wraps C, then A automatically inherits all of C's completions. Wrapping can be removed using the `-e` or `--erase` options.
When erasing completions, it is possible to either erase all completions for a specific command by specifying `complete -e -c COMMAND`, or by specifying a specific completion option to delete by specifying either a long, short or old style option.
When erasing completions, it is possible to either erase all
completions for a specific command by specifying `complete -e -c
COMMAND`, or by specifying a specific completion option to delete
by specifying either a long, short or old style option.
\subsection complete-example Example
The short style option `-o` for the `gcc` command requires
that a file follows it. This can be done using writing:
The short style option `-o` for the `gcc` command requires that a file follows it. This can be done using writing:
`complete -c gcc -s o -r`
The short style option `-d` for the `grep` command requires
that one of the strings '`read`', '`skip`' or '`recurse`' is used. This can
be specified writing:
The short style option `-d` for the `grep` command requires that one of the strings '`read`', '`skip`' or '`recurse`' is used. This can be specified writing:
`complete -c grep -s d -x -a "read skip recurse"`
The `su` command takes any username as an argument. Usernames are
given as the first colon-separated field in the file /etc/passwd. This
can be specified as:
The `su` command takes any username as an argument. Usernames are given as the first colon-separated field in the file /etc/passwd. This can be specified as:
`complete -x -c su -d "Username" `
`-a "(cat /etc/passwd | cut -d : -f 1)"`
`complete -x -c su -d "Username" -a "(cat /etc/passwd | cut -d : -f 1)"`
The `rpm` command has several different modes. If the `-e` or `--erase` flag has been specified, `rpm` should delete one or more
packages, in which case several switches related to deleting packages are valid, like the `nodeps` switch.
The `rpm` command has several different modes. If the `-e` or `--erase` flag has been specified, `rpm` should delete one or more packages, in which case several switches related to deleting packages are valid, like the `nodeps` switch.
This can be written as:
`complete -c rpm -n "__fish_contains_opt -s e erase"`
`-l nodeps -d "Don't check dependencies"`
`complete -c rpm -n "__fish_contains_opt -s e erase" -l nodeps -d "Don't check dependencies"`
where `__fish_contains_opt` is a function that checks the commandline
buffer for the presence of a specified set of options.
where `__fish_contains_opt` is a function that checks the commandline buffer for the presence of a specified set of options.
To implement an alias, use the \c -w or \c --wraps option:
<tt>complete -c hub -w git</tt>
Now hub inherits all of the completions from git. Note this can
also be specified in a function declaration.
Now hub inherits all of the completions from git. Note this can also be specified in a function declaration.