xref: /freebsd/bin/test/test.1 (revision 2357939bc239bd5334a169b62313806178dd8f30)
1.\" Copyright (c) 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the Institute of Electrical and Electronics Engineers, Inc.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 4. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"     @(#)test.1	8.1 (Berkeley) 5/31/93
32.\" $FreeBSD$
33.\"
34.Dd May 31, 1993
35.Dt TEST 1
36.Os
37.Sh NAME
38.Nm test ,
39.Nm \&[
40.Nd condition evaluation utility
41.Sh SYNOPSIS
42.Nm
43.Ar expression
44.Nm \&[
45.Ar expression Cm ]
46.Sh DESCRIPTION
47The
48.Nm
49utility evaluates the expression and, if it evaluates
50to true, returns a zero (true) exit status; otherwise
51it returns 1 (false).
52If there is no expression, test also
53returns 1 (false).
54.Pp
55All operators and flags are separate arguments to the
56.Nm
57utility.
58.Pp
59The following primaries are used to construct expression:
60.Bl -tag -width Ar
61.It Fl b Ar file
62True if
63.Ar file
64exists and is a block special
65file.
66.It Fl c Ar file
67True if
68.Ar file
69exists and is a character
70special file.
71.It Fl d Ar file
72True if
73.Ar file
74exists and is a directory.
75.It Fl e Ar file
76True if
77.Ar file
78exists (regardless of type).
79.It Fl f Ar file
80True if
81.Ar file
82exists and is a regular file.
83.It Fl g Ar file
84True if
85.Ar file
86exists and its set group ID flag
87is set.
88.It Fl h Ar file
89True if
90.Ar file
91exists and is a symbolic link.
92This operator is retained for compatibility with previous versions of
93this program.
94Do not rely on its existence; use
95.Fl L
96instead.
97.It Fl k Ar file
98True if
99.Ar file
100exists and its sticky bit is set.
101.It Fl n Ar string
102True if the length of
103.Ar string
104is nonzero.
105.It Fl p Ar file
106True if
107.Ar file
108is a named pipe
109.Pq Tn FIFO .
110.It Fl r Ar file
111True if
112.Ar file
113exists and is readable.
114.It Fl s Ar file
115True if
116.Ar file
117exists and has a size greater
118than zero.
119.It Fl t Ar file_descriptor
120True if the file whose file descriptor number
121is
122.Ar file_descriptor
123is open and is associated with a terminal.
124.It Fl u Ar file
125True if
126.Ar file
127exists and its set user ID flag
128is set.
129.It Fl w Ar file
130True if
131.Ar file
132exists and is writable.
133True
134indicates only that the write flag is on.
135The file is not writable on a read-only file
136system even if this test indicates true.
137.It Fl x Ar file
138True if
139.Ar file
140exists and is executable.
141True
142indicates only that the execute flag is on.
143If
144.Ar file
145is a directory, true indicates that
146.Ar file
147can be searched.
148.It Fl z Ar string
149True if the length of
150.Ar string
151is zero.
152.It Fl L Ar file
153True if
154.Ar file
155exists and is a symbolic link.
156.It Fl O Ar file
157True if
158.Ar file
159exists and its owner matches the effective user id of this process.
160.It Fl G Ar file
161True if
162.Ar file
163exists and its group matches the effective group id of this process.
164.It Fl S Ar file
165True if
166.Ar file
167exists and is a socket.
168.It Ar file1 Fl nt Ar file2
169True if
170.Ar file1
171exists and is newer than
172.Ar file2 .
173.It Ar file1 Fl ot Ar file2
174True if
175.Ar file1
176exists and is older than
177.Ar file2 .
178.It Ar file1 Fl ef Ar file2
179True if
180.Ar file1
181and
182.Ar file2
183exist and refer to the same file.
184.It Ar string
185True if
186.Ar string
187is not the null
188string.
189.It Ar \&s\&1 Cm \&= Ar \&s\&2
190True if the strings
191.Ar \&s\&1
192and
193.Ar \&s\&2
194are identical.
195.It Ar \&s\&1 Cm \&!= Ar \&s\&2
196True if the strings
197.Ar \&s\&1
198and
199.Ar \&s\&2
200are not identical.
201.It Ar \&s\&1 Cm \&< Ar \&s\&2
202True if string
203.Ar \&s\&1
204comes before
205.Ar \&s\&2
206based on the ASCII value of their characters.
207.It Ar \&s\&1 Cm \&> Ar \&s\&2
208True if string
209.Ar \&s\&1
210comes after
211.Ar \&s\&2
212based on the ASCII value of their characters.
213.It Ar \&s\&1
214True if
215.Ar \&s\&1
216is not the null
217string.
218.It Ar \&n\&1 Fl \&eq Ar \&n\&2
219True if the integers
220.Ar \&n\&1
221and
222.Ar \&n\&2
223are algebraically
224equal.
225.It Ar \&n\&1 Fl \&ne Ar \&n\&2
226True if the integers
227.Ar \&n\&1
228and
229.Ar \&n\&2
230are not
231algebraically equal.
232.It Ar \&n\&1 Fl \&gt Ar \&n\&2
233True if the integer
234.Ar \&n\&1
235is algebraically
236greater than the integer
237.Ar \&n\&2 .
238.It Ar \&n\&1 Fl \&ge Ar \&n\&2
239True if the integer
240.Ar \&n\&1
241is algebraically
242greater than or equal to the integer
243.Ar \&n\&2 .
244.It Ar \&n\&1 Fl \&lt Ar \&n\&2
245True if the integer
246.Ar \&n\&1
247is algebraically less
248than the integer
249.Ar \&n\&2 .
250.It Ar \&n\&1 Fl \&le Ar \&n\&2
251True if the integer
252.Ar \&n\&1
253is algebraically less
254than or equal to the integer
255.Ar \&n\&2 .
256.El
257.Pp
258These primaries can be combined with the following operators:
259.Bl -tag -width Ar
260.It Cm \&! Ar expression
261True if
262.Ar expression
263is false.
264.It Ar expression1 Fl a Ar expression2
265True if both
266.Ar expression1
267and
268.Ar expression2
269are true.
270.It Ar expression1 Fl o Ar expression2
271True if either
272.Ar expression1
273or
274.Ar expression2
275are true.
276.It Cm \&( Ns Ar expression Ns Cm \&)
277True if expression is true.
278.El
279.Pp
280The
281.Fl a
282operator has higher precedence than the
283.Fl o
284operator.
285.Pp
286Some shells may provide a builtin
287.Nm
288command which is similar or identical to this utility.
289Consult the
290.Xr builtin 1
291manual page.
292.Sh GRAMMAR AMBIGUITY
293The
294.Nm
295grammar is inherently ambiguous.  In order to assure a degree of consistency,
296the cases described in the
297.St -p1003.2 ,
298section D11.2/4.62.4, standard
299are evaluated consistently according to the rules specified in the
300standards document.  All other cases are subject to the ambiguity in the
301command semantics.
302.Sh RETURN VALUES
303The
304.Nm
305utility exits with one of the following values:
306.Bl -tag -width Ds
307.It 0
308expression evaluated to true.
309.It 1
310expression evaluated to false or expression was
311missing.
312.It >1
313An error occurred.
314.El
315.Sh SEE ALSO
316.Xr builtin 1 ,
317.Xr expr 1 ,
318.Xr sh 1
319.Sh STANDARDS
320The
321.Nm
322utility implements a superset of the
323.St -p1003.2
324specification.
325