xref: /openbsd/usr.bin/env/env.1 (revision f6aab3d8)
1.\"	$OpenBSD: env.1,v 1.20 2015/01/12 21:42:53 deraadt Exp $
2.\" Copyright (c) 1980, 1990 The Regents of the University of California.
3.\" All rights reserved.
4.\"
5.\" This code is derived from software contributed to Berkeley by
6.\" the Institute of Electrical and Electronics Engineers, Inc.
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.\" 3. 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.\"	from: @(#)printenv.1	6.7 (Berkeley) 7/28/91
32.\"
33.Dd $Mdocdate: January 12 2015 $
34.Dt ENV 1
35.Os
36.Sh NAME
37.Nm env
38.Nd set and print environment
39.Sh SYNOPSIS
40.Nm env
41.Op Fl i
42.Oo
43.Ar name Ns = Ns Ar value ...
44.Oc
45.Oo
46.Ar utility
47.Op Ar 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 Ns = Ns Ar value
57specifies
58an environment variable,
59.Ar name ,
60with a value of
61.Ar value .
62.Pp
63The options are as follows:
64.Bl -tag -width Ds
65.It Fl i
66Causes
67.Nm
68to completely ignore the environment it inherits.
69.El
70.Pp
71If no
72.Ar utility
73is specified,
74.Nm
75prints out the names and values
76of the variables in the environment, with one
77.Ar name Ns = Ns Ar value
78pair per line.
79.Pp
80.Nm
81doesn't handle commands with equal
82.Pq Sq =
83signs in their
84names, for obvious reasons.
85.Sh EXIT STATUS
86The
87.Nm
88utility exits with one of the following values:
89.Bl -tag -width Ds
90.It 0
91.Nm
92completed successfully and, if
93.Ar utility
94was specified, it was invoked and completed successfully too.
95.It 1
96An invalid command line option was passed to
97.Nm
98and
99.Ar utility
100was not invoked, or
101.Ar utility
102was invoked but failed with exit status 1.
103.It 2\(en125, 128\(en255
104.Ar utility
105was invoked but failed with this exit status;
106see its manual page for more information.
107.It 126
108.Ar utility
109was found but could not be invoked, or it was invoked but failed
110with exit status 126.
111.It 127
112.Ar utility
113could not be found, or it was invoked but failed with exit status 127.
114.El
115.Sh SEE ALSO
116.Xr execvp 3 ,
117.Xr environ 7
118.Sh STANDARDS
119The
120.Nm
121utility is compliant with the
122.St -p1003.1-2008
123specification.
124.Pp
125The historic
126.Fl
127option has been deprecated but is still supported in this implementation.
128