xref: /dragonfly/usr.bin/printenv/printenv.1 (revision f746689a)
1.\" Copyright (c) 1980, 1990, 1993
2.\"	The Regents of the University of California.  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	8.1 (Berkeley) 6/6/93
35.\" $FreeBSD: src/usr.bin/printenv/printenv.1,v 1.6.2.10 2002/06/26 08:25:30 tjr Exp $
36.\" $DragonFly: src/usr.bin/printenv/printenv.1,v 1.3 2005/08/05 22:35:11 swildner Exp $
37.\"
38.Dd June 6, 1993
39.Dt PRINTENV 1
40.Os
41.Sh NAME
42.Nm printenv ,
43.Nm env
44.Nd print out the environment, set and print environment
45.Sh SYNOPSIS
46.Nm
47.Op Ar name
48.Nm env
49.Op Fl
50.Op Fl i
51.Op Ar name Ns = Ns Ar value ...
52.Op Ar utility Oo Ar argument ... Oc
53.Sh DESCRIPTION
54The
55.Nm
56utility prints out the names and values of the variables in the environment,
57with one name/value pair per line.
58If
59.Ar name
60is specified, only
61its value is printed.
62.Pp
63Some shells may provide a builtin
64.Nm
65command which is similar or identical to this utility.
66Consult the
67.Xr builtin 1
68manual page.
69.Pp
70The
71.Nm env
72utility executes
73.Ar utility
74after modifying the environment as
75specified on the command line.
76The option
77.Ar name Ns = Ns Ar value
78specifies
79an environment variable,
80.Ar name  ,
81with a value of
82.Ar value  .
83.Pp
84The options are as follows:
85.Bl -tag -width indent
86.It Fl i
87Execute the
88.Ar utility
89with only those environment values specified.
90The environment inherited
91by
92.Nm env
93is ignored completely.
94.It Fl
95Identical to the
96.Fl i
97option, available for backward compatibility.
98.El
99.Pp
100If no utility is specified,
101.Nm env
102prints out the names and values
103of the variables in the environment, with one name/value pair per line.
104.Pp
105The
106.Nm env
107utility is sometimes useful with the
108.Dq Li #!
109construct (see
110.Xr execve 2 ) .
111The only difference between
112.Dq Li #!/usr/local/bin/foo
113and
114.Dq Li "#!/usr/bin/env\ /usr/local/bin/foo"
115is that the latter works even if
116.Pa /usr/local/bin/foo
117is itself interpreted.
118Using
119.Nm env
120this way also allows one to reference
121.Pa foo
122without the path,
123as well as set up the environment as desired.
124.Sh EXIT STATUS
125.Ex -std printenv
126.Pp
127.Ex -std env
128An exit status of 126 indicates
129.Ar utility
130was found, but could not be executed.
131An exit status of 127 indicates
132.Ar utility
133could not be found.
134.Sh SEE ALSO
135.Xr csh 1 ,
136.Xr sh 1 ,
137.Xr execvp 3 ,
138.Xr environ 7
139.Sh STANDARDS
140The
141.Nm env
142utility conforms to
143.St -p1003.1-2001 .
144.Sh HISTORY
145The
146.Nm
147command appeared in
148.Bx 3.0 .
149.Sh BUGS
150The
151.Nm env
152utility doesn't handle utility arguments with equal (``='') signs in their
153names, for obvious reasons.
154