diff options
70 files changed, 80 insertions, 135 deletions
diff --git a/Doxyfile.help b/Doxyfile.help index 1c34667c..beda7bbb 100644 --- a/Doxyfile.help +++ b/Doxyfile.help @@ -244,6 +244,7 @@ ALIASES += "blah{1}=\1" ALIASES += "cmnd{1}=\1" ALIASES += "func{1}=\1" ALIASES += "sbin{1}=\1" +ALIASES += "args{1}=\1" ALIASES += "opts{1}=\1" ALIASES += "vars{1}=\1" ALIASES += "optr{1}=\1" diff --git a/Doxyfile.user b/Doxyfile.user index f877c3b7..3f5f6149 100644 --- a/Doxyfile.user +++ b/Doxyfile.user @@ -244,6 +244,7 @@ ALIASES += "blah{1}=<span class=\"comment\">\1</span>" ALIASES += "cmnd{1}=<span class=\"command\">\1</span>" ALIASES += "func{1}=<span class=\"function\">\1</span>" ALIASES += "sbin{1}=<span class=\"binary\">\1</span>" +ALIASES += "args{1}=<span class=\"argument\">\1</span>" ALIASES += "opts{1}=<span class=\"argument\">\1</span>" ALIASES += "vars{1}=<span class=\"variable\">\1</span>" ALIASES += "optr{1}=<span class=\"operator\">\1</span>" diff --git a/Makefile.in b/Makefile.in index c8467092..ca4a33ab 100644 --- a/Makefile.in +++ b/Makefile.in @@ -367,14 +367,7 @@ lexicon.txt: doc_src/commands.hdr $(FUNCTIONS_DIR_FILES) $(COMPLETIONS_DIR_FILES -e 'w lexicon_catalog.tmp' \ -e "s|'\(.*\)'|func \1|p"; \ sed <share/functions/__fish_config_interactive.fish >>lexicon.tmp -n \ - -e '/set_default/s/.*\(fish_[a-z][a-z_]*\).*$$/clrv \1/p' \ - -e '$$G;s/.*\n/==end==/p'; \ - sed <share/functions/__fish_config_interactive.fish >>lexicon.tmp -n \ - -e '1G;s/.*\n/==styles==/p' \ - -e '/set_default/s/.*fish_color\(_[a-z][a-z_]*\)/style\1/' \ - -e '/^style_/s/_\([^ ]*\) --\([^ ]*\).*$$/ \1 \2/p' \ - -e '/^style_/s/_\([^ ]* [^- ]*\) --\([^ ]*\).*$$/ \1 \2/p' \ - -e '/^style_/s/_\([^ ]* [^- ]*\).*$$/ \1/p'; \ + -e '/set_default/s/.*\(fish_[a-z][a-z_]*\).*$$/clrv \1/p'; \ mv lexicon.tmp lexicon.txt; rm -f lexicon_catalog.tmp lexicon_catalog.txt; # @@ -395,11 +388,7 @@ doc_src/fish_lexicon_filter: lexicon.txt doc_src/fish_lexicon_filter.in sed <$@.in >$@.tmp -e 's|@sed@|'"`command -v sed`"'|' -e '/^[ ]*#[^!]/d' # Scan through the lexicon, transforming each line to something usefue to Doxygen. sed <lexicon.txt >>$@.tmp -n \ - -e 's|^\([a-z][a-z][a-z][a-z]\) \([a-z_-]*\)$$|s,[[:<:]]\2[[:>:]],@\1{\2},g|p' \ - -e '/==end==/G;s/.*\n/b tidy/p' \ - -e '/==styles==/G;s/.*\n/:styles/p' \ - -e 's|^\(style [^ ]*\) \(.*\)$$|s,\1,\2,|p' \ - -e '$$G;s/.*\n/b processstyle/p'; \ + -e 's|^\([a-z][a-z][a-z][a-z]\) \([a-z_-]*\)$$|s,[[:<:]]\2[[:>:]],@\1{\2},g|p'; mv $@.tmp $@; if test -x $@; then true; else chmod a+x $@; fi # @@ -821,7 +810,7 @@ clean: rm -f $(PROGRAMS) fish_tests key_reader rm -f command_list.txt command_list_toc.txt toc.txt rm -f doc_src/index.hdr doc_src/commands.hdr - rm -f doc_src/fish_lexicon_filter lexicon.txt doc_src/user_doc.css + rm -f doc_src/fish_lexicon_filter lexicon.txt rm -f FISH-BUILD-VERSION-FILE if test "$(HAVE_DOXYGEN)" = 1; then \ rm -rf doc user_doc share/man; \ diff --git a/doc_src/alias.txt b/doc_src/alias.txt index cc8b7fdc..c1450cc4 100644 --- a/doc_src/alias.txt +++ b/doc_src/alias.txt @@ -1,7 +1,7 @@ \section alias alias - create a function \subsection alias-synopsis Synopsis -\fish{syn} +\fish{synopsis} alias NAME DEFINITION alias NAME=DEFINITION \endfish diff --git a/doc_src/and.txt b/doc_src/and.txt index de5bb1eb..9d71d67c 100644 --- a/doc_src/and.txt +++ b/doc_src/and.txt @@ -1,7 +1,7 @@ \section and and - conditionally execute a command \subsection and-synopsis Synopsis -\fish{syn} +\fish{synopsis} COMMAND1; and COMMAND2 \endfish diff --git a/doc_src/begin.txt b/doc_src/begin.txt index aee50f5c..6807fac4 100644 --- a/doc_src/begin.txt +++ b/doc_src/begin.txt @@ -1,7 +1,7 @@ \section begin begin - start a new block of code \subsection begin-synopsis Synopsis -\fish{syn} +\fish{synopsis} begin; [COMMANDS...;] end \endfish diff --git a/doc_src/bg.txt b/doc_src/bg.txt index 403f2e4a..d05bf54d 100644 --- a/doc_src/bg.txt +++ b/doc_src/bg.txt @@ -1,7 +1,7 @@ \section bg bg - send jobs to background \subsection bg-synopsis Synopsis -\fish{syn} +\fish{synopsis} bg [PID...] \endfish diff --git a/doc_src/bind.txt b/doc_src/bind.txt index 442d7e99..9607c8b0 100644 --- a/doc_src/bind.txt +++ b/doc_src/bind.txt @@ -1,7 +1,7 @@ \section bind bind - handle fish key bindings \subsection bind-synopsis Synopsis -\fish{syn} +\fish{synopsis} bind [OPTIONS] SEQUENCE COMMAND \endfish diff --git a/doc_src/block.txt b/doc_src/block.txt index 19ccb29b..f3f741f1 100644 --- a/doc_src/block.txt +++ b/doc_src/block.txt @@ -1,7 +1,7 @@ \section block block - temporarily block delivery of events \subsection block-synopsis Synopsis -\fish{syn} +\fish{synopsis} block [OPTIONS...] \endfish diff --git a/doc_src/break.txt b/doc_src/break.txt index 3109fe9c..2056b054 100644 --- a/doc_src/break.txt +++ b/doc_src/break.txt @@ -1,7 +1,7 @@ \section break break - stop the current inner loop \subsection break-synopsis Synopsis -\fish{syn} +\fish{synopsis} LOOP_CONSTRUCT; [COMMANDS...] break; [COMMANDS...] end \endfish diff --git a/doc_src/breakpoint.txt b/doc_src/breakpoint.txt index bff8fc5a..348c779d 100644 --- a/doc_src/breakpoint.txt +++ b/doc_src/breakpoint.txt @@ -1,7 +1,7 @@ \section breakpoint breakpoint - Launch debug mode \subsection breakpoint-synopsis Synopsis -\fish{syn} +\fish{synopsis} breakpoint \endfish diff --git a/doc_src/builtin.txt b/doc_src/builtin.txt index 8f480b47..2d915fc3 100644 --- a/doc_src/builtin.txt +++ b/doc_src/builtin.txt @@ -1,7 +1,7 @@ \section builtin builtin - run a builtin command \subsection builtin-synopsis Synopsis -\fish{syn} +\fish{synopsis} builtin BUILTINNAME [OPTIONS...] \endfish diff --git a/doc_src/case.txt b/doc_src/case.txt index aab24d53..b0500650 100644 --- a/doc_src/case.txt +++ b/doc_src/case.txt @@ -1,7 +1,7 @@ \section case case - conditionally execute a block of commands \subsection case-synopsis Synopsis -\fish{syn} +\fish{synopsis} switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end \endfish diff --git a/doc_src/cd.txt b/doc_src/cd.txt index 968333f3..200d9767 100644 --- a/doc_src/cd.txt +++ b/doc_src/cd.txt @@ -1,7 +1,7 @@ \section cd cd - change directory \subsection cd-synopsis Synopsis -\fish{syn} +\fish{synopsis} cd [DIRECTORY] \endfish diff --git a/doc_src/commandline.txt b/doc_src/commandline.txt index c61b51da..b3eaba5a 100644 --- a/doc_src/commandline.txt +++ b/doc_src/commandline.txt @@ -1,7 +1,7 @@ \section commandline commandline - set or get the current command line buffer \subsection commandline-synopsis Synopsis -\fish{syn} +\fish{synopsis} commandline [OPTIONS] [CMD] \endfish diff --git a/doc_src/contains.txt b/doc_src/contains.txt index 3671c8a3..2ec6e092 100644 --- a/doc_src/contains.txt +++ b/doc_src/contains.txt @@ -1,7 +1,7 @@ \section contains contains - test if a word is present in a list \subsection contains-synopsis Synopsis -\fish{syn} +\fish{synopsis} contains [OPTIONS] KEY [VALUES...] \endfish diff --git a/doc_src/continue.txt b/doc_src/continue.txt index e79c8f35..cb92c9cf 100644 --- a/doc_src/continue.txt +++ b/doc_src/continue.txt @@ -1,7 +1,7 @@ \section continue continue - skip the remainder of the current iteration of the current inner loop \subsection continue-synopsis Synopsis -\fish{syn} +\fish{synopsis} LOOP_CONSTRUCT; [COMMANDS...;] continue; [COMMANDS...;] end \endfish diff --git a/doc_src/count.txt b/doc_src/count.txt index 1af00e00..bf66d207 100644 --- a/doc_src/count.txt +++ b/doc_src/count.txt @@ -1,7 +1,7 @@ \section count count - count the number of elements of an array \subsection count-synopsis Synopsis -\fish{syn} +\fish{synopsis} count $VARIABLE \endfish diff --git a/doc_src/dirh.txt b/doc_src/dirh.txt index 38160b86..00bd581f 100644 --- a/doc_src/dirh.txt +++ b/doc_src/dirh.txt @@ -1,7 +1,7 @@ \section dirh dirh - print directory history \subsection dirh-synopsis Synopsis -\fish{syn} +\fish{synopsis} dirh \endfish diff --git a/doc_src/dirs.txt b/doc_src/dirs.txt index f8744071..c15834c5 100644 --- a/doc_src/dirs.txt +++ b/doc_src/dirs.txt @@ -1,7 +1,7 @@ \section dirs dirs - print directory stack \subsection dirs-synopsis Synopsis -\fish{syn} +\fish{synopsis} dirs \endfish diff --git a/doc_src/echo.txt b/doc_src/echo.txt index edb3c963..4ce96cb4 100644 --- a/doc_src/echo.txt +++ b/doc_src/echo.txt @@ -1,7 +1,7 @@ \section echo echo - display a line of text \subsection echo-synopsis Synopsis -\fish{syn} +\fish{synopsis} echo [STRING] \endfish diff --git a/doc_src/else.txt b/doc_src/else.txt index 069a13bd..a22cfcdb 100644 --- a/doc_src/else.txt +++ b/doc_src/else.txt @@ -1,7 +1,7 @@ \section else else - execute command if a condition is not met \subsection else-synopsis Synopsis -\fish{syn} +\fish{synopsis} if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end \endfish diff --git a/doc_src/emit.txt b/doc_src/emit.txt index cfcc107f..d8f17b45 100644 --- a/doc_src/emit.txt +++ b/doc_src/emit.txt @@ -1,7 +1,7 @@ \section emit emit - Emit a generic event \subsection emit-synopsis Synopsis -\fish{syn} +\fish{synopsis} emit EVENT_NAME [ARGUMENTS...] \endfish diff --git a/doc_src/end.txt b/doc_src/end.txt index be971e95..aca29495 100644 --- a/doc_src/end.txt +++ b/doc_src/end.txt @@ -1,7 +1,7 @@ \section end end - end a block of commands. \subsection end-synopsis Synopsis -\fish{syn} +\fish{synopsis} begin; [COMMANDS...] end if CONDITION; COMMANDS_TRUE...; [else; COMMANDS_FALSE...;] end while CONDITION; COMMANDS...; end diff --git a/doc_src/eval.txt b/doc_src/eval.txt index 22f92164..c966b576 100644 --- a/doc_src/eval.txt +++ b/doc_src/eval.txt @@ -1,7 +1,7 @@ \section eval eval - evaluate the specified commands \subsection eval-synopsis Synopsis -\fish{syn} +\fish{synopsis} eval [COMMANDS...] \endfish diff --git a/doc_src/exec.txt b/doc_src/exec.txt index 75effda1..4bcd3999 100644 --- a/doc_src/exec.txt +++ b/doc_src/exec.txt @@ -1,7 +1,7 @@ \section exec exec - execute command in current process \subsection exec-synopsis Synopsis -\fish{syn} +\fish{synopsis} exec COMMAND [OPTIONS...] \endfish diff --git a/doc_src/exit.txt b/doc_src/exit.txt index ae607a4c..fcec4b92 100644 --- a/doc_src/exit.txt +++ b/doc_src/exit.txt @@ -1,7 +1,7 @@ \section exit exit - exit the shell \subsection exit-synopsis Synopsis -\fish{syn} +\fish{synopsis} exit [STATUS] \endfish diff --git a/doc_src/fg.txt b/doc_src/fg.txt index 0e45df04..e9f23bc5 100644 --- a/doc_src/fg.txt +++ b/doc_src/fg.txt @@ -1,7 +1,7 @@ \section fg fg - bring job to foreground \subsection fg-synopsis Synopsis -\fish{syn} +\fish{synopsis} fg [PID] \endfish diff --git a/doc_src/fish.txt b/doc_src/fish.txt index 27235f57..80e7e4e5 100644 --- a/doc_src/fish.txt +++ b/doc_src/fish.txt @@ -1,7 +1,7 @@ \section fish fish - the friendly interactive shell \subsection fish-synopsis Synopsis -\fish{syn} +\fish{synopsis} fish [-h] [-v] [-c command] [FILE [ARGUMENTS...]] \endfish diff --git a/doc_src/fish_indent.txt b/doc_src/fish_indent.txt index 761134ec..51cb5fa6 100644 --- a/doc_src/fish_indent.txt +++ b/doc_src/fish_indent.txt @@ -1,7 +1,7 @@ \section fish_indent fish_indent - indenter and prettifier \subsection fish_indent-synopsis Synopsis -\fish{syn} +\fish{synopsis} fish_indent [options] \endfish diff --git a/doc_src/fish_lexicon_filter.in b/doc_src/fish_lexicon_filter.in index 60cde9be..47ee345e 100644 --- a/doc_src/fish_lexicon_filter.in +++ b/doc_src/fish_lexicon_filter.in @@ -57,53 +57,10 @@ # End block /\\endfish/b } -/style/b styles #. # This is not the pattern we're looking for b #. -# Sets CSS styles according to fish defaults. -#. -# Used for building the documentation's CSS file -#. -:processstyle -#. Make Hex uniform -s/0x//g -/[0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F]*/ { - y/ABCDEF/abcdef/ - s/^[0-9a-f]/#&/ -} -#. -# Set simple styles -#. -s/bold/font-weight:bold;/ -#. -# Replace named colours (taken from color.cpp) -#. -s/black/#000/ -s/red/#f00/ -s/green/#0f0/ -s/brown/#725000/ -s/yellow/#ff0/ -s/blue/#00f/ -s/magenta/#f0f/ -s/purple/#f0f/ -s/cyan/#0ff/ -s/white/#fff/ -s/normal/#fff text-decoration:none; border-bottom:none; font-weight:normal;/ -#. -/background/ { - s/background=\(#[0-9a-f][0-9a-f][0-9a-f][0-9a-f]*\)/background-color: \1;/ -} -/underline/ { - s/^\(#[0-9a-f][0-9a-f][0-9a-f][0-9a-f]*\).*$/\1 border-bottom: 2px solid \1;/ - s/^underline$/text-decoration: underline;/ -} -# If we start with just a colour, make it explicit. -s/^#[0-9a-f][0-9a-f]*/color: &;/ -#. -# All done, return CSS style content -b # Process any HTML tags. # Structured to reduce sed's greediness. :html @@ -204,7 +161,7 @@ s/-\([A-Za-z]\)\([^A-Za-z}]\)/\\\ \2/g #. # Long options -s/--\([A-Za-z][A-Za-z0-9=_-]*\)\([^A-Za-z0-9]\)/\\\ +s/--\([A-Za-z][A-Za-z0-9=_-]*\)\([^A-Za-z0-9=_-]*\)/\\\ <@opts{--\1}\ \2/g #. @@ -259,6 +216,9 @@ s/\n//g s/\(fsfo{[^@]*\)@sbin{\([^}]*\)}/\1\2/ t cleanfsfo } +# Convert 2nd order commands/functions and binaries to arguments +s/@cmnd/@args/g +s/@args/@cmnd/1 # Character Entities #. # Mark up a few sesitive characters. @@ -293,7 +253,7 @@ s/^[ ]*[^<][^@][^}]*$// s/^[ ]*[^<][^@][^\\]*[\\ ()]*\n// :holdflush s/}[)(\\ ][)(\\ ]*/}/ -s/\n[];)|* ][^\\]*[\\]*// +s/\n[];)|* -][^\\]*[\\]*// t holdflush s/\n$// #. @@ -321,7 +281,7 @@ s/\([A-Za-z*][A-Za-z]*\.[a-z0-9][a-z0-9]*\)/@fsfo{\1}/g #. # Manually add a few commands not harvested from source. #. -s,[[:<:]]in[[:>:]],@cmnd{in},g +s,[[:<:]]in[[:>:]],@args{in},g s,[[:<:]]whoami[[:>:]],@sbin{whoami},g s,[[:<:]]fishd[[:>:]],@sbin{fishd},g #. @@ -360,8 +320,3 @@ s,[[:<:]]fishd[[:>:]],@sbin{fishd},g # single line. #. # b tidy -#. -# Colour lookup functions -#. -# The Makefile will add a table of colour names and values, possibly with -# extra style information, that are used to set defaults in the CSS file. diff --git a/doc_src/fish_prompt.txt b/doc_src/fish_prompt.txt index cecc338d..53da848e 100644 --- a/doc_src/fish_prompt.txt +++ b/doc_src/fish_prompt.txt @@ -1,7 +1,7 @@ \section fish_prompt fish_prompt - define the appearance of the command line prompt \subsection fish_prompt-synopsis Synopsis -\fish{syn} +\fish{synopsis} function fish_prompt ... end diff --git a/doc_src/fish_right_prompt.txt b/doc_src/fish_right_prompt.txt index 15f1f95b..19d1efec 100644 --- a/doc_src/fish_right_prompt.txt +++ b/doc_src/fish_right_prompt.txt @@ -1,7 +1,7 @@ \section fish_right_prompt fish_right_prompt - define the appearance of the right-side command line prompt \subsection fish_right_prompt-synopsis Synopsis -\fish{syn} +\fish{synopsis} function fish_right_prompt ... end diff --git a/doc_src/for.txt b/doc_src/for.txt index 902f4495..c75f953c 100644 --- a/doc_src/for.txt +++ b/doc_src/for.txt @@ -1,7 +1,7 @@ \section for for - perform a set of commands multiple times. \subsection for-synopsis Synopsis -\fish{syn} +\fish{synopsis} for VARNAME in [VALUES...]; COMMANDS...; end \endfish diff --git a/doc_src/funced.txt b/doc_src/funced.txt index 82f2cd63..51d1b865 100644 --- a/doc_src/funced.txt +++ b/doc_src/funced.txt @@ -1,7 +1,7 @@ \section funced funced - edit a function interactively \subsection funced-synopsis Synopsis -\fish{syn} +\fish{synopsis} funced [OPTIONS] NAME \endfish diff --git a/doc_src/funcsave.txt b/doc_src/funcsave.txt index fd4b5d87..c3f2fe32 100644 --- a/doc_src/funcsave.txt +++ b/doc_src/funcsave.txt @@ -1,7 +1,7 @@ \section funcsave funcsave - save the definition of a function to the user's autoload directory \subsection funcsave-synopsis Synopsis -\fish{syn} +\fish{synopsis} funcsave FUNCTION_NAME \endfish diff --git a/doc_src/function.txt b/doc_src/function.txt index 0f3b4fb0..74dc9de5 100644 --- a/doc_src/function.txt +++ b/doc_src/function.txt @@ -1,7 +1,7 @@ \section function function - create a function \subsection function-synopsis Synopsis -\fish{syn} +\fish{synopsis} function [OPTIONS] NAME; BODY; end \endfish diff --git a/doc_src/functions.txt b/doc_src/functions.txt index 048ee93e..520b55b7 100644 --- a/doc_src/functions.txt +++ b/doc_src/functions.txt @@ -1,7 +1,7 @@ \section functions functions - print or erase functions \subsection functions-synopsis Synopsis -\fish{syn} +\fish{synopsis} functions [-a|--all] [-n|--names] functions -c OLDNAME NEWNAME functions -d DESCRIPTION FUNCTION diff --git a/doc_src/help.txt b/doc_src/help.txt index a3375204..d862da8c 100644 --- a/doc_src/help.txt +++ b/doc_src/help.txt @@ -1,7 +1,7 @@ \section help help - display fish documentation \subsection help-synopsis Synopsis -\fish{syn} +\fish{synopsis} help [SECTION] \endfish diff --git a/doc_src/if.txt b/doc_src/if.txt index 38054c37..b1ca88f5 100644 --- a/doc_src/if.txt +++ b/doc_src/if.txt @@ -1,7 +1,7 @@ \section if if - conditionally execute a command \subsection if-synopsis Synopsis -\fish{syn} +\fish{synopsis} if CONDITION; COMMANDS_TRUE...; [else if CONDITION2; COMMANDS_TRUE2...;] [else; COMMANDS_FALSE...;] end \endfish diff --git a/doc_src/index.hdr.in b/doc_src/index.hdr.in index 2555ca08..95b1559c 100644 --- a/doc_src/index.hdr.in +++ b/doc_src/index.hdr.in @@ -188,7 +188,7 @@ When you start a job in `fish`, `fish` itself will pause, and give control of th Example: \fish -emacs & +emacs & \endfish will start the emacs text editor in the background. @@ -316,21 +316,20 @@ Specifying your own completions is not difficult. To specify a completion, use t To provide a list of possible completions for myprog, use the `-a` switch. If `myprog` accepts the arguments start and stop, this can be specified as `complete -c myprog -a 'start stop'`. The argument to the `-a` switch is always a single string. At completion time, it will be tokenized on spaces and tabs, and variable expansion, command substitution and other forms of parameter expansion will take place. -Fish has a special syntax to support specifying switches accepted by a command. The switches `-s`, `-l` and `-o` are used to specify a short switch (single character, such as -l), a gnu style long switch (such as '`--color`') and an old-style long switch (like '`-shuffle`'), respectively. If the command 'myprog' has an option '-o' which can also be written as '`--output`', and which can take an additional value of either 'yes' or 'no', this can be specified by writing: - +`fish` has a special syntax to support specifying switches accepted by a command. The switches `-s`, `-l` and `-o` are used to specify a short switch (single character, such as `-l`), a gnu style long switch (such as '`--color`') and an old-style long switch (like '`-shuffle`'), respectively. If the command 'myprog' has an option '-o' which can also be written as '`--output`', and which can take an additional value of either 'yes' or 'no', this can be specified by writing: \fish complete -c myprog -s o -l output -a "yes no" \endfish -There are also special switches for specifying that a switch requires an argument, to disable filename completion, to create completions that are only available in some combinations, etc.. For a complete description of the various switches accepted by the `complete` command, see the documentation for the <a href="commands.html#complete">complete</a> builtin, or write `complete --help` inside the `fish` shell. +There are also special switches for specifying that a switch requires an argument, to disable filename completion, to create completions that are only available in some combinations, etc.. For a complete description of the various switches accepted by the `complete` command, see the documentationfor the <a href="commands.html#complete">complete</a> builtin, or write `complete --help` inside the `fish` shell. For examples of how to write your own complex completions, study the completions in `/usr/share/fish/completions`. (The exact path depends on your chosen installation prefix and may be slightly different) \subsection completion-func Useful functions for writing completions -Fish ships with several functions that are very useful when writing command specific completions. Most of these functions name begins with the string '`__fish_`'. Such functions are internal to fish and their name and interface may change in future fish versions. Still, some of them may be very useful when writing completions. A few of these functions are described here. Be aware that they may be removed or changed in future versions of fish. +`fish` ships with several functions that are very useful when writing command specific completions. Most of these functions name begins with the string '`__fish_`'. Such functions are internal to `fish` and their name and interface may change in future fish versions. Still, some of them may be very useful when writing completions. A few of these functions are described here. Be aware that they may be removed or changed in future versions of fish. Functions beginning with the string `__fish_print_` print a newline- separated list of strings. For example, `__fish_print_filesystems` prints a list of all known file systems. Functions beginning with `__fish_complete_` print out a newline separated list of completions with descriptions. The description is separated from the completion by a tab character. @@ -349,7 +348,7 @@ Functions beginning with the string `__fish_print_` print a newline- separated l Completions can be defined on the commandline or in a configuration file, but they can also be automatically loaded. Fish automatically searches through any directories in the array variable `$fish_complete_path`, and any completions defined are automatically loaded when needed. A completion file must have a filename consisting of the name of the command to complete and the suffix '`.fish`'. -The default value for `$fish`_complete_path is `~/.config/fish/completions` `/etc/fish/completions` `/usr/share/fish/completions`. The exact path to the last two of these may be slightly different depending on what install path prefix was chosen at configuration time. If a suitable file is found in one of these directories, it will be automatically loaded and the search will be stopped. The rationale behind having three different directories is that the first one is for user specific completions, the second one is for system-wide completions and the last one is for default fish completions. +The default value for `$fish_complete_path` is `~/.config/fish/completions` `/etc/fish/completions` `/usr/share/fish/completions`. The exact path to the last two of these may be slightly different depending on what install path prefix was chosen at configuration time. If a suitable file is found in one of these directories, it will be automatically loaded and the search will be stopped. The rationale behind having three different directories is that the first one is for user specific completions, the second one is for system-wide completions and the last one is for default fish completions. If you have written new completions for a common Unix command, please consider sharing your work by submitting it via the instructions in <a href="#more-help">Further help and development</a>. diff --git a/doc_src/isatty.txt b/doc_src/isatty.txt index 33f0a6e7..9381d102 100644 --- a/doc_src/isatty.txt +++ b/doc_src/isatty.txt @@ -1,7 +1,7 @@ \section isatty isatty - test if a file or file descriptor is a tty. \subsection isatty-synopsis Synopsis -\fish{syn} +\fish{synopsis} isatty [FILE | DEVICE | FILE DESCRIPTOR NUMBER] \endfish diff --git a/doc_src/jobs.txt b/doc_src/jobs.txt index f47e618e..5056357c 100644 --- a/doc_src/jobs.txt +++ b/doc_src/jobs.txt @@ -1,7 +1,7 @@ \section jobs jobs - print currently running jobs \subsection jobs-synopsis Synopsis -\fish{syn} +\fish{synopsis} jobs [OPTIONS] [PID] \endfish diff --git a/doc_src/math.txt b/doc_src/math.txt index 887a813c..3b984fc0 100644 --- a/doc_src/math.txt +++ b/doc_src/math.txt @@ -2,7 +2,7 @@ \section math math - Perform mathematics calculations \subsection math-synopsis Synopsis -\fish{syn} +\fish{synopsis} math EXPRESSION \endfish diff --git a/doc_src/mimedb.txt b/doc_src/mimedb.txt index 79992f14..d65fd6ba 100644 --- a/doc_src/mimedb.txt +++ b/doc_src/mimedb.txt @@ -1,7 +1,7 @@ \section mimedb mimedb - lookup file information via the mime database \subsection mimedb-synopsis Synopsis -\fish{syn} +\fish{synopsis} mimedb [OPTIONS] FILES... \endfish diff --git a/doc_src/nextd.txt b/doc_src/nextd.txt index 2aad6049..a098c0a7 100644 --- a/doc_src/nextd.txt +++ b/doc_src/nextd.txt @@ -1,7 +1,7 @@ \section nextd nextd - move forward through directory history \subsection nextd-synopsis Synopsis -\fish{syn} +\fish{synopsis} nextd [ -l | --list ] [POS] \endfish diff --git a/doc_src/not.txt b/doc_src/not.txt index 746de9ba..b0d893f7 100644 --- a/doc_src/not.txt +++ b/doc_src/not.txt @@ -1,7 +1,7 @@ \section not not - negate the exit status of a job \subsection not-synopsis Synopsis -\fish{syn} +\fish{synopsis} not COMMAND [OPTIONS...] \endfish diff --git a/doc_src/open.txt b/doc_src/open.txt index 232b58b0..48c71cac 100644 --- a/doc_src/open.txt +++ b/doc_src/open.txt @@ -1,7 +1,7 @@ \section open open - open file in its default application \subsection open-synopsis Synopsis -\fish{syn} +\fish{synopsis} open FILES... \endfish diff --git a/doc_src/or.txt b/doc_src/or.txt index 39c3d95a..0d11129b 100644 --- a/doc_src/or.txt +++ b/doc_src/or.txt @@ -1,7 +1,7 @@ \section or or - conditionally execute a command \subsection or-synopsis Synopsis -\fish{syn} +\fish{synopsis} COMMAND1; or COMMAND2 \endfish diff --git a/doc_src/popd.txt b/doc_src/popd.txt index 297a0a80..f160f43d 100644 --- a/doc_src/popd.txt +++ b/doc_src/popd.txt @@ -1,7 +1,7 @@ \section popd popd - move through directory stack \subsection popd-synopsis Synopsis -\fish{syn} +\fish{synopsis} popd \endfish diff --git a/doc_src/prevd.txt b/doc_src/prevd.txt index 8bead8a1..557f6c98 100644 --- a/doc_src/prevd.txt +++ b/doc_src/prevd.txt @@ -1,7 +1,7 @@ \section prevd prevd - move backward through directory history \subsection prevd-synopsis Synopsis -\fish{syn} +\fish{synopsis} prevd [ -l | --list ] [POS] \endfish diff --git a/doc_src/psub.txt b/doc_src/psub.txt index 62c09be0..d0caafba 100644 --- a/doc_src/psub.txt +++ b/doc_src/psub.txt @@ -1,7 +1,7 @@ \section psub psub - perform process substitution \subsection psub-synopsis Synopsis -\fish{syn} +\fish{synopsis} COMMAND1 (COMMAND2|psub [-f]) \endfish diff --git a/doc_src/pushd.txt b/doc_src/pushd.txt index d6f50e63..3161fd09 100644 --- a/doc_src/pushd.txt +++ b/doc_src/pushd.txt @@ -1,7 +1,7 @@ \section pushd pushd - push directory to directory stack \subsection pushd-synopsis Synopsis -\fish{syn} +\fish{synopsis} pushd [DIRECTORY] \endfish diff --git a/doc_src/pwd.txt b/doc_src/pwd.txt index 0b83748d..46b6419f 100644 --- a/doc_src/pwd.txt +++ b/doc_src/pwd.txt @@ -1,7 +1,7 @@ \section pwd pwd - output the current working directory \subsection pwd-synopsis Synopsis -\fish{syn} +\fish{synopsis} pwd \endfish diff --git a/doc_src/random.txt b/doc_src/random.txt index abc444a8..3415daa6 100644 --- a/doc_src/random.txt +++ b/doc_src/random.txt @@ -1,7 +1,7 @@ \section random random - generate random number \subsection random-synopsis Synopsis -\fish{syn} +\fish{synopsis} random [SEED] \endfish diff --git a/doc_src/read.txt b/doc_src/read.txt index 44076bc4..f29e98ed 100644 --- a/doc_src/read.txt +++ b/doc_src/read.txt @@ -1,7 +1,7 @@ \section read read - read line of input into variables \subsection read-synopsis Synopsis -\fish{syn} +\fish{synopsis} read [OPTIONS] [VARIABLES...] \endfish diff --git a/doc_src/return.txt b/doc_src/return.txt index a044e58a..5f033349 100644 --- a/doc_src/return.txt +++ b/doc_src/return.txt @@ -1,7 +1,7 @@ \section return return - stop the current inner function \subsection return-synopsis Synopsis -\fish{syn} +\fish{synopsis} function NAME; [COMMANDS...;] return [STATUS]; [COMMANDS...;] end \endfish diff --git a/doc_src/set.txt b/doc_src/set.txt index 9dc1e04b..d27f603d 100644 --- a/doc_src/set.txt +++ b/doc_src/set.txt @@ -1,7 +1,7 @@ \section set set - display and change shell variables. \subsection set-synopsis Synopsis -\fish{syn} +\fish{synopsis} set [SCOPE_OPTIONS] set [OPTIONS] VARIABLE_NAME VALUES... set [OPTIONS] VARIABLE_NAME[INDICES]... VALUES... diff --git a/doc_src/set_color.txt b/doc_src/set_color.txt index ade02990..0597114b 100644 --- a/doc_src/set_color.txt +++ b/doc_src/set_color.txt @@ -1,7 +1,7 @@ \section set_color set_color - set the terminal color \subsection set_color-synopsis Synopsis -\fish{syn} +\fish{synopsis} set_color [-h|--help] [-b|--background COLOR] [COLOR] \endfish diff --git a/doc_src/source.txt b/doc_src/source.txt index bb32e30a..5efb6740 100644 --- a/doc_src/source.txt +++ b/doc_src/source.txt @@ -1,7 +1,7 @@ \section source source - evaluate contents of file. \subsection source-synopsis Synopsis -\fish{syn} +\fish{synopsis} source FILENAME [ARGUMENTS...] \endfish diff --git a/doc_src/status.txt b/doc_src/status.txt index 5cf8d98a..60e2342a 100644 --- a/doc_src/status.txt +++ b/doc_src/status.txt @@ -1,7 +1,7 @@ \section status status - query fish runtime information \subsection status-synopsis Synopsis -\fish{syn} +\fish{synopsis} status [OPTION] \endfish diff --git a/doc_src/switch.txt b/doc_src/switch.txt index 42e0d07a..7245b63f 100644 --- a/doc_src/switch.txt +++ b/doc_src/switch.txt @@ -1,7 +1,7 @@ \section switch switch - conditionally execute a block of commands \subsection switch-synopsis Synopsis -\fish{syn} +\fish{synopsis} switch VALUE; [case [WILDCARD...]; [COMMANDS...]; ...] end \endfish diff --git a/doc_src/test.txt b/doc_src/test.txt index ba0eb0eb..199c062d 100644 --- a/doc_src/test.txt +++ b/doc_src/test.txt @@ -1,7 +1,7 @@ \section test test - perform tests on files and text \subsection test-synopsis Synopsis -\fish{syn} +\fish{synopsis} test [EXPRESSION] \endfish diff --git a/doc_src/trap.txt b/doc_src/trap.txt index e3a280a5..fdccd178 100644 --- a/doc_src/trap.txt +++ b/doc_src/trap.txt @@ -1,7 +1,7 @@ \section trap trap - perform an action when the shell receives a signal \subsection trap-synopsis Synopsis -\fish{syn} +\fish{synopsis} trap [OPTIONS] [[ARG] SIGSPEC ... ] \endfish diff --git a/doc_src/type.txt b/doc_src/type.txt index 7a2c882b..c72520a1 100644 --- a/doc_src/type.txt +++ b/doc_src/type.txt @@ -1,7 +1,7 @@ \section type type - indicate how a command would be interpreted \subsection type-synopsis Synopsis -\fish{syn} +\fish{synopsis} type [OPTIONS] NAME [NAME ...] \endfish diff --git a/doc_src/ulimit.txt b/doc_src/ulimit.txt index 0d35f913..7ce12dcd 100644 --- a/doc_src/ulimit.txt +++ b/doc_src/ulimit.txt @@ -1,7 +1,7 @@ \section ulimit ulimit - set or get resource usage limits \subsection ulimit-synopsis Synopsis -\fish{syn} +\fish{synopsis} ulimit [OPTIONS] [LIMIT] \endfish diff --git a/doc_src/umask.txt b/doc_src/umask.txt index 49e0f796..7a83ddfa 100644 --- a/doc_src/umask.txt +++ b/doc_src/umask.txt @@ -1,7 +1,7 @@ \section umask umask - set or get the file creation mode mask \subsection umask-synopsis Synopsis -\fish{syn} +\fish{synopsis} umask [OPTIONS] [MASK] \endfish diff --git a/doc_src/user_doc.css.in b/doc_src/user_doc.css index d2f00642..d2f00642 100644 --- a/doc_src/user_doc.css.in +++ b/doc_src/user_doc.css diff --git a/doc_src/vared.txt b/doc_src/vared.txt index 90877553..7001be74 100644 --- a/doc_src/vared.txt +++ b/doc_src/vared.txt @@ -1,7 +1,7 @@ \section vared vared - interactively edit the value of an environment variable \subsection vared-synopsis Synopsis -\fish{syn} +\fish{synopsis} vared VARIABLE_NAME \endfish diff --git a/doc_src/while.txt b/doc_src/while.txt index 2fa74cb6..80ec959b 100644 --- a/doc_src/while.txt +++ b/doc_src/while.txt @@ -1,7 +1,7 @@ \section while while - perform a command multiple times \subsection while-synopsis Synopsis -\fish{syn} +\fish{synopsis} while CONDITION; COMMANDS...; end \endfish |