xref: /freebsd/usr.bin/printenv/printenv.1 (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
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$
36.\"
37.Dd June 6, 1993
38.Dt PRINTENV 1
39.Os BSD 3
40.Sh NAME
41.Nm printenv , env
42.Nd print out the environment, set and print environment
43.Sh SYNOPSIS
44.Nm printenv
45.Op Ar name
46.Nm env
47.Op Fl
48.Op Fl i
49.Op Ar name=value ...
50.Op Ar command
51.Sh DESCRIPTION
52.Nm Printenv
53prints out the names and values of the variables in the environment,
54with one name/value pair per line.  If
55.Ar name
56is specified, only
57its value is printed.
58.Pp
59If a
60.Ar name
61is specified and it is not defined in the environment,
62.Nm printenv
63returns exit status 1, else it returns status 0.
64.Pp
65.Nm Env
66executes
67.Ar command
68after modifying the environment as
69specified on the command line.  The option
70.Ar name=value
71specifies
72an environment variable,
73.Ar name  ,
74with a value of
75.Ar value  .
76.Pp
77The options are as follows:
78.Bl -tag -width indent
79.It Fl i
80Execute the
81.Ar command
82with only those environment values specified.
83The environment inherited
84by
85.Nm env
86is ignored completely.
87.It Fl
88Identical to the
89.Fl i
90option, available for backward compatibility.
91.El
92.Pp
93If no command is specified,
94.Nm env
95prints out the names and values
96of the variables in the environment, with one name/value pair per line.
97.Sh SEE ALSO
98.Xr csh 1 ,
99.Xr sh 1 ,
100.Xr execvp 3 ,
101.Xr environ 7
102.Sh HISTORY
103The
104.Nm printenv
105command appeared in
106.Bx 3.0 .
107.Sh BUGS
108.Nm Env
109doesn't handle commands with equal (``='') signs in their
110names, for obvious reasons.
111