Difference between revisions of "Environment variables"

From ArchWiki
Jump to: navigation, search
m (Examples: Added recognized values of $DE)
(Examples: create subsection for default programs)
 
(104 intermediate revisions by 39 users not shown)
Line 1: Line 1:
 
[[Category:System administration]]
 
[[Category:System administration]]
 
[[de:Umgebungsvariablen]]
 
[[de:Umgebungsvariablen]]
An environment variable is a named object that contains data used by one or more applications. In simple terms, it is a variable with a name and a value. The value of an environmental variable can for example be the location of all executable files in the filesystem, the default editor that should be used, or the system locale settings. Users new to Linux may often find this way of managing settings a bit unmanageable. However, environment variables provides a simple way to share configuration settings between multiple applications and processes in Linux.
+
[[es:Environment variables]]
 +
[[ja:環境変数]]
 +
[[pt:Environment variables]]
 +
[[ru:Environment variables]]
 +
[[zh-hans:Environment variables]]
 +
{{Related articles start}}
 +
{{Related|Default applications}}
 +
{{Related articles end}}
  
==Utilities==
+
An environment variable is a named object that contains data used by one or more applications. In simple terms, it is a variable with a name and a value. The value of an environmental variable can for example be the location of all executable files in the file system, the default editor that should be used, or the system locale settings. Users new to Linux may often find this way of managing settings a bit unmanageable. However, environment variables provide a simple way to share configuration settings between multiple applications and processes in Linux.
The {{Pkg|coreutils}} package contains {{ic|printenv}} and {{ic|env}}. To list the current environmental variables, use {{ic|printenv}} to print the names and the values of each. Note that some environment variables are user-specific - check by comparing the {{ic|printenv}} output as root:
+
 
 +
== Utilities ==
 +
 
 +
The {{Pkg|coreutils}} package contains the programs ''printenv'' and ''env''. To list the current environmental variables with values:  
  
 
  $ printenv
 
  $ printenv
  
The {{ic|env}} utility can be used to run a command under a modified environment. In the simplest case:
+
{{Note|Some environment variables are user-specific. Check by comparing the outputs of ''printenv'' as an unprivileged user and as ''root''.}}
 +
 
 +
The {{ic|env}} utility can be used to run a command under a modified environment. The following example will launch ''xterm'' with the environment variable {{ic|EDITOR}} set to {{ic|vim}}. This will not affect the global environment variable {{ic|EDITOR}}.
  
 
  $ env EDITOR=vim xterm
 
  $ env EDITOR=vim xterm
  
