environ(5)

1ENVIRON(7)                 Linux Programmer's Manual                ENVIRON(7)
2
3
4

NAME

6       environ - user environment
7

SYNOPSIS

9       extern char **environ;
10

DESCRIPTION

12       The  variable  environ points to an array of pointers to strings called
13       the "environment".  The last pointer in this array has the value  NULL.
14       (This variable must be declared in the user program, but is declared in
15       the header file <unistd.h> in case the header files came from libc4  or
16       libc5,  and  in case they came from glibc and _GNU_SOURCE was defined.)
17       This array of strings is made available to the process by  the  exec(3)
18       call that started the process.
19
20       By  convention the strings in environ have the form "name=value".  Com‐
21       mon examples are:
22
23       USER   The name of the logged-in user (used by  some  BSD-derived  pro‐
24              grams).
25
26       LOGNAME
27              The  name  of  the logged-in user (used by some System-V derived
28              programs).
29
30       HOME   A user's login directory, set by login(1) from the password file
31              passwd(5).
32
33       LANG   The name of a locale to use for locale categories when not over‐
34              ridden by LC_ALL or more  specific  environment  variables  like
35              LC_COLLATE,   LC_CTYPE,  LC_MESSAGES,  LC_MONETARY,  LC_NUMERIC,
36              LC_TIME, cf.  locale(5).
37
38       PATH   The sequence of directory prefixes that  sh(1)  and  many  other
39              programs  apply  in  searching for a file known by an incomplete
40              pathname.  The prefixes are separated by  ':'.   (Similarly  one
41              has  CDPATH  used  by some shells to find the target of a change
42              directory command, MANPATH used by man(1) to find manual  pages,
43              etc.)
44
45       PWD    The current working directory.  Set by some shells.
46
47       SHELL  The pathname of the user's login shell.
48
49       TERM   The terminal type for which output is to be prepared.
50
51       PAGER  The user's preferred utility to display text files.
52
53       EDITOR/VISUAL
54              The user's preferred utility to edit text files.
55
56       Further  names  may  be placed in the environment by the export command
57       and "name=value" in sh(1), or by the setenv command if you use  csh(1).
58       Arguments  may  also  be  placed  in the environment at the point of an
59       exec(3).  A C program can manipulate its environment  using  the  func‐
60       tions getenv(3), putenv(3), setenv(3), and unsetenv(3).
61
62       Note  that the behavior of many programs and library routines is influ‐
63       enced by the presence or value of  certain  environment  variables.   A
64       random collection:
65
66       The  variables  LANG,  LANGUAGE, NLSPATH, LOCPATH, LC_ALL, LC_MESSAGES,
67       etc. influence locale handling, cf.  locale(5).
68
69       TMPDIR influences the path prefix of names  created  by  tmpnam(3)  and
70       other  routines, the temporary directory used by sort(1) and other pro‐
71       grams, etc.
72
73       LD_LIBRARY_PATH, LD_PRELOAD and  other  LD_*  variables  influence  the
74       behavior of the dynamic loader/linker.
75
76       POSIXLY_CORRECT  makes certain programs and library routines follow the
77       prescriptions of POSIX.
78
79       The behavior of malloc(3) is influenced by MALLOC_* variables.
80
81       The variable HOSTALIASES gives the name of a file containing aliases to
82       be used with gethostbyname(3).
83
84       TZ  and  TZDIR  give  timezone information used by tzset(3) and through
85       that by functions like ctime(3), localtime(3), mktime(3),  strftime(3).
86       See also tzselect(8).
87
88       TERMCAP  gives information on how to address a given terminal (or gives
89       the name of a file containing such information).
90
91       COLUMNS and LINES tell applications about  the  window  size,  possibly
92       overriding the actual size.
93
94       PRINTER or LPDEST may specify the desired printer to use.  See lpr(1).
95
96       Etc.
97

BUGS

99       Clearly  there is a security risk here.  Many a system command has been
100       tricked into mischief by a user who specified unusual values for IFS or
101       LD_LIBRARY_PATH.
102
103       There is also the risk of name space pollution.  Programs like make and
104       autoconf allow overriding of default utility names from the environment
105       with similarly named variables in all caps.  Thus one uses CC to select
106       the desired C compiler (and similarly MAKE, AR, AS, FC,  LD,  LEX,  RM,
107       YACC,  etc.).   However,  in  some traditional uses such an environment
108       variable gives options for the program instead of  a  pathname.   Thus,
109       one  has  MORE, LESS, and GZIP.  Such usage is considered mistaken, and
110       to be avoided in new programs.  The authors  of  gzip  should  consider
111       renaming their option to GZIP_OPT.
112

COLOPHON

118       This page is part of release 3.22 of the Linux  man-pages  project.   A
119       description  of  the project, and information about reporting bugs, can
120       be found at http://www.kernel.org/doc/man-pages/.
121
122
123
124Linux                             2009-07-25                        ENVIRON(7)

NAME

SYNOPSIS

DESCRIPTION

BUGS

SEE ALSO

COLOPHON