freebsd-nq/usr.bin/printenv/printenv.1

.\" Copyright (c) 1980, 1990, 1993
.\"	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	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd June 6, 1993
.Dt PRINTENV 1
.Os
.Sh NAME
.Nm printenv , env
.Nd print out the environment, set and print environment
.Sh SYNOPSIS
.Nm
.Op Ar name
.Nm env
.Op Fl
.Op Fl i
.Op Ar name Ns = Ns Ar value ...
.Op Ar command
.Sh DESCRIPTION
The
.Nm
utility 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
Some shells may provide a builtin
.Nm
command which is similar or identical to this utility.
Consult the
.Xr builtin 1
manual page.
.Pp
The
.Nm env
utility executes
.Ar command
after modifying the environment as
specified on the command line.
The option
.Ar name Ns = Ns Ar value
specifies
an environment variable,
.Ar name  ,
with a value of
.Ar value  .
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl i
Execute the
.Ar command
with only those environment values specified.
The environment inherited
by
.Nm env
is ignored completely.
.It Fl
Identical to the
.Fl i
option, available for backward compatibility.
.El
.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.
.Pp
The
.Nm env
utility is sometimes useful with the
.Dq Li #!
construct (see
.Xr execve 2 ) .
The only difference between
.Dq Li #!/usr/local/bin/foo
and
.Dq Li "#!/usr/bin/env\ /usr/local/bin/foo"
is that the latter works even if
.Pa /usr/local/bin/foo
is itself interpreted.
Using
.Nm env
this way also allows one to reference
.Pa foo
without the path,
as well as set up the environment as desired.
.Sh DIAGNOSTICS
.Ex -std printenv
.Pp
.Ex -std env
An exit status of 126 indicates
.Ar command
was found, but could not be executed.
An exit status of 127 indicates
.Ar command
could not be found.
.Sh SEE ALSO
.Xr csh 1 ,
.Xr sh 1 ,
.Xr execvp 3 ,
.Xr environ 7
.Sh STANDARDS
The
.Nm env
utility conforms to
.St -p1003.1-2001 .
.Sh HISTORY
The
.Nm
command appeared in
.Bx 3.0 .
.Sh BUGS
The
.Nm env
utility doesn't handle commands with equal (``='') signs in their
names, for obvious reasons.
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1980, 1990, 1993`
			`.\" 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 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
			`.Dd June 6, 1993`
			`.Dt PRINTENV 1`
mdoc(7) police: fixed formatting. 2001-07-05 06:35:03 +00:00			`.Os`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh NAME`
			`.Nm printenv , env`
			`.Nd print out the environment, set and print environment`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Ar name`
			`.Nm env`
			`.Op Fl`
Add ``-i'' option, which is the same as ``-''. The -i option is the recommended option in the manpage, but the - option remains for backward compatibility and is documented as such. PR: 13363 Reported by: James Howard <howardjp@wam.umd.edu> Reviewed by: bde 1999-08-27 08:59:32 +00:00			`.Op Fl i`
mdoc(7) police: fixed formatting. 2001-07-05 06:35:03 +00:00			`.Op Ar name Ns = Ns Ar value ...`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Op Ar command`
			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
			`.Nm`
			`utility prints out the names and values of the variables in the environment,`
mdoc(7) police: fixed formatting. 2001-07-05 06:35:03 +00:00			`with one name/value pair per line.`
			`If`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Ar name`
			`is specified, only`
			`its value is printed.`
			`.Pp`
The printenv(1) command is now a builtin(1) in csh(1). 2000-05-09 15:02:03 +00:00			`Some shells may provide a builtin`
			`.Nm`
			`command which is similar or identical to this utility.`
			`Consult the`
			`.Xr builtin 1`
			`manual page.`
			`.Pp`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
			`.Nm env`
			`utility executes`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Ar command`
			`after modifying the environment as`
mdoc(7) police: fixed formatting. 2001-07-05 06:35:03 +00:00			`specified on the command line.`
			`The option`
			`.Ar name Ns = Ns Ar value`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`specifies`
environmental -> environment. 1997-08-04 06:40:41 +00:00			`an environment variable,`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Ar name ,`
			`with a value of`
			`.Ar value .`
