shellscript functions should use the help command to display help

darcs-hash:20060126173437-ac50b-69c03761554180467f741a9597205fab6c823378.gz
This commit is contained in:
axel
2006-01-27 03:34:37 +10:00
parent 86b7ae6d21
commit e01ccb14af
3 changed files with 37 additions and 66 deletions

24
doc_src/contains.txt Normal file
View 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.