aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/type.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc_src/type.txt')
-rw-r--r--doc_src/type.txt30
1 files changed, 19 insertions, 11 deletions
diff --git a/doc_src/type.txt b/doc_src/type.txt
index 9b5699f3..2f55d72a 100644
--- a/doc_src/type.txt
+++ b/doc_src/type.txt
@@ -1,24 +1,32 @@
\section type type - indicate how a command would be interpreted
\subsection type-synopsis Synopsis
- <tt>type [OPTIONS] NAME [NAME ...]</tt>
+\fish{synopsis}
+type [OPTIONS] NAME [NAME ...]
+\endfish
\subsection type-description Description
-With no options, \c type indicates how each \c NAME would be interpreted if used as a command name.
+With no options, `type` indicates how each `NAME` would be interpreted if used as a command name.
The following options are available:
-- \c -h or \c --help prints help and then exits.
-- \c -a or \c --all prints all of possible definitions of the specified names.
-- \c -f or \c --no-functions suppresses function and builtin lookup.
-- \c -t or \c --type prints <tt>keyword</tt>, <tt>function</tt>, <tt>builtin</tt>, or <tt>file</tt> if \c NAME is a shell reserved word, function, builtin, or disk file, respectively.
-- \c -p or \c --path returns the name of the disk file that would be executed, or nothing if 'type -t name' would not return 'file'.
-- \c -P or \c --force-path returns the name of the disk file that would be executed, or nothing no file with the specified name could be found in the <tt>$PATH</tt>.
+- `-a` or `--all` prints all of possible definitions of the specified names.
+
+- `-f` or `--no-functions` suppresses function and builtin lookup.
+
+- `-t` or `--type` prints `function`, `builtin`, or `file` if `NAME` is a shell function, builtin, or disk file, respectively.
+
+- `-p` or `--path` returns the name of the disk file that would be executed, or nothing if `type -t name` would not return `file`.
+
+- `-P` or `--force-path` returns the name of the disk file that would be executed, or nothing if no file with the specified name could be found in the <tt>$PATH</tt>.
+
+- `-q` or `--quiet` suppresses all output; this is useful when testing the exit status.
-\c type sets the exit status to 0 if the specified command was found,
-and 1 if it could not be found.
\subsection type-example Example
-<tt>type fg</tt> outputs the string 'fg is a shell builtin'.
+\fish
+type fg
+# Outputs the string 'fg is a shell builtin'.
+\endfish