diff options
author | Eric Blake <ebb9@byu.net> | 2009-10-27 17:20:56 -0600 |
---|---|---|
committer | Eric Blake <ebb9@byu.net> | 2009-10-27 19:55:37 -0600 |
commit | 75efc921b08a9fddf65cdc182ef8ae5cdce4269a (patch) | |
tree | 65441e80c20ddb735ef14f478e768f926101192f /doc | |
parent | d6de2f198ef0f59f5210af0bf9bcf42687386a04 (diff) | |
download | coreutils-75efc921b08a9fddf65cdc182ef8ae5cdce4269a.tar.xz |
doc: turn env comments into documentation
* src/env.c: Convert introductory comments...
* doc/coreutils.texi (env invocation): ...into documentation.
Suggested by Jim Meyering.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/coreutils.texi | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/doc/coreutils.texi b/doc/coreutils.texi index c5f5135b7..9b9f73bef 100644 --- a/doc/coreutils.texi +++ b/doc/coreutils.texi @@ -14442,6 +14442,57 @@ If no command name is specified following the environment specifications, the resulting environment is printed. This is like specifying the @command{printenv} program. +For some examples, suppose the environment passed to @command{env} +contains @samp{LOGNAME=rms}, @samp{EDITOR=emacs}, and +@samp{PATH=.:/gnubin:/hacks}: + +@itemize @bullet + +@item +Output the current environment. +@example +$ env | LC_ALL=C sort +EDITOR=emacs +LOGNAME=rms +PATH=.:/gnubin:/hacks +@end example + +@item +Run @command{foo} with a reduced environment, preserving only the +original @env{PATH} to avoid problems in locating @command{foo}. +@example +env - PATH="$PATH" foo +@end example + +@item +Run @command{foo} with the environment containing @samp{LOGNAME=rms}, +@samp{EDITOR=emacs}, and @samp{PATH=.:/gnubin:/hacks}, and guarantees +that @command{foo} was found in the file system rather than a shell +builtin. +@example +env foo +@end example + +@item +Run @command{nemacs} with the environment containing @samp{LOGNAME=foo}, +@samp{EDITOR=emacs}, @samp{PATH=.:/gnubin:/hacks}, and +@samp{DISPLAY=gnu:0}. +@example +env DISPLAY=gnu:0 LOGNAME=foo nemacs +@end example + +@item +Attempt to run the program @command{/energy/--} (as that is the only +possible path search result); if the command exists, the environment +will contain @samp{LOGNAME=rms} and @samp{PATH=/energy}, and the +arguments will be @samp{e=mc2}, @samp{bar}, and @samp{baz}. +@example +env -u EDITOR PATH=/energy -- e=mc2 bar baz +@end example + +@end itemize + + The program accepts the following options. Also see @ref{Common options}. Options must precede operands. |