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