man/locale.conf.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   SPDX-License-Identifier: LGPL-2.1+
   7
   8   This file is part of systemd.
   9
  10   Copyright 2010 Lennart Poettering
  11
  12   systemd is free software; you can redistribute it and/or modify it
  13   under the terms of the GNU Lesser General Public License as published by
  14   the Free Software Foundation; either version 2.1 of the License, or
  15   (at your option) any later version.
  16
  17   systemd is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   Lesser General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  24 -->
  25
  26 <refentry id="locale.conf">
  27   <refentryinfo>
  28     <title>locale.conf</title>
  29     <productname>systemd</productname>
  30
  31     <authorgroup>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Lennart</firstname>
  35         <surname>Poettering</surname>
  36         <email>lennart@poettering.net</email>
  37       </author>
  38     </authorgroup>
  39   </refentryinfo>
  40
  41   <refmeta>
  42     <refentrytitle>locale.conf</refentrytitle>
  43     <manvolnum>5</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>locale.conf</refname>
  48     <refpurpose>Configuration file for locale settings</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <para><filename>/etc/locale.conf</filename></para>
  53   </refsynopsisdiv>
  54
  55   <refsect1>
  56     <title>Description</title>
  57
  58     <para>The <filename>/etc/locale.conf</filename> file configures
  59     system-wide locale settings. It is read at early boot by
  60     <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
  61
  62     <para>The basic file format of <filename>locale.conf</filename> is
  63     a newline-separated list of environment-like shell-compatible
  64     variable assignments. It is possible to source the configuration
  65     from shell scripts, however, beyond mere variable assignments, no
  66     shell features are supported, allowing applications to read the
  67     file without implementing a shell compatible execution
  68     engine.</para>
  69
  70     <para>Note that the kernel command line options
  71     <varname>locale.LANG=</varname>,
  72     <varname>locale.LANGUAGE=</varname>,
  73     <varname>locale.LC_CTYPE=</varname>,
  74     <varname>locale.LC_NUMERIC=</varname>,
  75     <varname>locale.LC_TIME=</varname>,
  76     <varname>locale.LC_COLLATE=</varname>,
  77     <varname>locale.LC_MONETARY=</varname>,
  78     <varname>locale.LC_MESSAGES=</varname>,
  79     <varname>locale.LC_PAPER=</varname>,
  80     <varname>locale.LC_NAME=</varname>,
  81     <varname>locale.LC_ADDRESS=</varname>,
  82     <varname>locale.LC_TELEPHONE=</varname>,
  83     <varname>locale.LC_MEASUREMENT=</varname>,
  84     <varname>locale.LC_IDENTIFICATION=</varname> may be
  85     used to override the locale settings at boot.</para>
  86
  87     <para>The locale settings configured in
  88     <filename>/etc/locale.conf</filename> are system-wide and are
  89     inherited by every service or user, unless overridden or unset by
  90     individual programs or individual users.</para>
  91
  92     <para>Depending on the operating system, other configuration files
  93     might be checked for locale configuration as well, however only as
  94     fallback.</para>
  95
  96     <para><filename>/etc/vconsole.conf</filename> is usually created and updated
  97     using
  98     <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
  99     <citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 100     may be used to alter the settings in this file during runtime from
 101     the command line. Use
 102     <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 103     to initialize them on mounted (but not booted) system images.</para>
 104   </refsect1>
 105
 106   <refsect1>
 107     <title>Options</title>
 108
 109     <para>The following locale settings may be set using
 110     <filename>/etc/locale.conf</filename>:
 111     <varname>LANG=</varname>,
 112     <varname>LANGUAGE=</varname>,
 113     <varname>LC_CTYPE=</varname>,
 114     <varname>LC_NUMERIC=</varname>,
 115     <varname>LC_TIME=</varname>,
 116     <varname>LC_COLLATE=</varname>,
 117     <varname>LC_MONETARY=</varname>,
 118     <varname>LC_MESSAGES=</varname>,
 119     <varname>LC_PAPER=</varname>,
 120     <varname>LC_NAME=</varname>,
 121     <varname>LC_ADDRESS=</varname>,
 122     <varname>LC_TELEPHONE=</varname>,
 123     <varname>LC_MEASUREMENT=</varname>,
 124     <varname>LC_IDENTIFICATION=</varname>.
 125     Note that <varname>LC_ALL</varname> may not be configured in this
 126     file. For details about the meaning and semantics of these
 127     settings, refer to
 128     <citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
 129   </refsect1>
 130
 131   <refsect1>
 132     <title>Example</title>
 133
 134     <example>
 135       <title>German locale with English messages</title>
 136
 137       <para><filename>/etc/locale.conf</filename>:</para>
 138
 139       <programlisting>LANG=de_DE.UTF-8
 140 LC_MESSAGES=en_US.UTF-8</programlisting>
 141     </example>
 142
 143   </refsect1>
 144
 145   <refsect1>
 146       <title>See Also</title>
 147       <para>
 148         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 149         <citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
 150         <citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 151         <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 152         <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 153       </para>
 154   </refsect1>
 155
 156 </refentry>