Add documentation for the vared shellscript function

darcs-hash:20051025143355-ac50b-d7aaecf4b2de062fb2c56928bd6a6919ad6d223c.gz
This commit is contained in:
axel 2005-10-26 00:33:55 +10:00
parent ef4345968e
commit 721f616964
2 changed files with 16 additions and 1 deletions

View file

@ -106,7 +106,7 @@ CMD_DOC_SRC := doc_src/count.txt doc_src/dirh.txt doc_src/dirs.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/tokenize.txt doc_src/type.txt \
doc_src/umask.txt
doc_src/umask.txt doc_src/vared.txt
#
# Files generated by running doxygen on the files in $(CMD_DOC_SRC)

15
doc_src/vared.txt Normal file
View file

@ -0,0 +1,15 @@
\section vared vared - Interactively edit the value of an environment variable
\subsection vared-synopsis Synopsis
<tt>vared VARIABLE_NAME</tt>
\subsection vared-description Description
vared is used to interactively edit the value of an environment
variable. Array variables as a whole can not be edited using vared,
but individual array elements can.
\subsection vared-example Example
<code>vared PATH[3]</code> edits the third element of the PATH array