xref: /netbsd-src/usr.bin/env/env.1 (revision d16b7486a53dcb8072b60ec6fcb4373a2d0c27b7)
1.\"	$NetBSD: env.1,v 1.15 2020/02/08 11:10:08 leot 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.15 2020/02/08 11:10:08 leot Exp $
34.\"
35.Dd February 8, 2020
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 0i
44.Op Fl u Ar name
45.Op Ar name=value ...
46.Oo
47.Ar utility
48.Op argument ...
49.Oc
50.Sh DESCRIPTION
51.Nm
52executes
53.Ar utility
54after modifying the environment as
55specified on the command line.
56The option
57.Ar name=value
58specifies
59an environmental variable,
60.Ar name  ,
61with a value of
62.Ar value  .
63The option
64.Sq Fl i
65causes
66.Nm
67to completely ignore the environment
68it inherits.
69.Pp
70The option
71.Sq Fl u Ar name
72causes removal of the
73.Ar name
74environment variable if it is in the environment.
75This is similar to the
76.Ic unset
77command in
78.Xr sh 1 .
79The value for
80.Ar name
81must not include the
82.Ql =
83character.
84.Pp
85If no
86.Ar utility
87is specified,
88.Nm
89prints out the names and values of the variables in the environment.
90Each
91.Ar name=value
92pair is separated by a new line unless
93.Fl 0
94is specified, in which case name/value pairs are separated by NUL.
95Both
96.Fl 0
97and
98.Ar utility
99must not be specified together.
100.Sh EXIT STATUS
101.Nm
102exits with one of the following values:
103.Bl -tag -width Ds
104.It 0
105.Ar utility
106was invoked and completed successfully.
107In this case the exit code is returned by the utility itself, not
108.Nm .
109If no utility was specified, then
110.Nm
111completed successfully and returned the exit code itself.
112.It 1
113An invalid command line option was passed to
114.Nm .
115.It 1\-125
116.Ar utility
117was invoked, but failed in some way;
118see its manual page for more information.
119In this case the exit code is returned by the utility itself, not
120.Nm .
121.It 125
122.Ar utility
123was specified together with the
124.Fl 0
125option.
126.It 126
127.Ar utility
128was found, but could not be invoked.
129.It 127
130.Ar utility
131could not be found.
132.El
133.Sh COMPATIBILITY
134The historic
135.Fl
136option has been deprecated but is still supported in this implementation.
137.Pp
138The
139.Fl u
140and
141.Fl 0
142options are non-standard extensions.
143.Sh SEE ALSO
144.Xr execvp 3 ,
145.Xr environ 7
146.Sh STANDARDS
147The
148.Nm
149utility conforms to
150.St -p1003.2-92 .
151.Sh HISTORY
152The
153.Nm
154command appeared in
155.Bx 4.4 .
156.Pp
157The
158.Fl u
159and
160.Fl 0
161options first appeared in
162.Nx 10 .
163.Sh BUGS
164.Nm
165doesn't handle commands with equal
166.Pq Dq =
167signs in their
168names, for obvious reasons.
169