Annotation of src/usr.bin/env/env.1, Revision 1.7
1.7 ! deraadt 1: .\" $OpenBSD: env.1,v 1.6 2000/03/05 20:09:22 aaron Exp $
1.1 deraadt 2: .\" Copyright (c) 1980, 1990 The Regents of the University of California.
3: .\" All rights reserved.
4: .\"
5: .\" This code is derived from software contributed to Berkeley by
6: .\" the Institute of Electrical and Electronics Engineers, Inc.
7: .\" Redistribution and use in source and binary forms, with or without
8: .\" modification, are permitted provided that the following conditions
9: .\" are met:
10: .\" 1. Redistributions of source code must retain the above copyright
11: .\" notice, this list of conditions and the following disclaimer.
12: .\" 2. Redistributions in binary form must reproduce the above copyright
13: .\" notice, this list of conditions and the following disclaimer in the
14: .\" documentation and/or other materials provided with the distribution.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by the University of
18: .\" California, Berkeley and its contributors.
19: .\" 4. Neither the name of the University nor the names of its contributors
20: .\" may be used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: .\" SUCH DAMAGE.
34: .\"
35: .\" from: @(#)printenv.1 6.7 (Berkeley) 7/28/91
36: .\"
37: .Dd August 27, 1993
38: .Dt ENV 1
39: .Os
40: .Sh NAME
41: .Nm env
42: .Nd set and print environment
43: .Sh SYNOPSIS
44: .Nm env
45: .Op Fl i
1.5 aaron 46: .Oo
47: .Ar name Ns No = Ns Ar value ...
48: .Oc
1.1 deraadt 49: .Oo
50: .Ar utility
1.4 aaron 51: .Op Ar argument ...
1.1 deraadt 52: .Oc
53: .Sh DESCRIPTION
1.5 aaron 54: .Nm
1.1 deraadt 55: executes
56: .Ar utility
57: after modifying the environment as
1.6 aaron 58: specified on the command line.
59: The option
1.5 aaron 60: .Ar name Ns No = Ns Ar value
1.1 deraadt 61: specifies
1.2 deraadt 62: an environment variable,
1.6 aaron 63: .Ar name ,
1.1 deraadt 64: with a value of
1.6 aaron 65: .Ar value .
66: .Pp
67: The options are as follows:
68: .Bl -tag -width Ds
69: .It Fl i
70: Causes
1.5 aaron 71: .Nm
1.6 aaron 72: to completely ignore the environment it inherits.
73: .El
1.1 deraadt 74: .Pp
1.5 aaron 75: If no
1.1 deraadt 76: .Ar utility
77: is specified,
1.5 aaron 78: .Nm
1.1 deraadt 79: prints out the names and values
1.5 aaron 80: of the variables in the environment, with one
81: .Ar name Ns No = Ns Ar value
1.1 deraadt 82: pair per line.
83: .Sh DIAGNOSTICS
1.5 aaron 84: If the
1.1 deraadt 85: .Ar utility
1.5 aaron 86: is invoked, the exit status of
87: .Nm
1.1 deraadt 88: shall be the exit status of
1.4 aaron 89: .Ar utility ;
1.1 deraadt 90: otherwise, the
1.5 aaron 91: .Nm
1.1 deraadt 92: utility exits with one of the following values:
93: .Bl -tag -width Ds
94: .It 0
1.5 aaron 95: The
96: .Nm
1.4 aaron 97: utility completed successfully.
1.1 deraadt 98: .It 1-125
1.7 ! deraadt 99: The exit code returned from the
! 100: .Ar utility.
1.1 deraadt 101: .It 126
102: The utility specified by
1.5 aaron 103: .Ar utility
1.1 deraadt 104: was found, but could not be invoked.
105: .It 127
106: The utility specified by
1.5 aaron 107: .Ar utility
1.1 deraadt 108: could not be found.
109: .El
110: .Sh COMPATIBILITY
1.5 aaron 111: The historic
112: .Fl
1.1 deraadt 113: option has been deprecated but is still supported in this implementation.
114: .Sh SEE ALSO
115: .Xr execvp 3 ,
116: .Xr environ 7
117: .Sh STANDARDS
118: The
1.5 aaron 119: .Nm
1.1 deraadt 120: utility conforms to
121: .St -p1003.2-92 .
122: .Sh BUGS
1.5 aaron 123: .Nm
1.1 deraadt 124: doesn't handle commands with equal
1.4 aaron 125: .Pq Sq =
1.1 deraadt 126: signs in their
127: names, for obvious reasons.
![[BACK]](/icons/back.gif){kind=icon}
Return to env.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / env