From 75efc921b08a9fddf65cdc182ef8ae5cdce4269a Mon Sep 17 00:00:00 2001 From: Eric Blake Date: Tue, 27 Oct 2009 17:20:56 -0600 Subject: doc: turn env comments into documentation * src/env.c: Convert introductory comments... * doc/coreutils.texi (env invocation): ...into documentation. Suggested by Jim Meyering. --- src/env.c | 66 --------------------------------------------------------------- 1 file changed, 66 deletions(-) (limited to 'src/env.c') diff --git a/src/env.c b/src/env.c index c20b057bc..4c0deade2 100644 --- a/src/env.c +++ b/src/env.c @@ -16,72 +16,6 @@ /* Richard Mlynarik and David MacKenzie */ -/* Options: - - - -i - --ignore-environment - Construct a new environment from scratch; normally the - environment is inherited from the parent process, except as - modified by other options. - - -u variable - --unset=variable - Unset variable VARIABLE (remove it from the environment). - If VARIABLE was not set, does nothing. - - -0 - --null - When no program is specified, output environment information - terminated by NUL bytes rather than newlines. - - variable=value (an arg containing a "=" character) - Set the environment variable VARIABLE to value VALUE. VALUE - may be of zero length ("variable="). Setting a variable to a - zero-length value is different from unsetting it. - - -- - Indicate that the following argument is not an option. - This is necessary when the program's name begins with "-", - but does not help if the program's name contains a "=". - - The first remaining argument specifies a program to invoke; - it is searched for according to the specification of the PATH - environment variable, after environment modifications. Any - arguments following that are passed as arguments to that program. - - If no command name is specified following the environment - specifications, the resulting environment is printed. - This is like specifying a command name of "printenv". - - Examples: - - If the environment passed to "env" is - { LOGNAME=rms EDITOR=emacs PATH=.:/gnubin:/hacks } - - env - foo - runs "foo" in a null environment. - - env foo - runs "foo" in the environment - { LOGNAME=rms EDITOR=emacs PATH=.:/gnubin:/hacks } - - env DISPLAY=gnu:0 nemacs - runs "nemacs" in the environment - { LOGNAME=rms EDITOR=emacs PATH=.:/gnubin:/hacks DISPLAY=gnu:0 } - - env - LOGNAME=foo /hacks/hack bar baz - runs the "hack" program on arguments "bar" and "baz" in an - environment in which the only variable is "LOGNAME". Note that - the "-" option clears out the PATH variable, so one should be - careful to specify in which directory to find the program to - call. - - env -u EDITOR LOGNAME=foo PATH=/energy -- e=mc2 bar baz - attempts to run the program "/energy/--" with arguments - "e=mc2", "bar" and "baz" in the environment - { LOGNAME=foo PATH=/energy }. -*/ - #include #include #include -- cgit v1.2.3-54-g00ecf