diff options
| author |  axel <axel@liljencrantz.se> | 2006-11-18 02:24:38 +1000 |
|---|---|---|
| committer | axel <axel@liljencrantz.se> | 2006-11-18 02:24:38 +1000 |
| commit | 1b71f91a014996d60886885c6fee091e8013d988 (patch) | |
| tree | c01b41cc476bd2143677cb053b8cdef5f5ccfd78 /doc_src/alias.txt | |
| parent | b30886228c546f99f974b64101f6ca164cea25e4 (diff) | |
Update documentation display code to run roff on the client system instead of pregenerating documentation and compiling it into program binaries
darcs-hash:20061117162438-ac50b-5c4c7f0bd8bf53a16e16ecfead9569e642b7160f.gz
Diffstat (limited to 'doc_src/alias.txt')
| -rw-r--r-- | doc_src/alias.txt | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc_src/alias.txt b/doc_src/alias.txt new file mode 100644 index 00000000..ca34ab4b --- /dev/null +++ b/doc_src/alias.txt @@ -0,0 +1,15 @@ +\section alias alias - create a function + +\subsection alias-synopsis Synopsis +<tt>alias NAME DEFINITION</tt><br/> +<tt>alias NAME=DEFINITION</tt> + +\subsection alias-description Description + +Alias is a shellscript wrapper around the function builtin. +It exists for backwards compatibility with Posix +shells. For other uses, it is recommended to define a <a +href='#function'>function</a>. + +- NAME is the name of the function to define +- DEFINITION is the body of the function. The string " $argv" will be appended to the body. |