Add ``-i'' option, which is the same as ``-''. The -i option is the recommended option in the manpage, but the - option remains for backward compatibility and is documented as such. PR: 13363 Reported by: James Howard <howardjp@wam.umd.edu> Reviewed by: bde 1999-08-27 08:59:32 +00:00			`.Pp`
			`The options are as follows:`
			`.Bl -tag -width indent`
			`.It Fl i`
			`Execute the`
			`.Ar command`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 12:20:22 +00:00			`with only those environment values specified.`
			`The environment inherited`
Add ``-i'' option, which is the same as ``-''. The -i option is the recommended option in the manpage, but the - option remains for backward compatibility and is documented as such. PR: 13363 Reported by: James Howard <howardjp@wam.umd.edu> Reviewed by: bde 1999-08-27 08:59:32 +00:00			`by`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Nm env`
Add ``-i'' option, which is the same as ``-''. The -i option is the recommended option in the manpage, but the - option remains for backward compatibility and is documented as such. PR: 13363 Reported by: James Howard <howardjp@wam.umd.edu> Reviewed by: bde 1999-08-27 08:59:32 +00:00			`is ignored completely.`
			`.It Fl`
			`Identical to the`
			`.Fl i`
			`option, available for backward compatibility.`
			`.El`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.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.`
Mention how env(1) can be used with the "#!" construct. PR: 27690 Submitted by: Mike Meyer <mwm@mired.org> 2001-05-30 03:15:39 +00:00			`.Pp`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
Mention how env(1) can be used with the "#!" construct. PR: 27690 Submitted by: Mike Meyer <mwm@mired.org> 2001-05-30 03:15:39 +00:00			`.Nm env`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`utility is sometimes useful with the`
mdoc(7) police: fixed formatting. 2001-07-05 06:35:03 +00:00			`.Dq Li #!`
Mention how env(1) can be used with the "#!" construct. PR: 27690 Submitted by: Mike Meyer <mwm@mired.org> 2001-05-30 03:15:39 +00:00			`construct (see`
			`.Xr execve 2 ) .`
			`The only difference between`
mdoc(7) police: fixed formatting. 2001-07-05 06:35:03 +00:00			`.Dq Li #!/usr/local/bin/foo`
Mention how env(1) can be used with the "#!" construct. PR: 27690 Submitted by: Mike Meyer <mwm@mired.org> 2001-05-30 03:15:39 +00:00			`and`
mdoc(7) police: fixed formatting. 2001-07-05 06:35:03 +00:00			`.Dq Li "#!/usr/bin/env\ /usr/local/bin/foo"`
Mention how env(1) can be used with the "#!" construct. PR: 27690 Submitted by: Mike Meyer <mwm@mired.org> 2001-05-30 03:15:39 +00:00			`is that the latter works even if`
			`.Pa /usr/local/bin/foo`
			`is itself interpreted.`
			`Using`
			`.Nm env`
			`this way also allows one to reference`
			`.Pa foo`
			`without the path,`
			`as well as set up the environment as desired.`
Use new ID scheme. Fix env(1)'s exit status to conform with SUSv3. Submitted by: Tim Robbins <tim@robbins.dropbear.id.au> MFC after: 2 weeks 2002-02-21 02:17:57 +00:00			`.Sh DIAGNOSTICS`
			`.Ex -std printenv`
			`.Pp`
			`.Ex -std env`
			`An exit status of 126 indicates`
			`.Ar command`
			`was found, but could not be executed.`
			`An exit status of 127 indicates`
			`.Ar command`
			`could not be found.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh SEE ALSO`
			`.Xr csh 1 ,`
			`.Xr sh 1 ,`
			`.Xr execvp 3 ,`
			`.Xr environ 7`
Use new ID scheme. Fix env(1)'s exit status to conform with SUSv3. Submitted by: Tim Robbins <tim@robbins.dropbear.id.au> MFC after: 2 weeks 2002-02-21 02:17:57 +00:00			`.Sh STANDARDS`
			`The`
			`.Nm env`
			`utility conforms to`
			`.St -p1003.1-2001 .`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.Sh HISTORY`
			`The`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`command appeared in`
			`.Bx 3.0 .`
			`.Sh BUGS`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
			`.Nm env`
			utility doesn't handle commands with equal (``='') signs in their
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`names, for obvious reasons.`