path: root/usr/src/man/man1b/test.1b

'\" te
.\"  Copyright (c) 1996 Sun Microsystems, Inc - All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH TEST 1B "Apr 1, 1996"
.SH NAME
test \- condition evaluation command
.SH SYNOPSIS
.LP
.nf
\fB/usr/ucb/test\fR \fIexpression\fR
.fi

.LP
.nf
 \fIexpression\fR
.fi

.SH DESCRIPTION
.sp
.LP
\fBtest\fR evaluates the expression \fIexpression\fR and, if its value is true,
sets  \fB0\fR (true) exit status; otherwise, a non-zero (false) exit status is
set. \fBtest\fR also sets a non-zero exit status if there are no arguments.
When permissions are tested, the effective user \fBID\fR of the process is
used.
.sp
.LP
All operators, flags, and brackets (brackets used as shown in the second
\fBSYNOPSIS\fR line) must be separate arguments to the \fBtest\fR command;
normally these items are separated by spaces.
.SH USAGE
.SS "Primitives"
.sp
.LP
The following primitives are used to construct \fIexpression\fR:
.sp
.ne 2
.na
\fB\fB-r\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and is readable.
.RE

.sp
.ne 2
.na
\fB\fB-w\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and is writable.
.RE

.sp
.ne 2
.na
\fB\fB-x\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and is executable.
.RE

.sp
.ne 2
.na
\fB\fB-f\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and is a regular file. Alternatively, if
\fB/usr/bin/sh\fR users specify \fB/usr/ucb\fR before \fB/usr/bin\fR in their
\fBPATH\fR environment variable, then \fBtest\fR will return true if
\fIfilename\fR exists and is (\fBnot\(mia\(midirectory\fR). This is also the
default for \fB/usr/bin/csh\fR users.
.RE

.sp
.ne 2
.na
\fB\fB-d\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and is a directory.
.RE

.sp
.ne 2
.na
\fB\fB-c\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and is a character special file.
.RE

.sp
.ne 2
.na
\fB\fB-b\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and is a block special file.
.RE

.sp
.ne 2
.na
\fB\fB-p\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and is a named pipe (fifo).
.RE

.sp
.ne 2
.na
\fB\fB-u\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and its set-user- \fBID\fR bit is set.
.RE

.sp
.ne 2
.na
\fB\fB-g\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and its set-group- \fBID\fR bit is set.
.RE

.sp
.ne 2
.na
\fB\fB-k\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and its sticky bit is set.
.RE

.sp
.ne 2
.na
\fB\fB-s\fR \fIfilename\fR\fR
.ad
.RS 16n
True if \fIfilename\fR exists and has a size greater than zero.
.RE

.sp
.ne 2
.na
\fB\fB-t\fR[ \fIfildes\fR ]\fR
.ad
.RS 16n
True if the open file whose file descriptor number is \fIfildes\fR (1 by
default) is associated with a terminal device.
.RE

.sp
.ne 2
.na
\fB\fB-z\fR \fIs1\fR\fR
.ad
.RS 16n
True if the length of string \fIs1\fR is zero.
.RE

.sp
.ne 2
.na
\fB\fB-n\fR \fIs1\fR\fR
.ad
.RS 16n
True if the length of the string \fIs1\fR is non-zero.
.RE

.sp
.ne 2
.na
\fB\fIs1\fR\fB = \fR\fIs2\fR\fR
.ad
.RS 16n
True if strings \fIs1\fR and \fIs2\fR are identical.
.RE

.sp
.ne 2
.na
\fB\fIs1\fR\fB != \fR\fIs2\fR\fR
.ad
.RS 16n
True if strings \fIs1\fR and \fIs2\fR are \fInot\fR identical.
.RE

.sp
.ne 2
.na
\fB\fIs1\fR\fR
.ad
.RS 16n
True if \fIs1\fR is \fInot\fR the null string.
.RE

.sp
.ne 2
.na
\fB\fIn1\fR\fB \(mieq \fR\fIn2\fR\fR
.ad
.RS 16n
True if the integers \fIn1\fR and \fIn2\fR are algebraically equal. Any of the
comparisons \fB\(mine\fR, \fB\(migt\fR, \fB\(mige\fR, \fB\(milt\fR, and
\fB\(mile\fR may be used in place of \fB\(mieq\fR\&.
.RE

.SS "Operators"
.sp
.LP
These primaries may be combined with the following operators:
.sp
.ne 2
.na
\fB\fB!\fR\fR
.ad
.RS 16n
Unary negation operator.
.RE

.sp
.ne 2
.na
\fB\fB-a\fR\fR
.ad
.RS 16n
Binary \fIand\fR operator.
.RE

.sp
.ne 2
.na
\fB\fB-o\fR\fR
.ad
.RS 16n
Binary \fIor\fR operator (\fB-a\fR has higher precedence than \fB-o\fR).
.RE

.sp
.ne 2
.na
\fB(\fIexpression\fR)\fR
.ad
.RS 16n
Parentheses for grouping. Notice also that parentheses are meaningful to the
shell and, therefore, must be quoted.
.RE

.SH SEE ALSO
.sp
.LP
\fBfind\fR(1), \fBsh\fR(1), \fBattributes\fR(5)
.SH NOTES
.sp
.LP
The \fBnot\(mia\(midirectory\fR alternative to the \fB-f\fR option is a
transition aid for \fBBSD\fR applications and may not be supported in future
releases.
.sp
.LP
If you test a file you own (the \fB-r\fR \fB,\fR \fB-w\fR \fB,\fR or \fB-x\fR
tests), but the permission tested does not have the \fIowner\fR bit set, a
non-zero (false) exit status will be returned even though the file may have the
\fIgroup\fR or \fIother\fR bit set for that permission. The correct exit status
will be set if you are super-user.
.sp
.LP
The \fB=\fR and \fB!=\fR operators have a higher precedence than the \fB-r\fR
through \fB-n\fR operators, and \fB=\fR and \fB!=\fR always expect arguments;
therefore, \fB=\fR and \fB!=\fR cannot be used with the \fB-r\fR through
\fB-n\fR operators.
.sp
.LP
If more than one argument follows the \fB-r\fR through \fB-n\fR operators, only
the first argument is examined; the others are ignored, unless a \fB-a\fR or a
\fB-o\fR is the second argument.