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