chiark / gitweb /
man: document locale.conf
authorLennart Poettering <lennart@poettering.net>
Sun, 21 Nov 2010 18:29:27 +0000 (19:29 +0100)
committerLennart Poettering <lennart@poettering.net>
Sun, 21 Nov 2010 18:29:27 +0000 (19:29 +0100)
Makefile.am
TODO
man/locale.conf.xml [new file with mode: 0644]
man/vconsole.conf.xml

index 1ed4054..06cd3c5 100644 (file)
@@ -507,7 +507,8 @@ MANPAGES = \
        man/systemd.conf.5 \
        man/tmpfiles.d.5 \
        man/hostname.5 \
-       man/vconsole.conf.5
+       man/vconsole.conf.5 \
+       man/locale.conf.5
 
 MANPAGES_ALIAS = \
        man/reboot.8 \
diff --git a/TODO b/TODO
index 3101db2..7de0ebb 100644 (file)
--- a/TODO
+++ b/TODO
@@ -53,7 +53,7 @@
 
 * readahead: btrfs/LVM SSD detection
 
-* man pages for: locale.conf, vconsole.conf, modules-load.d, /etc/os-release
+* man pages for: modules-load.d, /etc/os-release
 
 * when processes remain in a service even though the start command failed enter active
 
diff --git a/man/locale.conf.xml b/man/locale.conf.xml
new file mode 100644 (file)
index 0000000..fa446a8
--- /dev/null
@@ -0,0 +1,131 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+  This file is part of systemd.
+
+  Copyright 2010 Lennart Poettering
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  systemd is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<refentry id="locale.conf">
+        <refentryinfo>
+                <title>locale.conf</title>
+                <productname>systemd</productname>
+
+                <authorgroup>
+                        <author>
+                                <contrib>Developer</contrib>
+                                <firstname>Lennart</firstname>
+                                <surname>Poettering</surname>
+                                <email>lennart@poettering.net</email>
+                        </author>
+                </authorgroup>
+        </refentryinfo>
+
+        <refmeta>
+                <refentrytitle>locale.conf</refentrytitle>
+                <manvolnum>5</manvolnum>
+        </refmeta>
+
+        <refnamediv>
+                <refname>locale.conf</refname>
+                <refpurpose>configuration file for locale settings</refpurpose>
+        </refnamediv>
+
+        <refsynopsisdiv>
+                <para><filename>/etc/locale.conf</filename></para>
+        </refsynopsisdiv>
+
+        <refsect1>
+                <title>Description</title>
+
+                <para>The <filename>/etc/locale.conf</filename> file
+                configures system-wide locale settings.</para>
+
+                <para>The basic file format of
+                <filename>locale.conf</filename> is a
+                newline-separated list of environment-like
+                shell-compatible variable assignments. It is possible
+                to source the configuration from shell scripts,
+                however, beyond mere variable assignments no shell
+                features are supported, allowing applications to read
+                the file without implementing a shell compatible
+                execution engine.</para>
+
+                <para>Note that the kernel command line options
+                <varname>locale.LANG=</varname>,
+                <varname>locale.LC_CTYPE=</varname>,
+                <varname>locale.LC_NUMERIC=</varname>,
+                <varname>locale.LC_TIME=</varname>,
+                <varname>locale.LC_COLLATE=</varname>,
+                <varname>locale.LC_MONETARY=</varname>,
+                <varname>locale.LC_MESSAGES=</varname>,
+                <varname>locale.LC_PAPER=</varname>,
+                <varname>locale.LC_NAME=</varname>,
+                <varname>locale.LC_ADDRESS=</varname>,
+                <varname>locale.LC_TELEPHONE=</varname>,
+                <varname>locale.LC_MEASUREMENT=</varname>,
+                <varname>locale.LC_IDENTIFICATION=</varname> may be
+                used to override the locale settings at boot.</para>
+
+                <para>The locale settings configured in
+                <filename>/etc/locale.conf</filename> are system-wide
+                and are inherited by every service or user, unless
+                overriden or unset by individual programs or
+                individual users.</para>
+
+                <para>Depending on the operating system other
+                configuration files might be checked for locale
+                configuration as well, however only as
+                fallback.</para>
+        </refsect1>
+
+        <refsect1>
+                <title>Options</title>
+
+                <para>The following locale settings may be set using
+                <filename>/etc/locale.conf</filename>:
+                <varname>LANG=</varname>,
+                <varname>LC_CTYPE=</varname>,
+                <varname>LC_NUMERIC=</varname>,
+                <varname>LC_TIME=</varname>,
+                <varname>LC_COLLATE=</varname>,
+                <varname>LC_MONETARY=</varname>,
+                <varname>LC_MESSAGES=</varname>,
+                <varname>LC_PAPER=</varname>,
+                <varname>LC_NAME=</varname>,
+                <varname>LC_ADDRESS=</varname>,
+                <varname>LC_TELEPHONE=</varname>,
+                <varname>LC_MEASUREMENT=</varname>,
+                <varname>LC_IDENTIFICATION=</varname>. Note that
+                <varname>LC_ALL</varname> may not be be configured in
+                this file. For details about the meaning and semantics
+                of these settings, refer to
+                <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
+
+        </refsect1>
+
+        <refsect1>
+                  <title>See Also</title>
+                  <para>
+                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                  </para>
+        </refsect1>
+
+</refentry>
index 1926f33..d6ac579 100644 (file)
@@ -22,7 +22,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="hostname">
+<refentry id="vconsole.conf">
         <refentryinfo>
                 <title>vconsole.conf</title>
                 <productname>systemd</productname>
                 and console font.</para>
 
                 <para>The basic file format of the
-                <filename>vconsole.conf</filename> is a set of
-                environment-like shell-compatible variable
-                assignments. It is possible to source the
-                configuration from shell scripts, however, beyond mere
-                variable assignments no shell features are supported,
-                allowing applications to read the file without
-                containing a shell compatible execution engine.</para>
+                <filename>vconsole.conf</filename> is a
+                newline-separated list environment-like
+                shell-compatible variable assignments. It is possible
+                to source the configuration from shell scripts,
+                however, beyond mere variable assignments no shell
+                features are supported, allowing applications to read
+                the file without implementing a shell compatible
+                execution engine.</para>
 
                 <para>Note that the kernel command line options
                 <varname>vconsole.keymap=</varname>,
                 <varname>vconsole.keymap.toggle=</varname>,
                 <varname>vconsole.font=</varname>,
                 <varname>vconsole.font.map=</varname>,
-                <varname>vconsole.font.unimap=</varname> can be used
+                <varname>vconsole.font.unimap=</varname> may be used
                 to override the console settings at boot.</para>
 
                 <para>Depending on the operating system other