will set the default editor to vim in the new xterm session. This will not affect the {{ic|EDITOR}} outside this session.
+
The [[Bash]] builtin ''set'' allows you to change the values of shell options and set the positional parameters, or to display the names and values of shell variables. For more information, see [http://www.gnu.org/software/bash/manual/bash.html#The-Set-Builtin the set builtin documentation].
  
The [[Bash]] builtin {{ic|set}} allows you to change the values of shell options and set the positional parameters, or to display the names and values of shell variables. For more information see [http://www.gnu.org/software/bash/manual/bash.html#The-Set-Builtin documentation] on  {{ic|set}} built-in command.
+
Each process stores their environment in the {{ic|/proc/$PID/environ}} file. This file contained each key value pair delimited by a nul character ({{ic|\x0}}). A more human readable format can be obtained with [[sed]], e.g. {{ic|sed 's:\x0:\n:g' /proc/$PID/environ}}.
  
==Examples==
+
== Defining variables ==
The following section lists a number of common environment variables used by a Linux system and describes their values.
+
 
 +
=== Globally ===
 +
 
 +
Most Linux distributions tell you to change or add environment variable definitions in {{ic|/etc/profile}} or other locations. Keep in mind that there are also package-specific configuration files containing variable settings such as {{ic|/etc/locale.conf}}. Be sure to maintain and manage the environment variables and pay attention to the numerous files that can contain environment variables. In principle, any shell script can be used for initializing environmental variables, but following traditional UNIX conventions, these statements should be only be present in some particular files.
 +
 
 +
The following files should be used for defining global environment variables on your system: {{ic|/etc/environment}}, {{ic|/etc/profile}} and shell specific configuration files. Each of these files has different limitations, so you should carefully select the appropriate one for your purposes.
 +
 
 +
* {{ic|/etc/environment}} is used by the pam_env module and is shell agnostic so scripting or glob expansion cannot be used. The file only accepts {{ic|1=''variable=value''}} pairs. See {{man|8|pam_env}} and {{man|5|pam_env.conf}} for details.
 +
* Global configuration files of your [[shell]], initializes variables and runs scripts. For example [[Bash#Configuration files]] or [[Zsh#Startup/Shutdown files]].
 +
* {{ic|/etc/profile}} initializes variables for login shells ''only''. It does, however, run scripts and can be used by all [[wikipedia:Bourne shell|Bourne shell]] compatible shells.
  
*{{ic|DE}} indicate the '''D'''esktop '''E'''nvironment being used. [[xdg-open]] will use it to chose more user-friendly file-opener application that desktop environment provides. Some packages need to be installed to use this feature. For GNOME, that would be {{pkg|libgnome}}. For Xfce, 'exo'. Recognised values of {{ic|DE}} variable are: '''gnome''', '''kde''', '''xfce''', '''lxde''' and '''mate'''.
+
In this example, we add {{ic|~/bin}} directory to the {{ic|PATH}} for respective user. To do this, just put this in your preferred global environment variable config file ({{ic|/etc/profile}} or {{ic|/etc/bash.bashrc}}):
  
The {{ic|$DE}} environment variable needs to be exported before starting the window manager. For example:
+
{{bc|<nowiki>
{{hc|~/.xinitrc|<nowiki>
+
# If user ID is greater than or equal to 1000 & if ~/bin exists and is a directory & if ~/bin is not already in your $PATH
export DE="xfce"
+
# then export ~/bin to your $PATH.
exec openbox
+
if [[ $UID -ge 1000 && -d $HOME/bin && -z $(echo $PATH | grep -o $HOME/bin) ]]
 +
then
 +
    export PATH="${PATH}:$HOME/bin"
 +
fi
 
</nowiki>}}
 
</nowiki>}}
  
This will make xdg-open use the more user-friendly exo-open, because it assumes it is inside Xfce. Use exo-preferred-applications for configuring.
+
=== Per user ===
 +
 
 +
{{Note|The dbus daemon and the user instance of systemd do not inherit any of the environment variables set in places like {{ic|~/.bashrc}} etc. This means that, for example, dbus activated programs like Gnome Files will not use them by default. See [[Systemd/User#Environment variables]].}}
 +
 
 +
You do not always want to define an environment variable globally. For instance, you might want to add {{ic|/home/my_user/bin}} to the {{ic|PATH}} variable but do not want all other users on your system to have that in their {{ic|PATH}} too. Local environment variables can be defined in many different files:
 +
 
 +
* {{ic|~/.pam_environment}} is the user specific equivalent of {{ic|/etc/security/pam_env.conf}} [https://github.com/linux-pam/linux-pam/issues/6], used by pam_env module. See {{man|8|pam_env}} and {{man|5|pam_env.conf}} for details.
 +
* User configuration files of your [[shell]], for example [[Bash#Configuration files]] or [[Zsh#Startup/Shutdown files]].
 +
* {{ic|~/.profile}} is used by many shells as fallback, see [[wikipedia:Unix shell#Configuration files]].
 +
 
 +
To add a directory to the {{ic|PATH}} for local usage, put following in {{ic|~/.bash_profile}}:
  
*{{ic|DESKTOP_SESSION}}. In [[LXDE]] desktop enviroment, when DESKTOP_SESSION is set to LXDE, xdg-open will use pcmanfm file associations.
+
export PATH="${PATH}:/home/my_user/bin"
  
*{{ic|PATH}} Contains a colon-separated list of directories in which your system looks for executable files. When a regular command (i.e. {{ic|ls}}, {{ic|rc-update}} or {{ic|emerge}}) is interpreted by the shell (i.e. {{ic|bash}}, {{ic|zsh}}), the shell looks for an executable file with same name as your command in the listed directories, and executes it. To run executables that are not listed in {{ic|PATH}}, the absoute path to the executable must be given: {{ic|/bin/ls}}.
+
To update the variable, re-login or ''source'' the file: {{ic|$ source ~/.bash_profile}}.
  
{{Note|It is advised not to include the current working directory (.) into your {{ic|PATH}} for security reasons, as it may trick the user to execute vicious commands.}}
+
==== Graphical applications ====
  
*{{ic|HOME}} Contains the path to the home directory of the current user. This variable can be used by applications to associate configuration files and such like with the user running it.
+
Environment variables for GUI applications can be set in [[xinitrc]], or in [[xprofile]] when using a [[display manager]], for example:
  
*{{ic|PWD}} Contains the path to your working directory.
+
{{hc|1=~/.xinitrc|2=
 +
export PATH="${PATH}:~/scripts"
 +
export GUIVAR=value
 +
}}
  
*{{ic|OLDPWD}} Contains the path to your previous working directory, that is, the value of PWD before last {{ic|cd}} was executed.
+
=== Per session ===
  
*{{ic|SHELL}} Contains the name of the running, interactive shell, i.e {{ic|bash}}
+
Sometimes even stricter definitions are required. One might want to temporarily run executables from a specific directory created without having to type the absolute path to each one, or editing shell configuration files for the short time needed to run them.
  
*{{ic|TERM}} Contains the name of the running terminal, i.e {{ic|xterm}}
+
In this case, you can define the {{ic|PATH}} variable in your current session, combined with the ''export'' command. As long as you do not log out, the {{ic|PATH}} variable will be using the temporary settings. To add a session-specific directory to {{ic|PATH}}, issue:
  
*{{ic|PAGER}} Contains the path to the program used to list the contents of files, i.e. {{ic|/bin/less}}.
+
$ export PATH="${PATH}:/home/my_user/tmp/usr/bin"
  
*{{ic|EDITOR}} Contains the path to the lightweight program used for editing files, i.e. {{ic|/usr/bin/nano}}.
+
== Examples ==
  
*{{ic|VISUAL}} Contains the path to full-fledged editor that is used for more demanding tasks, such as editing mail; e.g., {{ic|vi}}, [[vim]], [[emacs]], etc.
+
The following section lists a number of common environment variables used by a Linux system and describes their values.
  
*{{ic|MAIL}} Contains the location of incoming email. The traditional setting is {{ic|/var/spool/mail/$LOGNAME}}.
+
* {{ic|DE}} indicates the ''D''esktop ''E''nvironment being used. [[xdg-open]] will use it to choose more user-friendly file-opener application that desktop environment provides. Some packages need to be installed to use this feature. For [[GNOME]], that would be {{AUR|libgnome}}; for [[Xfce]] this is {{pkg|exo}}. Recognised values of {{ic|DE}} variable are: {{ic|gnome}}, {{ic|kde}}, {{ic|xfce}}, {{ic|lxde}} and {{ic|mate}}.
  
*{{ic|BROWSER}} Contains the path to the web browser. Helpful to set in an interactive shell configuration file so that it may be dynamically altered depending on the availability of a graphic environment, such as [[X]]:
+
:The {{ic|DE}} environment variable needs to be exported before starting the window manager. For example:
  
if [ -n "$DISPLAY" ]; then
+
{{hc|~/.xinitrc|2=
BROWSER=firefox
+
export DE="xfce"
else
+
exec openbox
BROWSER=links
+
}}
fi
+
 
 +
:This will make ''xdg-open'' use the more user-friendly ''exo-open'', because it assumes it is running inside Xfce. Use ''exo-preferred-applications'' for configuring.
 +
 
 +
* {{ic|DESKTOP_SESSION}} is similar to {{ic|DE}}, but used in [[LXDE]] desktop environment: when {{ic|DESKTOP_SESSION}} is set to {{ic|LXDE}}, ''xdg-open'' will use ''pcmanfm'' file associations.
 +
 
 +
* {{ic|PATH}} contains a colon-separated list of directories in which your system looks for executable files. When a regular command (e.g., ''ls'', ''rc-update'' or ''ic|emerge'') is interpreted by the shell (e.g., ''bash'' or ''zsh''), the shell looks for an executable file with the same name as your command in the listed directories, and executes it. To run executables that are not listed in {{ic|PATH}}, the absolute path to the executable must be given: {{ic|/bin/ls}}.
 +
 
 +
{{Note|It is advised not to include the current working directory ({{ic|.}}) into your {{ic|PATH}} for security reasons, as it may trick the user to execute vicious commands.}}
 +
 
 +
* {{ic|HOME}} contains the path to the home directory of the current user. This variable can be used by applications to associate configuration files and such like with the user running it.
 +
 
 +
* {{ic|PWD}} contains the path to your working directory.
 +
 
 +
* {{ic|OLDPWD}} contains the path to your previous working directory, that is, the value of {{ic|PWD}} before last ''cd'' was executed.
 +
 
 +
* {{ic|TERM}} contains the type of the running terminal, e.g. {{ic|xterm-256color}}. It is used by programs running in the terminal that wish to use terminal-specific capabilities.
 +
 
 +
* {{ic|MAIL}} contains the location of incoming email. The traditional setting is {{ic|/var/spool/mail/$LOGNAME}}.
 +
 
 +
* {{ic|ftp_proxy}} and {{ic|http_proxy}} contains FTP and HTTP proxy server, respectively:
 +
ftp_proxy="<nowiki>ftp://192.168.0.1:21</nowiki>"
 +
http_proxy="<nowiki>http://192.168.0.1:80</nowiki>"
 +
 
 +
* {{ic|MANPATH}} contains a colon-separated list of directories in which ''man'' searches for the man pages.
 +
{{Note|In {{ic|/etc/profile}}, there is a comment that states "Man is much better than us at figuring this out", so this variable should generally be left as default, i.e. {{ic|/usr/share/man:/usr/local/share/man}}
 +
}}
 +
 
 +
* {{ic|INFODIR}} contains a colon-separated list of directories in which the ''info'' command searches for the info pages, e.g., {{ic|/usr/share/info:/usr/local/share/info}}
  
*{{ic|ftp_proxy and http_proxy}} Contains FTP and HTTP proxy server, respectively:
+
* {{ic|TZ}} can be used to to set a time zone different to the system zone for a user. The zones listed in {{ic|/usr/share/zoneinfo/}} can be used as reference, for example {{ic|1=TZ="/usr/share/zoneinfo/Pacific/Fiji"}}
  
ftp_proxy="ftp://192.168.0.1:21"
+
=== Default programs ===
http_proxy="http://192.168.0.1:80"
 
  
*{{ic|MANPATH}} Contains a colon-separated list of directories in which {{ic|man}} searches for the man pages. Note that in {{ic|/etc/profile}}, there is a comment that states "Man is much better than us at figuring this out", so this variable should generally be left as default, i.e. {{ic|/usr/share/man:/usr/local/share/man}}
+
* {{ic|SHELL}} contains the path to the user's [http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html#tag_08_03 preferred shell]. Note that this is not necessarily the shell that is currently running, although [[Bash]] sets this variable on startup.
  
*{{ic|INFODIR}} Contains a colon-separated list of directories in which the info command searches for the info pages, i.e. {{ic|/usr/share/info:/usr/local/share/info}}
+
* {{ic|PAGER}} contains command to run the program used to list the contents of files, e.g., {{ic|/bin/less}}.
  
== Defining Variables Globally ==
+
* {{ic|EDITOR}} contains the command to run the lightweight program used for editing files, e.g., {{ic|/usr/bin/nano}}. For example, you can write an interactive switch between ''gedit'' under [[X]] or ''nano'', in this example:
  
Most Linux distributions tell you to change or add environment variable definitions in {{ic|/etc/profile}} or other locations. Be sure to maintain and manage the environment variables and pay attention to the numerous files that can contain environment variables. In principle, any shell script can be used for initializing environmental variables, but following traditional UNIX conventions, these statements should be only be present in some particular files. The following files should be used for defining global environment variables on your system: {{ic|/etc/profile}}, {{ic|/etc/bash.bashrc}} and {{ic|/etc/environment}}.
+
export EDITOR="$(if <nowiki>[[</nowiki> -n $DISPLAY <nowiki>]]</nowiki>; then echo 'gedit'; else echo 'nano'; fi)"
  
== Defining Variables Locally ==
+
* {{ic|VISUAL}} contains command to run the full-fledged editor that is used for more demanding tasks, such as editing mail (e.g., {{ic|vi}}, [[vim]], [[emacs]] etc).
  
You do not always want to define an environment variable globally. For instance, you might want to add {{ic|/home/my_user/bin}} to the PATH variable but do not want all other users on your system to have that in their {{ic|PATH}} too. The following files should be used for local environment variables on your system: {{ic|~/.bashrc}}, {{ic|~/.profile}}, {{ic|~/.bash_login}} and {{ic|~/.bash_logout}}.
+
* {{ic|BROWSER}} contains the path to the web browser. Helpful to set in an interactive shell configuration file so that it may be dynamically altered depending on the availability of a graphic environment, such as [[X]]:
  
To add a directory to {{ic|PATH}} for local usage, put following in {{ic|~/.bashrc}}:
+
if <nowiki>[</nowiki> -n "$DISPLAY" <nowiki>]</nowiki>; then
 +
    export BROWSER=firefox
 +
else
 +
    export BROWSER=links
 +
fi
  
PATH="${PATH}:/home/my_user/bin"
+
=== Using pam_env ===
  
To update the variable, re-login or source the file: {{ic|$ source ~/.bashrc}}.
+
The [[PAM]] module {{man|8|pam_env}} loads the variables to be set in the environment from the following files: {{ic|/etc/security/pam_env.conf}}, {{ic|/etc/environment}} and {{ic|~/.pam_environment}}.
  
== Session Specific Variables ==
+
* {{ic|/etc/environment}} must consist of simple {{ic|1=''VARIABLE''=''value''}} pairs on separate lines, for example: {{bc|1=EDITOR=NANO}}
  
Sometimes even stricter definitions are required. One might want to temporarily run executables from a specific directory created without having to type the absolute path to each one, or editing {{ic|~/.bashrc}} for the short time needed to run them.
+
* {{ic|/etc/security/pam_env.conf}} and {{ic|~/.pam_environment}} share the same following format: {{bc|1=VARIABLE [DEFAULT=''value''] [OVERRIDE=''value'']}} {{ic|@{HOME} }} and  {{ic|@{SHELL} }} are special variables that expand to what is defined in {{ic|/etc/passwd}}. The following example illustrates how to expand the {{ic|HOME}} environment variable into another variable: {{bc|1=XDG_CONFIG_HOME  DEFAULT=@{HOME}/.config}} {{Note|The variables {{ic|${HOME} }} and {{ic|${SHELL} }} are not linked to the {{ic|HOME}} and {{ic|SHELL}} environment variables, they are not set by default.}} The format also allows to expand already defined variables in the values of other variables using {{ic|${''VARIABLE''} }}, like this: {{bc|1=GNUPGHOME        DEFAULT=${XDG_CONFIG_HOME}/gnupg}} {{ic|1=''VARIABLE''=''value''}} pairs are also allowed, but variable expansion is not supported in those pairs. See {{man|5|pam_env.conf}} for more information.  
  
In this case, you can define the {{ic|PATH}} variable in your current session, combined with the {{ic|export}} command. As long as you do not log out, the {{ic|PATH}} variable will be using the temporary settings. To add a session-specific directory to {{ic|PATH}}, issue:
+
{{Note|These files are read before other files, in particular before  {{ic|~/.profile}}, {{ic|~/.bash_profile}} and {{ic|~/.zshenv}}. }}
  
$ export PATH="${PATH}:/home/my_user/tmp/usr/bin"
+
== See also ==
  
==See also==
+
* [https://wiki.gentoo.org/wiki/Handbook:X86/Working/EnvVar Gentoo Linux Documentation]
*Gentoo Linux Documentation [http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?full=1#book_part2_chap5]
+
* [https://help.ubuntu.com/community/EnvironmentVariables Ubuntu Community Wiki - Environment Variables]
*[[Default Applications]]
 
*[[Xdg-open]]
 

Latest revision as of 15:54, 24 April 2018

An environment variable is a named object that contains data used by one or more applications. In simple terms, it is a variable with a name and a value. The value of an environmental variable can for example be the location of all executable files in the file system, the default editor that should be used, or the system locale settings. Users new to Linux may often find this way of managing settings a bit unmanageable. However, environment variables provide a simple way to share configuration settings between multiple applications and processes in Linux.

Utilities

The coreutils package contains the programs printenv and env. To list the current environmental variables with values:

$ printenv
Note: Some environment variables are user-specific. Check by comparing the outputs of printenv as an unprivileged user and as root.

The env utility can be used to run a command under a modified environment. The following example will launch xterm with the environment variable EDITOR set to vim. This will not affect the global environment variable EDITOR.

$ env EDITOR=vim xterm

The Bash builtin set allows you to change the values of shell options and set the positional parameters, or to display the names and values of shell variables. For more information, see the set builtin documentation.

Each process stores their environment in the /proc/$PID/environ file. This file contained each key value pair delimited by a nul character (\x0). A more human readable format can be obtained with sed, e.g. sed 's:\x0:\n:g' /proc/$PID/environ.

Defining variables

Globally

Most Linux distributions tell you to change or add environment variable definitions in /etc/profile or other locations. Keep in mind that there are also package-specific configuration files containing variable settings such as /etc/locale.conf. Be sure to maintain and manage the environment variables and pay attention to the numerous files that can contain environment variables. In principle, any shell script can be used for initializing environmental variables, but following traditional UNIX conventions, these statements should be only be present in some particular files.

The following files should be used for defining global environment variables on your system: /etc/environment, /etc/profile and shell specific configuration files. Each of these files has different limitations, so you should carefully select the appropriate one for your purposes.

  • /etc/environment is used by the pam_env module and is shell agnostic so scripting or glob expansion cannot be used. The file only accepts variable=value pairs. See pam_env(8) and pam_env.conf(5) for details.
  • Global configuration files of your shell, initializes variables and runs scripts. For example Bash#Configuration files or Zsh#Startup/Shutdown files.
  • /etc/profile initializes variables for login shells only. It does, however, run scripts and can be used by all Bourne shell compatible shells.

In this example, we add ~/bin directory to the PATH for respective user. To do this, just put this in your preferred global environment variable config file (/etc/profile or /etc/bash.bashrc):

# If user ID is greater than or equal to 1000 & if ~/bin exists and is a directory & if ~/bin is not already in your $PATH
# then export ~/bin to your $PATH.
if [[ $UID -ge 1000 && -d $HOME/bin && -z $(echo $PATH | grep -o $HOME/bin) ]]
then
    export PATH="${PATH}:$HOME/bin"
fi

Per user

Note: The dbus daemon and the user instance of systemd do not inherit any of the environment variables set in places like ~/.bashrc etc. This means that, for example, dbus activated programs like Gnome Files will not use them by default. See Systemd/User#Environment variables.

You do not always want to define an environment variable globally. For instance, you might want to add /home/my_user/bin to the PATH variable but do not want all other users on your system to have that in their PATH too. Local environment variables can be defined in many different files:

To add a directory to the PATH for local usage, put following in ~/.bash_profile:

export PATH="${PATH}:/home/my_user/bin"

To update the variable, re-login or source the file: $ source ~/.bash_profile.

Graphical applications

Environment variables for GUI applications can be set in xinitrc, or in xprofile when using a display manager, for example:

~/.xinitrc
export PATH="${PATH}:~/scripts"
export GUIVAR=value

Per session

Sometimes even stricter definitions are required. One might want to temporarily run executables from a specific directory created without having to type the absolute path to each one, or editing shell configuration files for the short time needed to run them.

In this case, you can define the PATH variable in your current session, combined with the export command. As long as you do not log out, the PATH variable will be using the temporary settings. To add a session-specific directory to PATH, issue:

$ export PATH="${PATH}:/home/my_user/tmp/usr/bin"

Examples

The following section lists a number of common environment variables used by a Linux system and describes their values.

  • DE indicates the Desktop Environment being used. xdg-open will use it to choose more user-friendly file-opener application that desktop environment provides. Some packages need to be installed to use this feature. For GNOME, that would be libgnomeAUR; for Xfce this is exo. Recognised values of DE variable are: gnome, kde, xfce, lxde and mate.
The DE environment variable needs to be exported before starting the window manager. For example:
~/.xinitrc
export DE="xfce"
exec openbox
This will make xdg-open use the more user-friendly exo-open, because it assumes it is running inside Xfce. Use exo-preferred-applications for configuring.
  • DESKTOP_SESSION is similar to DE, but used in LXDE desktop environment: when DESKTOP_SESSION is set to LXDE, xdg-open will use pcmanfm file associations.
  • PATH contains a colon-separated list of directories in which your system looks for executable files. When a regular command (e.g., ls, rc-update or ic|emerge) is interpreted by the shell (e.g., bash or zsh), the shell looks for an executable file with the same name as your command in the listed directories, and executes it. To run executables that are not listed in PATH, the absolute path to the executable must be given: /bin/ls.
Note: It is advised not to include the current working directory (.) into your PATH for security reasons, as it may trick the user to execute vicious commands.
  • HOME contains the path to the home directory of the current user. This variable can be used by applications to associate configuration files and such like with the user running it.
  • PWD contains the path to your working directory.
  • OLDPWD contains the path to your previous working directory, that is, the value of PWD before last cd was executed.
  • TERM contains the type of the running terminal, e.g. xterm-256color. It is used by programs running in the terminal that wish to use terminal-specific capabilities.
  • MAIL contains the location of incoming email. The traditional setting is /var/spool/mail/$LOGNAME.
  • ftp_proxy and http_proxy contains FTP and HTTP proxy server, respectively:
ftp_proxy="ftp://192.168.0.1:21"
http_proxy="http://192.168.0.1:80"
  • MANPATH contains a colon-separated list of directories in which man searches for the man pages.
Note: In /etc/profile, there is a comment that states "Man is much better than us at figuring this out", so this variable should generally be left as default, i.e. /usr/share/man:/usr/local/share/man
  • INFODIR contains a colon-separated list of directories in which the info command searches for the info pages, e.g., /usr/share/info:/usr/local/share/info
  • TZ can be used to to set a time zone different to the system zone for a user. The zones listed in /usr/share/zoneinfo/ can be used as reference, for example TZ="/usr/share/zoneinfo/Pacific/Fiji"

Default programs

  • SHELL contains the path to the user's preferred shell. Note that this is not necessarily the shell that is currently running, although Bash sets this variable on startup.
  • PAGER contains command to run the program used to list the contents of files, e.g., /bin/less.
  • EDITOR contains the command to run the lightweight program used for editing files, e.g., /usr/bin/nano. For example, you can write an interactive switch between gedit under X or nano, in this example:
export EDITOR="$(if [[ -n $DISPLAY ]]; then echo 'gedit'; else echo 'nano'; fi)"
  • VISUAL contains command to run the full-fledged editor that is used for more demanding tasks, such as editing mail (e.g., vi, vim, emacs etc).
  • BROWSER contains the path to the web browser. Helpful to set in an interactive shell configuration file so that it may be dynamically altered depending on the availability of a graphic environment, such as X:
if [ -n "$DISPLAY" ]; then
    export BROWSER=firefox
else 
    export BROWSER=links
fi

Using pam_env

The PAM module pam_env(8) loads the variables to be set in the environment from the following files: /etc/security/pam_env.conf, /etc/environment and ~/.pam_environment.

  • /etc/environment must consist of simple VARIABLE=value pairs on separate lines, for example:
    EDITOR=NANO
  • /etc/security/pam_env.conf and ~/.pam_environment share the same following format:
    VARIABLE [DEFAULT=value] [OVERRIDE=value]
    @{HOME} and @{SHELL} are special variables that expand to what is defined in /etc/passwd. The following example illustrates how to expand the HOME environment variable into another variable:
    XDG_CONFIG_HOME   DEFAULT=@{HOME}/.config
    Note: The variables ${HOME} and ${SHELL} are not linked to the HOME and SHELL environment variables, they are not set by default.
    The format also allows to expand already defined variables in the values of other variables using ${VARIABLE} , like this:
    GNUPGHOME        DEFAULT=${XDG_CONFIG_HOME}/gnupg
    VARIABLE=value pairs are also allowed, but variable expansion is not supported in those pairs. See pam_env.conf(5) for more information.
Note: These files are read before other files, in particular before ~/.profile, ~/.bash_profile and ~/.zshenv.

See also