Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-11-14 17:07:44 +00:00
Code Issues Projects Releases Packages Wiki Activity
fish-shell/doc_src/test.txt

108 lines
4.6 KiB
Text
Raw Normal View History

Created the man page for echo and test
2012-07-03 21:54:00 +00:00
\section test test - perform tests on files and text
\subsection test-synopsis Synopsis
<tt>test [EXPRESSION]</tt>
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
2013-05-12 07:56:01 +00:00
\subsection test-description Description
Created the man page for echo and test
2012-07-03 21:54:00 +00:00
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
2013-05-12 07:56:01 +00:00
Tests the expression given and sets the exit status to 0 if true,
documentation for test and function (closes: #734) plus speling in documentation for bind. Note that this commit does not re-enable the generation of the manpage for test, which will therefore still fall through to the system manual page with `man test`.
2013-07-29 08:06:05 +00:00
and 1 if false. An expression is made up of one or more operators
and their arguments.
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
2013-05-12 07:56:01 +00:00
documentation for test and function (closes: #734) plus speling in documentation for bind. Note that this commit does not re-enable the generation of the manpage for test, which will therefore still fall through to the system manual page with `man test`.
2013-07-29 08:06:05 +00:00
The following operators are available to examine files and directories:
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
2013-05-12 07:56:01 +00:00
- <tt>-b FILE</tt> returns true if \c FILE is a block device.
- <tt>-c FILE</tt> returns true if \c FILE is a character device.
- <tt>-d FILE</tt> returns true if \c FILE is a directory.
- <tt>-e FILE</tt> returns true if \c FILE exists.
- <tt>-f FILE</tt> returns true if \c FILE is a regular file.
documentation for test and function (closes: #734) plus speling in documentation for bind. Note that this commit does not re-enable the generation of the manpage for test, which will therefore still fall through to the system manual page with `man test`.
2013-07-29 08:06:05 +00:00
- <tt>-g FILE</tt> returns true if \c FILE has the set-group-ID bit set.
test documentation: update wording, generate test manual page (closes #734)
2013-09-09 12:01:38 +00:00
- <tt>-G FILE</tt> returns true if \c FILE exists and has the same group ID
as the current user.
documentation for test and function (closes: #734) plus speling in documentation for bind. Note that this commit does not re-enable the generation of the manpage for test, which will therefore still fall through to the system manual page with `man test`.
2013-07-29 08:06:05 +00:00
- <tt>-L FILE</tt> returns true if \c FILE is a symbolic link.
test documentation: update wording, generate test manual page (closes #734)
2013-09-09 12:01:38 +00:00
- <tt>-O FILE</tt> returns true if \c FILE exists and is owned by the current
user.
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
2013-05-12 07:56:01 +00:00
- <tt>-p FILE</tt> returns true if \c FILE is a named pipe.
documentation for test and function (closes: #734) plus speling in documentation for bind. Note that this commit does not re-enable the generation of the manpage for test, which will therefore still fall through to the system manual page with `man test`.
2013-07-29 08:06:05 +00:00
- <tt>-r FILE</tt> returns true if \c FILE is marked as readable.
- <tt>-s FILE</tt> returns true if the size of \c FILE is greater than zero.
- <tt>-S FILE</tt> returns true if \c FILE is a socket.
- <tt>-t FD</tt> returns true if the file descriptor \c FD is a terminal (TTY).
- <tt>-u FILE</tt> returns true if \c FILE has the set-user-ID bit set.
- <tt>-w FILE</tt> returns true if \c FILE is marked as writable; note that this does not check if the filesystem is read-only.
- <tt>-x FILE</tt> returns true if \c FILE is marked as executable.
The following operators are available to compare and examine text strings:
- <tt>STRING1 = STRING2</tt> returns true if the strings \c STRING1 and
\c STRING2 are identical.
- <tt>STRING1 != STRING2</tt> returns true if the strings \c STRING1 and
\c STRING2 are not identical.
- <tt>-n STRING</tt> returns true if the length of \c STRING is non-zero.
- <tt>-z STRING</tt> returns true if the length of \c STRING is zero.
The following operators are available to compare and examine numbers:
- <tt>NUM1 -eq NUM2</tt> returns true if \c NUM1 and \c NUM2 are numerically equal.
- <tt>NUM1 -ne NUM2</tt> returns true if \c NUM1 and \c NUM2 are not numerically equal.
- <tt>NUM1 -gt NUM2</tt> returns true if \c NUM1 is greater than <tt>NUM2</tt>.
- <tt>NUM1 -ge NUM2</tt> returns true if \c NUM1 is greater than or equal to <tt>NUM2</tt>.
- <tt>NUM1 -lt NUM2</tt> returns true if \c NUM1 is less than <tt>NUM2</tt>.
- <tt>NUM1 -le NUM2</tt> returns true if \c NUM1 is less than or equal to <tt>NUM2</tt>.
Note that only integers are supported. For more complex mathematical
operations, including fractions, the \c env program may be useful. Consult the
documentation for your operating system.
Expressions can be combined using the following operators:
- <tt>COND1 -a COND2</tt> returns true if both \c COND1 and \c COND2 are true.
- <tt>COND1 -o COND2</tt> returns true if either \c COND1 or \c COND2 are true.
Expressions can be inverted using the \c ! operator:
- <tt>! EXPRESSION</tt> returns true if \c EXPRESSION is false, and false if
\c EXPRESSION is true.
Created the man page for echo and test
2012-07-03 21:54:00 +00:00
documentation for test and function (closes: #734) plus speling in documentation for bind. Note that this commit does not re-enable the generation of the manpage for test, which will therefore still fall through to the system manual page with `man test`.
2013-07-29 08:06:05 +00:00
Expressions can be grouped using parentheses.
- <tt>( EXPRESSION )</tt> returns the value of <tt>EXPRESSION</tt>.
Note that parentheses will usually require escaping with <tt>\\(</tt> to avoid
being interpreted as a command substitution.
\subsection test-example Examples
If the \c /tmp directory exists, copy the \c /etc/motd file to it:
<pre>
if test -d /tmp
cp /etc/motd /tmp/motd
end
</pre>
If the variable \c MANPATH is defined and not empty, print the contents:
Created the man page for echo and test
2012-07-03 21:54:00 +00:00
test documentation - format examples properly
2012-11-05 01:38:42 +00:00
<pre>
documentation for test and function (closes: #734) plus speling in documentation for bind. Note that this commit does not re-enable the generation of the manpage for test, which will therefore still fall through to the system manual page with `man test`.
2013-07-29 08:06:05 +00:00
if test -n $MANPATH
echo $MANPATH
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
2013-05-12 07:56:01 +00:00
end
documentation for test and function (closes: #734) plus speling in documentation for bind. Note that this commit does not re-enable the generation of the manpage for test, which will therefore still fall through to the system manual page with `man test`.
2013-07-29 08:06:05 +00:00
</pre>
Parentheses and the \c -o and \c -a operators can be combined to produce
more complicated expressions. In this example, success is printed if there is
a \c /foo or \c /bar file as well as a \c /baz or \c /bat file.
<pre>
if test \\( -f /foo -o -f /bar \\) -a \\( -f /baz -o -f /bat \\)
echo Success.
end.
</pre>
\subsection test-standards Standards
\c test implements a subset of the
<a href="http://www.unix.com/man-page/POSIX/1/test/">IEEE Std 1003.1-2008
(POSIX.1) standard</a>. The following exceptions apply:
- The \c < and \c > operators for comparing strings are not implemented.
Enhance/fix `isatty` using `command test`. Presently, `isatty` only works on a handful of keywords. Here it is rewritten to be able to take any path, device or fd number as an argument, and eliminates errors printed to stdout. Per discussion in #1228, using `builtin test -c` within a pipe to test special file descriptors is not viable, so this implementation specifcially uses `command test`. Additionally, a note has been added to the documentation of `test` regarding this potential aberration from the expected output of the test utility under the 'Standards' section.
2014-01-08 03:57:49 +00:00
- Because this test is a shell builtin and not a standalone utility, using
the -c flag on a special file descriptors like standard input and output
may not return the same result when invoked from within a pipe as one
would expect when invoking the \c test utility in another shell.
In cases such as this, one can use \c command \c test to explicitly
use the system's standalone \c test rather than this \c builtin \c test.
Created the man page for echo and test
2012-07-03 21:54:00 +00:00
Reference in a new issue Copy permalink