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