src/env.c

   1 /* env - run a program in a modified environment
   2    Copyright (C) 1986, 1991-2005, 2007-2008 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 /* Richard Mlynarik and David MacKenzie */
  18
  19 /* Options:
  20    -
  21    -i
  22    --ignore-environment
  23         Construct a new environment from scratch; normally the
  24         environment is inherited from the parent process, except as
  25         modified by other options.
  26
  27    -u variable
  28    --unset=variable
  29         Unset variable VARIABLE (remove it from the environment).
  30         If VARIABLE was not set, does nothing.
  31
  32    variable=value (an arg containing a "=" character)
  33         Set the environment variable VARIABLE to value VALUE.  VALUE
  34         may be of zero length ("variable=").  Setting a variable to a
  35         zero-length value is different from unsetting it.
  36
  37    --
  38         Indicate that the following argument is the program
  39         to invoke.  This is necessary when the program's name
  40         begins with "-" or contains a "=".
  41
  42    The first remaining argument specifies a program to invoke;
  43    it is searched for according to the specification of the PATH
  44    environment variable.  Any arguments following that are
  45    passed as arguments to that program.
  46
  47    If no command name is specified following the environment
  48    specifications, the resulting environment is printed.
  49    This is like specifying a command name of "printenv".
  50
  51    Examples:
  52
  53    If the environment passed to "env" is
  54         { LOGNAME=rms EDITOR=emacs PATH=.:/gnubin:/hacks }
  55
  56    env - foo
  57         runs "foo" in a null environment.
  58
  59    env foo
  60         runs "foo" in the environment
  61         { LOGNAME=rms EDITOR=emacs PATH=.:/gnubin:/hacks }
  62
  63    env DISPLAY=gnu:0 nemacs
  64         runs "nemacs" in the environment
  65         { LOGNAME=rms EDITOR=emacs PATH=.:/gnubin:/hacks DISPLAY=gnu:0 }
  66
  67    env - LOGNAME=foo /hacks/hack bar baz
  68         runs the "hack" program on arguments "bar" and "baz" in an
  69         environment in which the only variable is "LOGNAME".  Note that
  70         the "-" option clears out the PATH variable, so one should be
  71         careful to specify in which directory to find the program to
  72         call.
  73
  74    env -u EDITOR LOGNAME=foo PATH=/energy -- e=mc2 bar baz
  75         runs the program "/energy/e=mc2" with environment
  76         { LOGNAME=foo PATH=/energy }
  77 */
  78
  79 #include <config.h>
  80 #include <stdio.h>
  81 #include <sys/types.h>
  82 #include <getopt.h>
  83
  84 #include "system.h"
  85 #include "error.h"
  86
  87 /* The official name of this program (e.g., no `g' prefix).  */
  88 #define PROGRAM_NAME "env"
  89
  90 #define AUTHORS \
  91   proper_name ("Richard Mlynarik"), \
  92   proper_name ("David MacKenzie")
  93
  94 int putenv ();
  95
  96 extern char **environ;
  97
  98 static struct option const longopts[] =
  99 {
 100   {"ignore-environment", no_argument, NULL, 'i'},
 101   {"unset", required_argument, NULL, 'u'},
 102   {GETOPT_HELP_OPTION_DECL},
 103   {GETOPT_VERSION_OPTION_DECL},
 104   {NULL, 0, NULL, 0}
 105 };
 106
 107 void
 108 usage (int status)
 109 {
 110   if (status != EXIT_SUCCESS)
 111     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 112              program_name);
 113   else
 114     {
 115       printf (_("\
 116 Usage: %s [OPTION]... [-] [NAME=VALUE]... [COMMAND [ARG]...]\n"),
 117               program_name);
 118       fputs (_("\
 119 Set each NAME to VALUE in the environment and run COMMAND.\n\
 120 \n\
 121   -i, --ignore-environment   start with an empty environment\n\
 122   -u, --unset=NAME           remove variable from the environment\n\
 123 "), stdout);
 124       fputs (HELP_OPTION_DESCRIPTION, stdout);
 125       fputs (VERSION_OPTION_DESCRIPTION, stdout);
 126       fputs (_("\
 127 \n\
 128 A mere - implies -i.  If no COMMAND, print the resulting environment.\n\
 129 "), stdout);
 130       emit_bug_reporting_address ();
 131     }
 132   exit (status);
 133 }
 134
 135 int
 136 main (int argc, char **argv)
 137 {
 138   int optc;
 139   bool ignore_environment = false;
 140
 141   initialize_main (&argc, &argv);
 142   set_program_name (argv[0]);
 143   setlocale (LC_ALL, "");
 144   bindtextdomain (PACKAGE, LOCALEDIR);
 145   textdomain (PACKAGE);
 146
 147   initialize_exit_failure (EXIT_FAILURE);
 148   atexit (close_stdout);
 149
 150   while ((optc = getopt_long (argc, argv, "+iu:", longopts, NULL)) != -1)
 151     {
 152       switch (optc)
 153         {
 154         case 'i':
 155           ignore_environment = true;
 156           break;
 157         case 'u':
 158           break;
 159         case_GETOPT_HELP_CHAR;
 160         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 161         default:
 162           usage (EXIT_FAILURE);
 163         }
 164     }
 165
 166   if (optind < argc && STREQ (argv[optind], "-"))
 167     ignore_environment = true;
 168
 169   if (ignore_environment)
 170     {
 171       static char *dummy_environ[] = { NULL };
 172       environ = dummy_environ;
 173     }
 174
 175   optind = 0;                   /* Force GNU getopt to re-initialize. */
 176   while ((optc = getopt_long (argc, argv, "+iu:", longopts, NULL)) != -1)
 177     if (optc == 'u')
 178       putenv (optarg);          /* Requires GNU putenv. */
 179
 180   if (optind < argc && STREQ (argv[optind], "-"))
 181     ++optind;
 182
 183   while (optind < argc && strchr (argv[optind], '='))
 184     putenv (argv[optind++]);
 185
 186   /* If no program is specified, print the environment and exit. */
 187   if (argc <= optind)
 188     {
 189       char *const *e = environ;
 190       while (*e)
 191         puts (*e++);
 192       exit (EXIT_SUCCESS);
 193     }
 194
 195   execvp (argv[optind], &argv[optind]);
 196
 197   {
 198     int exit_status = (errno == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
 199     error (0, errno, "%s", argv[optind]);
 200     exit (exit_status);
 201   }
 202 }