aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/type.txt
diff options
context:
space:
mode:
authorGravatar axel <axel@liljencrantz.se>2005-09-24 11:30:16 +1000
committerGravatar axel <axel@liljencrantz.se>2005-09-24 11:30:16 +1000
commit5a7a14003f7d66d36815e7ae60470db288433175 (patch)
tree1c77bd0592236b6f082ad2bae8b7b58f67721e8d /doc_src/type.txt
parent3e0e50fbf325b53f29b17deda9eecd8c4f016814 (diff)
Update for type function
darcs-hash:20050924013016-ac50b-d153454213661a003b54306f9ee32caf6c390505.gz
Diffstat (limited to 'doc_src/type.txt')
-rw-r--r--doc_src/type.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc_src/type.txt b/doc_src/type.txt
new file mode 100644
index 00000000..424e2874
--- /dev/null
+++ b/doc_src/type.txt
@@ -0,0 +1,20 @@
+
+\section type type - Indicate how a name would be interpreted if used as a command name
+
+\subsection type-synopsis Synopsis
+ <tt>type [OPTIONS] name [name ...]</tt>
+
+\subsection type-description Description
+
+With no options, indicate how each name would be interpreted if used as a command name.
+
+- \c -h or \c --help print this message
+- \c -a or \c --all print all of possible definitions of the specified names
+- \c -f or \c --no-functions supresses function and builtin lookup
+- \c -t or \c --type print a string which is one of alias, keyword, function, builtin, or file if name is an alias, shell reserved word, function, builtin, or disk file, respectively
+- \c -p or \c --path either return the name of the disk file that would be executed if name were specified as a command name, or nothing if ‘‘type -t name’’ would not return file
+- \c -P or \c --force-path either return the name of the disk file that would be executed if name were specified as a command name, or nothing no file with the spacified name could be found in the PATH
+
+\subsection type-example Example
+
+<tt>type fg</tt> outputs the string 'fg is a shell builtin'.