aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/alias.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc_src/alias.txt')
-rw-r--r--doc_src/alias.txt15
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.