NetBSD/usr.bin/env/env.1

115 lines
3.3 KiB
Groff

.\" 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.
.\"
.\" from: @(#)printenv.1 6.7 (Berkeley) 7/28/91
.\" $Id: env.1,v 1.2 1993/08/01 07:33:12 mycroft Exp $
.\"
.Dd July 14, 1993
.Dt ENV 1
.Os
.Sh NAME
.Nm env
.Nd set and print environment
.Sh SYNOPSIS
.Nm env
.Op Fl i
.Op Ar name=value ...
.Oo
.Ar command
.Op argument ...
.Oc
.Sh DESCRIPTION
.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 i
causes
.Nm env
to completely ignore the environment
it inherits.
.Pp
If no
.Ar 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 DIAGNOSTICS
If the
.Ar command
is invoked, the exit status of
.Nm env
shall be the exit status of
.Ar command ;
otherwise, the
.Nm env
command exits with one of the following values:
.Bl -tag -width Ds
.It 0
The
.Nm env
command completed successfully
.It 1-125
An error occured.
.It 126
The
.Ar command
was found, but could not be invoked.
.It 127
The
.Ar command
could not be found.
.El
.Sh SEE ALSO
.Xr execvp 3 ,
.Xr environ 7
.Sh STANDARDS
The
.Nm env
command is expected to be
.St -p1003.2
compliant.
.Sh BUGS
.Nm env
doesn't handle commands with equal (``='') signs in their
names, for obvious reasons.