usr.bin/printenv/printenv.1

   1 .\" Copyright (c) 1980, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the Institute of Electrical and Electronics Engineers, Inc.
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by the University of
  17 .\"     California, Berkeley and its contributors.
  18 .\" 4. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)printenv.1  8.1 (Berkeley) 6/6/93
  35 .\" $FreeBSD: src/usr.bin/printenv/printenv.1,v 1.6.2.10 2002/06/26 08:25:30 tjr Exp $
  36 .\"
  37 .Dd June 6, 1993
  38 .Dt PRINTENV 1
  39 .Os
  40 .Sh NAME
  41 .Nm printenv , env
  42 .Nd print out the environment, set and print environment
  43 .Sh SYNOPSIS
  44 .Nm
  45 .Op Ar name
  46 .Nm env
  47 .Op Fl
  48 .Op Fl i
  49 .Op Ar name Ns = Ns Ar value ...
  50 .Op Ar utility Oo Ar argument ... Oc
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 utility prints out the names and values of the variables in the environment,
  55 with one name/value pair per line.
  56 If
  57 .Ar name
  58 is specified, only
  59 its value is printed.
  60 .Pp
  61 Some shells may provide a builtin
  62 .Nm
  63 command which is similar or identical to this utility.
  64 Consult the
  65 .Xr builtin 1
  66 manual page.
  67 .Pp
  68 The
  69 .Nm env
  70 utility executes
  71 .Ar utility
  72 after modifying the environment as
  73 specified on the command line.
  74 The option
  75 .Ar name Ns = Ns Ar value
  76 specifies
  77 an environment variable,
  78 .Ar name  ,
  79 with a value of
  80 .Ar value  .
  81 .Pp
  82 The options are as follows:
  83 .Bl -tag -width indent
  84 .It Fl i
  85 Execute the
  86 .Ar utility
  87 with only those environment values specified.
  88 The environment inherited
  89 by
  90 .Nm env
  91 is ignored completely.
  92 .It Fl
  93 Identical to the
  94 .Fl i
  95 option, available for backward compatibility.
  96 .El
  97 .Pp
  98 If no utility is specified,
  99 .Nm env
 100 prints out the names and values
 101 of the variables in the environment, with one name/value pair per line.
 102 .Pp
 103 The
 104 .Nm env
 105 utility is sometimes useful with the
 106 .Dq Li #!
 107 construct (see
 108 .Xr execve 2 ) .
 109 The only difference between
 110 .Dq Li #!/usr/local/bin/foo
 111 and
 112 .Dq Li "#!/usr/bin/env\ /usr/local/bin/foo"
 113 is that the latter works even if
 114 .Pa /usr/local/bin/foo
 115 is itself interpreted.
 116 Using
 117 .Nm env
 118 this way also allows one to reference
 119 .Pa foo
 120 without the path,
 121 as well as set up the environment as desired.
 122 .Sh DIAGNOSTICS
 123 .Ex -std printenv
 124 .Pp
 125 .Ex -std env
 126 An exit status of 126 indicates
 127 .Ar utility
 128 was found, but could not be executed.
 129 An exit status of 127 indicates
 130 .Ar utility
 131 could not be found.
 132 .Sh SEE ALSO
 133 .Xr csh 1 ,
 134 .Xr sh 1 ,
 135 .Xr execvp 3 ,
 136 .Xr environ 7
 137 .Sh STANDARDS
 138 The
 139 .Nm env
 140 utility conforms to
 141 .St -p1003.1-2001 .
 142 .Sh HISTORY
 143 The
 144 .Nm
 145 command appeared in
 146 .Bx 3.0 .
 147 .Sh BUGS
 148 The
 149 .Nm env
 150 utility doesn't handle utility arguments with equal (``='') signs in their
 151 names, for obvious reasons.