xref: /openbsd/usr.bin/env/env.1 (revision a4e071cf)

.\"	$OpenBSD: env.1,v 1.20 2015/01/12 21:42:53 deraadt Exp $
.\" 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. 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
.\"
.Dd $Mdocdate: January 12 2015 $
.Dt ENV 1
.Os
.Sh NAME
.Nm env
.Nd set and print environment
.Sh SYNOPSIS
.Nm env
.Op Fl i
.Oo
.Ar name Ns = Ns Ar value ...
.Oc
.Oo
.Ar utility
.Op Ar argument ...
.Oc
.Sh DESCRIPTION
.Nm
executes
.Ar utility
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 Ds
.It Fl i
Causes
.Nm
to completely ignore the environment it inherits.
.El
.Pp
If no
.Ar utility
is specified,
.Nm
prints out the names and values
of the variables in the environment, with one
.Ar name Ns = Ns Ar value
pair per line.
.Pp
.Nm
doesn't handle commands with equal
.Pq Sq =
signs in their
names, for obvious reasons.
.Sh EXIT STATUS
The
.Nm
utility exits with one of the following values:
.Bl -tag -width Ds
.It 0
.Nm
completed successfully and, if
.Ar utility
was specified, it was invoked and completed successfully too.
.It 1
An invalid command line option was passed to
.Nm
and
.Ar utility
was not invoked, or
.Ar utility
was invoked but failed with exit status 1.
.It 2\(en125, 128\(en255
.Ar utility
was invoked but failed with this exit status;
see its manual page for more information.
.It 126
.Ar utility
was found but could not be invoked, or it was invoked but failed
with exit status 126.
.It 127
.Ar utility
could not be found, or it was invoked but failed with exit status 127.
.El
.Sh SEE ALSO
.Xr execvp 3 ,
.Xr environ 7
.Sh STANDARDS
The
.Nm
utility is compliant with the
.St -p1003.1-2008
specification.
.Pp
The historic
.Fl
option has been deprecated but is still supported in this implementation.