xref: /netbsd/bin/test/test.1 (revision bf9ec67e)
1.\"	$NetBSD: test.1,v 1.17 2002/02/08 01:22:01 ross Exp $
2.\"
3.\" Copyright (c) 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" the Institute of Electrical and Electronics Engineers, Inc.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"	This product includes software developed by the University of
20.\"	California, Berkeley and its contributors.
21.\" 4. Neither the name of the University nor the names of its contributors
22.\"    may be used to endorse or promote products derived from this software
23.\"    without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35.\" SUCH DAMAGE.
36.\"
37.\"     @(#)test.1	8.1 (Berkeley) 5/31/93
38.\"
39.Dd May 31, 1993
40.Dt TEST 1
41.Os
42.Sh NAME
43.Nm test ,
44.Nm \&[
45.Nd condition evaluation utility
46.Sh SYNOPSIS
47.Nm test
48.Ar expression
49.Nm \&[
50.Ar expression Cm ]
51.Sh DESCRIPTION
52The
53.Nm test
54utility evaluates the expression and, if it evaluates
55to true, returns a zero (true) exit status; otherwise
56it returns 1 (false).
57If there is no expression, test also
58returns 1 (false).
59.Pp
60All operators and flags are separate arguments to the
61.Nm test
62utility.
63.Pp
64The following primaries are used to construct expression:
65.Bl -tag -width Ar
66.It Fl b Ar file
67True if
68.Ar file
69exists and is a block special
70file.
71.It Fl c Ar file
72True if
73.Ar file
74exists and is a character
75special file.
76.It Fl d Ar file
77True if
78.Ar file
79exists and is a directory.
80.It Fl e Ar file
81True if
82.Ar file
83exists (regardless of type).
84.It Fl f Ar file
85True if
86.Ar file
87exists and is a regular file.
88.It Fl g Ar file
89True if
90.Ar file
91exists and its set group ID flag
92is set.
93.It Fl h Ar file
94True if
95.Ar file
96exists and is a symbolic link.
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.Po Tn FIFO Pc .
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.
156This operator is retained for compatibility with previous versions of
157this program. Do not rely on its existence; use
158.Fl h
159instead.
160.It Fl O Ar file
161True if
162.Ar file
163exists and its owner matches the effective user id of this process.
164.It Fl G Ar file
165True if
166.Ar file
167exists and its group matches the effective group id of this process.
168.It Fl S Ar file
169True if
170.Ar file
171exists and is a socket.
172.It Ar file1 Fl nt Ar file2
173True if
174.Ar file1
175exists and is newer than
176.Ar file2 .
177.It Ar file1 Fl ot Ar file2
178True if
179.Ar file1
180exists and is older than
181.Ar file2 .
182.It Ar file1 Fl ef Ar file2
183True if
184.Ar file1
185and
186.Ar file2
187exist and refer to the same file.
188.It Ar string
189True if
190.Ar string
191is not the null
192string.
193.It Ar \&s\&1 Cm \&= Ar \&s\&2
194True if the strings
195.Ar \&s\&1
196and
197.Ar \&s\&2
198are identical.
199.It Ar \&s\&1 Cm \&!= Ar \&s\&2
200True if the strings
201.Ar \&s\&1
202and
203.Ar \&s\&2
204are not identical.
205.It Ar \&s\&1 Cm \&\*[Lt] Ar \&s\&2
206True if string
207.Ar \&s\&1
208comes before
209.Ar \&s\&2
210based on the ASCII value of their characters.
211.It Ar \&s\&1 Cm \&\*[Gt] Ar \&s\&2
212True if string
213.Ar \&s\&1
214comes after
215.Ar \&s\&2
216based on the ASCII value of their characters.
217.It Ar \&n\&1 Fl \&eq Ar \&n\&2
218True if the integers
219.Ar \&n\&1
220and
221.Ar \&n\&2
222are algebraically
223equal.
224.It Ar \&n\&1 Fl \&ne Ar \&n\&2
225True if the integers
226.Ar \&n\&1
227and
228.Ar \&n\&2
229are not
230algebraically equal.
231.It Ar \&n\&1 Fl \&gt Ar \&n\&2
232True if the integer
233.Ar \&n\&1
234is algebraically
235greater than the integer
236.Ar \&n\&2 .
237.It Ar \&n\&1 Fl \&ge Ar \&n\&2
238True if the integer
239.Ar \&n\&1
240is algebraically
241greater than or equal to the integer
242.Ar \&n\&2 .
243.It Ar \&n\&1 Fl \&lt Ar \&n\&2
244True if the integer
245.Ar \&n\&1
246is algebraically less
247than the integer
248.Ar \&n\&2 .
249.It Ar \&n\&1 Fl \&le Ar \&n\&2
250True if the integer
251.Ar \&n\&1
252is algebraically less
253than or equal to the integer
254.Ar \&n\&2 .
255.El
256.Pp
257These primaries can be combined with the following operators:
258.Bl -tag -width Ar
259.It Cm \&! Ar expression
260True if
261.Ar expression
262is false.
263.It Ar expression1 Fl a Ar expression2
264True if both
265.Ar expression1
266and
267.Ar expression2
268are true.
269.It Ar expression1 Fl o Ar expression2
270True if either
271.Ar expression1
272or
273.Ar expression2
274are true.
275.It Cm \&( Ns Ar expression Ns Cm \&)
276True if expression is true.
277.El
278.Pp
279The
280.Fl a
281operator has higher precedence than the
282.Fl o
283operator.
284.Sh GRAMMAR AMBIGUITY
285The
286.Nm test
287grammar is inherently ambiguous.  In order to assure a degree of consistency,
288the cases described in
289.St -p1003.2
290section 4.62.4,
291are evaluated consistently according to the rules specified in the
292standards document.  All other cases are subject to the ambiguity in the
293command semantics.
294.Sh EXIT STATUS
295The
296.Nm test
297utility exits with one of the following values:
298.Bl -tag -width Ds
299.It 0
300expression evaluated to true.
301.It 1
302expression evaluated to false or expression was
303missing.
304.It \*[Gt]1
305An error occurred.
306.El
307.Sh STANDARDS
308The
309.Nm test
310utility implements a superset of the
311.St -p1003.2
312specification.
313