[unix-history] / usr / src / usr.bin / printenv / printenv.1

.\" Copyright (c) 1980, 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the Institute of Electrical and Electronics Engineers, Inc.
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)printenv.1	6.7 (Berkeley) 7/28/91
.\"
.Dd July 28, 1991
.Dt PRINTENV 1
.Os BSD 3
.Sh NAME
.Nm printenv , env
.Nd print out the environment, set and print environment
.Sh SYNOPSIS
.Nm printenv
.Op Ar name
.Nm env
.Op Fl
.Op Ar name=value ...
.Op Ar command
.Sh DESCRIPTION
.Nm Printenv
prints out the names and values of the variables in the environment,
with one name/value pair per line.  If
.Ar name
is specified, only
its value is printed.
.Pp
If a
.Ar name
is specified and it is not defined in the environment,
.Nm printenv
returns exit status 1, else it returns status 0.
.Pp
.Nm Env
executes
.Ar command
after modifying the environment as
specified on the command line.  The option
.Ar name=value
specifies
an environmental variable,
.Ar name  ,
with a value of
.Ar value  .
The option
.Sq Fl
causes
.Nm env
to completely ignore the environment
it inherits.
.Pp
If no command is specified,
.Nm env
prints out the names and values
of the variables in the environment, with one name/value pair per line.
.Sh SEE ALSO
.Xr csh 1 ,
.Xr sh 1 ,
.Xr execvp 3 ,
.Xr environ 7
.Sh HISTORY
The
.Nm printenv
command appeared in
.Bx 3.0 .
.Sh BUGS
.Nm Env
doesn't handle commands with equal (``='') signs in their
names, for obvious reasons.
Commit	Line	Data
7b089094 WJ	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 28, 1991
	37	.Dt PRINTENV 1
	38	.Os BSD 3
	39	.Sh NAME
	40	.Nm printenv , env
	41	.Nd print out the environment, set and print environment
	42	.Sh SYNOPSIS
	43	.Nm printenv
	44	.Op Ar name
	45	.Nm env
	46	.Op Fl
	47	.Op Ar name=value ...
	48	.Op Ar command
	49	.Sh DESCRIPTION
	50	.Nm Printenv
	51	prints out the names and values of the variables in the environment,
	52	with one name/value pair per line. If
	53	.Ar name
	54	is specified, only
	55	its value is printed.
	56	.Pp
	57	If a
	58	.Ar name
	59	is specified and it is not defined in the environment,
	60	.Nm printenv
	61	returns exit status 1, else it returns status 0.
	62	.Pp
	63	.Nm Env
	64	executes
65	.Ar command
66	after modifying the environment as
67	specified on the command line. The option
68	.Ar name=value
69	specifies
70	an environmental variable,
71	.Ar name ,
72	with a value of
73	.Ar value .
74	The option
75	.Sq Fl
76	causes
77	.Nm env
78	to completely ignore the environment
79	it inherits.
80	.Pp
81	If no command is specified,
82	.Nm env
83	prints out the names and values
84	of the variables in the environment, with one name/value pair per line.
85	.Sh SEE ALSO
86	.Xr csh 1 ,
87	.Xr sh 1 ,
88	.Xr execvp 3 ,
89	.Xr environ 7
90	.Sh HISTORY
91	The
92	.Nm printenv
93	command appeared in
94	.Bx 3.0 .
95	.Sh BUGS
96	.Nm Env
97	doesn't handle commands with equal (``='') signs in their
98	names, for obvious reasons.