NetBSD/usr.bin/env/env.1

127 lines
3.4 KiB
Groff
Raw Normal View History

2002-09-30 15:08:56 +04:00
.\" $NetBSD: env.1,v 1.10 2002/09/30 11:08:59 grant Exp $
1997-01-09 23:18:21 +03:00
.\"
.\" 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.
.\"
1993-08-01 11:32:48 +04:00
.\" from: @(#)printenv.1 6.7 (Berkeley) 7/28/91
2002-09-30 15:08:56 +04:00
.\" $NetBSD: env.1,v 1.10 2002/09/30 11:08:59 grant Exp $
.\"
.Dd August 27, 1993
.Dt ENV 1
.Os
.Sh NAME
.Nm env
.Nd set and print environment
.Sh SYNOPSIS
1997-10-18 17:54:51 +04:00
.Nm
.Op Fl i
.Op Ar name=value ...
.Oo
.Ar utility
.Op argument ...
.Oc
.Sh DESCRIPTION
1997-10-18 17:54:51 +04:00
.Nm
executes
.Ar utility
after modifying the environment as
2002-09-30 15:08:56 +04:00
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
1997-10-18 17:54:51 +04:00
.Nm
to completely ignore the environment
it inherits.
.Pp
2001-12-01 19:43:07 +03:00
If no
.Ar utility
is specified,
1997-10-18 17:54:51 +04:00
.Nm
prints out the names and values
2001-12-01 19:43:07 +03:00
of the variables in the environment, with one
.Ar name=value
pair per line.
.Sh EXIT STATUS
2001-12-01 19:43:07 +03:00
If the
.Ar utility
2001-12-01 19:43:07 +03:00
is invoked, the exit status of
1997-10-18 17:54:51 +04:00
.Nm
shall be the exit status of
2001-12-01 22:07:26 +03:00
.Ar utility ;
otherwise, the
1997-10-18 17:54:51 +04:00
.Nm
utility exits with one of the following values:
.Bl -tag -width Ds
.It 0
2001-12-01 19:43:07 +03:00
The
1997-10-18 17:54:51 +04:00
.Nm
utility completed successfully
.It 1-125
1994-01-11 05:10:48 +03:00
An error occurred in the
1997-10-18 17:54:51 +04:00
.Nm
utility.
.It 126
The utility specified by
2001-12-01 19:43:07 +03:00
.Ar utility
was found, but could not be invoked.
.It 127
The utility specified by
2001-12-01 19:43:07 +03:00
.Ar utility
could not be found.
.El
.Sh COMPATIBILITY
2001-12-01 19:43:07 +03:00
The historic
.Fl
option has been deprecated but is still supported in this implementation.
.Sh SEE ALSO
.Xr execvp 3 ,
.Xr environ 7
.Sh STANDARDS
The
1997-10-18 17:54:51 +04:00
.Nm
utility conforms to
.St -p1003.2-92 .
.Sh BUGS
1997-10-18 17:54:51 +04:00
.Nm
doesn't handle commands with equal
.Pq Dq =
signs in their
names, for obvious reasons.