man/environment.d.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!--
   5   This file is part of systemd.
   6
   7   Copyright 2016 Red Hat, Inc.
   8   Copyright 2017 Zbigniew Jędrzejewski-Szmek
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23 <refentry id="environment.d" xmlns:xi="http://www.w3.org/2001/XInclude">
  24
  25   <refentryinfo>
  26     <title>environment.d</title>
  27     <productname>systemd</productname>
  28
  29     <authorgroup>
  30       <author>
  31         <contrib>Developer</contrib>
  32         <firstname>Ray</firstname>
  33         <surname>Strode</surname>
  34         <email>rstrode@redhat.com</email>
  35       </author>
  36     </authorgroup>
  37   </refentryinfo>
  38
  39   <refmeta>
  40     <refentrytitle>environment.d</refentrytitle>
  41     <manvolnum>5</manvolnum>
  42   </refmeta>
  43
  44   <refnamediv>
  45     <refname>environment.d</refname>
  46     <refpurpose>Definition of user session environment</refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <para><filename>~/.config/environment.d/*.conf</filename></para>
  51     <para><filename>/etc/environment.d/*.conf</filename></para>
  52     <para><filename>/run/environment.d/*.conf</filename></para>
  53     <para><filename>/usr/lib/environment.d/*.conf</filename></para>
  54     <para><filename>/etc/environment</filename></para>
  55   </refsynopsisdiv>
  56
  57   <refsect1>
  58     <title>Description</title>
  59
  60     <para>The <filename>environment.d</filename> directories contain a list of "global" environment
  61     variable assignments for the user environment.
  62     <citerefentry><refentrytitle>systemd-environment-d-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  63     parses them and updates the environment exported by the systemd user instance to the services it
  64     starts.</para>
  65
  66     <para>It is recommended to use numerical prefixes for file names to simplify ordering.</para>
  67
  68     <para>For backwards compatibility, a symlink to <filename>/etc/environment</filename> is
  69     installed, so this file is also parsed.</para>
  70   </refsect1>
  71
  72   <xi:include href="standard-conf.xml" xpointer="confd" />
  73
  74   <refsect1>
  75     <title>Configuration Format</title>
  76
  77     <para>The configuration files contain a list of
  78     <literal><replaceable>KEY</replaceable>=<replaceable>VALUE</replaceable></literal> environment
  79     variable assignments, separated by newlines. The right hand side of these assignments may
  80     reference previously defined environment variables, using the <literal>${OTHER_KEY}</literal>
  81     and <literal>$OTHER_KEY</literal> format. It is also possible to use
  82
  83     <literal>${<replaceable>FOO</replaceable>:-<replaceable>DEFAULT_VALUE</replaceable>}</literal>
  84     to expand in the same way as <literal>${<replaceable>FOO</replaceable>}</literal> unless the
  85     expansion would be empty, in which case it expands to <replaceable>DEFAULT_VALUE</replaceable>,
  86     and use
  87     <literal>${<replaceable>FOO</replaceable>:+<replaceable>ALTERNATE_VALUE</replaceable>}</literal>
  88     to expand to <replaceable>ALTERNATE_VALUE</replaceable> as long as
  89     <literal>${<replaceable>FOO</replaceable>}</literal> would have expanded to a non-empty value.
  90     No other elements of shell syntax are supported.</para>
  91
  92     <para>Each<replaceable>KEY</replaceable> must be a valid variable name. Empty lines
  93     and lines beginning with the comment character <literal>#</literal> are ignored.</para>
  94
  95     <refsect2>
  96       <title>Example</title>
  97       <example>
  98         <title>Setup environment to allow access to a program installed in
  99         <filename noindex='true'>/opt/foo</filename></title>
 100
 101         <para><filename>/etc/environment.d/60-foo.conf</filename>:
 102         </para>
 103         <programlisting>
 104         FOO_DEBUG=force-software-gl,log-verbose
 105         PATH=/opt/foo/bin:$PATH
 106         LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}/opt/foo/lib
 107         XDG_DATA_DIRS=/opt/foo/share:${XDG_DATA_DIRS:-/usr/local/share/:/usr/share/}
 108         </programlisting>
 109       </example>
 110     </refsect2>
 111   </refsect1>
 112
 113   <refsect1>
 114     <title>See Also</title>
 115     <para>
 116       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 117       <citerefentry><refentrytitle>systemd-environment-d-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 118       <citerefentry><refentrytitle>systemd.environment-generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 119     </para>
 120   </refsect1>
 121
 122 </refentry>