mirror of
https://github.com/fish-shell/fish-shell.git
synced 2024-11-23 06:05:39 +08:00
shellscript functions should use the help command to display help
darcs-hash:20060126173437-ac50b-69c03761554180467f741a9597205fab6c823378.gz
This commit is contained in:
axel
parent
86b7ae6d21
commit
e01ccb14af
13
Makefile.in
13
Makefile.in
|
|
@ -119,12 +119,13 @@ BUILTIN_DOC_HDR := $(BUILTIN_DOC_SRC:.txt=.doxygen)
|
|||
# alphabetically, since this is the order in which they will be written
|
||||
# in the help file.
|
||||
#
|
||||
CMD_DOC_SRC := doc_src/count.txt doc_src/dirh.txt doc_src/dirs.txt \
|
||||
doc_src/fish_pager.txt doc_src/fishd.txt doc_src/help.txt \
|
||||
doc_src/mimedb.txt doc_src/nextd.txt doc_src/open.txt \
|
||||
doc_src/popd.txt doc_src/prevd.txt doc_src/psub.txt \
|
||||
doc_src/pushd.txt doc_src/set_color.txt doc_src/trap.txt \
|
||||
doc_src/type.txt doc_src/umask.txt doc_src/vared.txt
|
||||
CMD_DOC_SRC := doc_src/contains.txt doc_src/count.txt doc_src/dirh.txt \
|
||||
doc_src/dirs.txt doc_src/fish_pager.txt doc_src/fishd.txt \
|
||||
doc_src/help.txt doc_src/mimedb.txt doc_src/nextd.txt \
|
||||
doc_src/open.txt doc_src/popd.txt doc_src/prevd.txt \
|
||||
doc_src/psub.txt doc_src/pushd.txt doc_src/set_color.txt \
|
||||
doc_src/trap.txt doc_src/type.txt doc_src/umask.txt \
|
||||
doc_src/vared.txt
|
||||
|
||||
#
|
||||
# Files generated by running doxygen on the files in $(CMD_DOC_SRC)
|
||||
|
|
|
|||
24
doc_src/contains.txt
Normal file
24
doc_src/contains.txt
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
|
||||
\section contains contains - Test if a word is present in a list
|
||||
|
||||
\subsection contains-synopsis Synopsis
|
||||
<code>contains [OPTIONS] KEY [VALUES...]</code>
|
||||
|
||||
\subsection contains-description Description
|
||||
|
||||
- \c -h or \c --help display this message
|
||||
|
||||
Test if the set VALUES contains the string KEY. Return status is 0 if
|
||||
yes, 1 otherwise
|
||||
|
||||
|
||||
\subsection contains-example Example
|
||||
<pre>
|
||||
for i in ~/bin /usr/local/bin
|
||||
if not contains \$i \$PATH
|
||||
set PATH \$PATH i
|
||||
end
|
||||
end
|
||||
</pre>
|
||||
|
||||
The above code tests if ~/bin and /usr/local/bin are in the path and if they are not, they are added.
|
||||
|
|
@ -1,39 +1,15 @@
|
|||
#
|
||||
# This file defines various functions for fish
|
||||
# This file defines various shellscript functions. Most of them are
|
||||
# meant to be used directly by the user, but some of them, typically
|
||||
# the ones whose name start with '__fish_', are only meant to be used
|
||||
# internally by fish.
|
||||
#
|
||||
|
||||
|
||||
function _contains_help -d "Helper function for contains"
|
||||
|
||||
set bullet \*
|
||||
if expr "$LANG" : ".*UTF" >/dev/null
|
||||
set bullet \u2022
|
||||
end
|
||||
|
||||
echo \tcontains - Test if a word is present in a list\n
|
||||
__bold Synopsis
|
||||
echo \n\n\tcontains \[OPTION] KEY [VALUES...]\n
|
||||
__bold Description
|
||||
echo \n\n\t$bullet (__bold -h) or (__bold --help) display help and exit\n
|
||||
echo \tTest if the set VALUES contains the string KEY.
|
||||
echo \tReturn status is 0 if yes, 1 otherwise.\n
|
||||
__bold Example
|
||||
echo \n
|
||||
echo \tfor i in \~/bin /usr/local/bin
|
||||
echo \t\tif not contains \$i \$PATH
|
||||
echo \t\t\tset PATH \$PATH i
|
||||
echo \t\tend
|
||||
echo \tend
|
||||
echo
|
||||
echo \tThe above code tests if "~/bin" and /usr/local/bin are in the path
|
||||
echo \tand if they are not, they are added.
|
||||
end
|
||||
|
||||
function contains -d "Test if a key is contained in a set of values"
|
||||
while set -q argv
|
||||
switch $argv[1]
|
||||
case '-h' '--h' '--he' '--hel' '--help'
|
||||
_contains_help
|
||||
help contains
|
||||
return
|
||||
|
||||
case '--'
|
||||
|
|
@ -667,36 +643,6 @@ function trap -d 'Perform an action when the shell recives a signal'
|
|||
|
||||
end
|
||||
|
||||
function __fish_type_help -d "Help for the type shellscript function"
|
||||
|
||||
set bullet \*
|
||||
if expr "$LANG" : ".*UTF" >/dev/null
|
||||
set bullet \u2022
|
||||
end
|
||||
|
||||
echo \ttype - Indicate how a name would be interpreted if used as a \n\tcommand name
|
||||
echo
|
||||
echo (__bold Synopsis)
|
||||
echo
|
||||
echo \t(set_color $fish_color_command)type(set_color normal) [OPTIONS] name [name ...]
|
||||
echo
|
||||
echo (__bold Description)
|
||||
echo
|
||||
echo \tWith no options, indicate how each name would be interpreted if \n\tused as a command name.
|
||||
echo
|
||||
echo \t$bullet (__bold -h) or (__bold --help) print this message
|
||||
echo \t$bullet (__bold -a) or (__bold --all) print all possible definitions of the specified \n\t\ \ names
|
||||
echo \t$bullet (__bold -f) or (__bold --no-functions) supresses function and builtin lookup
|
||||
echo \t$bullet (__bold -t) or (__bold --type) print a string which is one of alias, keyword, \n\t\ \ function, builtin, or file if name is an alias, shell \n\t\ \ reserved word, function, builtin, or disk file, respectively
|
||||
echo \t$bullet (__bold -p) or (__bold --path) either return the name of the disk file that would \n\t\ \ be executed if name were specified as a command name, or nothing \n\t\ \ if (__bold "type -t name") would not return file
|
||||
echo \t$bullet (__bold -P) or (__bold --force-path) either return the name of the disk file that \n\t\ \ would be executed if name were specified as a command name, \n\t\ \ or nothing no file with the spacified name could be found \n\t\ \ in the PATH
|
||||
echo
|
||||
echo (__bold Example)
|
||||
echo
|
||||
echo \t\'(set_color $fish_color_command)type(set_color normal) fg\' outputs the string \'fg is a shell builtin\'.
|
||||
echo
|
||||
|
||||
end
|
||||
|
||||
function type -d "Print the type of a command"
|
||||
|
||||
|
|
@ -741,7 +687,7 @@ function type -d "Print the type of a command"
|
|||
set selection files
|
||||
|
||||
case -h --help
|
||||
__fish_type_help
|
||||
help type
|
||||
return 0
|
||||
|
||||
case --
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user