xref: /netbsd-src/usr.bin/env/env.1 (revision 81e0d2b0af8485d94ed5da487d4253841a2e6e45)
1.\"	$NetBSD: env.1,v 1.11 2003/08/07 11:13:35 agc Exp $
2.\"
3.\" Copyright (c) 1980, 1990 The Regents of the University of California.
4.\" 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.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"	from: @(#)printenv.1	6.7 (Berkeley) 7/28/91
33.\"	$NetBSD: env.1,v 1.11 2003/08/07 11:13:35 agc Exp $
34.\"
35.Dd August 27, 1993
36.Dt ENV 1
37.Os
38.Sh NAME
39.Nm env
40.Nd set and print environment
41.Sh SYNOPSIS
42.Nm
43.Op Fl i
44.Op Ar name=value ...
45.Oo
46.Ar utility
47.Op argument ...
48.Oc
49.Sh DESCRIPTION
50.Nm
51executes
52.Ar utility
53after modifying the environment as
54specified on the command line.
55The option
56.Ar name=value
57specifies
58an environmental variable,
59.Ar name  ,
60with a value of
61.Ar value  .
62The option
63.Sq Fl i
64causes
65.Nm
66to completely ignore the environment
67it inherits.
68.Pp
69If no
70.Ar utility
71is specified,
72.Nm
73prints out the names and values
74of the variables in the environment, with one
75.Ar name=value
76pair per line.
77.Sh EXIT STATUS
78If the
79.Ar utility
80is invoked, the exit status of
81.Nm
82shall be the exit status of
83.Ar utility ;
84otherwise, the
85.Nm
86utility exits with one of the following values:
87.Bl -tag -width Ds
88.It 0
89The
90.Nm
91utility completed successfully
92.It 1-125
93An error occurred in the
94.Nm
95utility.
96.It 126
97The utility specified by
98.Ar utility
99was found, but could not be invoked.
100.It 127
101The utility specified by
102.Ar utility
103could not be found.
104.El
105.Sh COMPATIBILITY
106The historic
107.Fl
108option has been deprecated but is still supported in this implementation.
109.Sh SEE ALSO
110.Xr execvp 3 ,
111.Xr environ 7
112.Sh STANDARDS
113The
114.Nm
115utility conforms to
116.St -p1003.2-92 .
117.Sh BUGS
118.Nm
119doesn't handle commands with equal
120.Pq Dq =
121signs in their
122names, for obvious reasons.
123