[systemd-commits] 5 commits - Makefile.am man/hostname.xml man/locale.conf.xml man/modules-load.d.xml man/os-release.xml man/tmpfiles.d.xml man/vconsole.conf.xml TODO
Lennart Poettering
lennart at kemper.freedesktop.org
Sun Nov 21 12:47:34 PST 2010
Makefile.am | 7 +
TODO | 2
man/hostname.xml | 92 +++++++++++++++++++++++
man/locale.conf.xml | 131 +++++++++++++++++++++++++++++++++
man/modules-load.d.xml | 95 +++++++++++++++++++++++
man/os-release.xml | 194 +++++++++++++++++++++++++++++++++++++++++++++++++
man/tmpfiles.d.xml | 22 +++--
man/vconsole.conf.xml | 132 +++++++++++++++++++++++++++++++++
8 files changed, 663 insertions(+), 12 deletions(-)
New commits:
commit a7c64469b68f442bcaaf771ac14a88c1b2a08b29
Author: Lennart Poettering <lennart at poettering.net>
Date: Sun Nov 21 20:41:00 2010 +0100
man: document /etc/modules-load.d/
diff --git a/Makefile.am b/Makefile.am
index 35bbc3a..4330db0 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -509,7 +509,8 @@ MANPAGES = \
man/hostname.5 \
man/vconsole.conf.5 \
man/locale.conf.5 \
- man/os-release.5
+ man/os-release.5 \
+ man/modules-load.d.5
MANPAGES_ALIAS = \
man/reboot.8 \
diff --git a/TODO b/TODO
index 7de0ebb..b083529 100644
--- a/TODO
+++ b/TODO
@@ -53,8 +53,6 @@
* readahead: btrfs/LVM SSD detection
-* man pages for: modules-load.d, /etc/os-release
-
* when processes remain in a service even though the start command failed enter active
* add seperate man page for [Install] settings
diff --git a/man/modules-load.d.xml b/man/modules-load.d.xml
new file mode 100644
index 0000000..47acc08
--- /dev/null
+++ b/man/modules-load.d.xml
@@ -0,0 +1,95 @@
+<?xml version="1.0"?>
+<!--*-nxml-*-->
+<!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 Brandon Philips
+
+ 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="modules-load.d">
+
+ <refentryinfo>
+ <title>modules-load.d</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart at poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>modules-load.d</refentrytitle>
+ <manvolnum>5</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>modules-load.d</refname>
+ <refpurpose>Configure kernel modules to load at boot</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>/etc/modules-load.d/*.conf</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><command>systemd</command> uses
+ <filename>/etc/modules-load.d/</filename> to configure
+ kernel modules to load during boot in a static list.
+ Each configuration file is named in the style of
+ <filename>/etc/modules-load.d/<program>.conf</filename>. Note
+ that it is usally a better idea to use the automatic
+ module loading by PCI ID, by DMI ID or similar
+ triggers configured in the kernel modules themselves
+ instead of relying on static configuration like
+ this.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Configuration Format</title>
+
+ <para>The configuration files should simply contain a
+ list of kernel modul names to load, seperated by
+ newlines. Empty lines and lines whose first
+ non-whitespace character is # or ; are ignored.</para>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Example</title>
+ <example>
+ <title>/etc/modules-load.d/uinput.conf example:</title>
+
+ <programlisting># Load uinput.ko at boot
+uinput</programlisting>
+ </example>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml
index 7bdb6de..1df4a04 100644
--- a/man/tmpfiles.d.xml
+++ b/man/tmpfiles.d.xml
@@ -42,9 +42,13 @@
<refnamediv>
<refname>tmpfiles.d</refname>
- <refpurpose>configuration for creation, deletion and cleaning of tmpfiles</refpurpose>
+ <refpurpose>Configuration for creation, deletion and cleaning of temporary and volatile files</refpurpose>
</refnamediv>
+ <refsynopsisdiv>
+ <para><filename>/etc/tmpfiles.d/*.conf</filename></para>
+ </refsynopsisdiv>
+
<refsect1>
<title>Description</title>
@@ -55,7 +59,7 @@
<filename>/var/run</filename> or
<filename>/tmp</filename>). Each configuration file
is named in the style of
- <filename>/etc/tmpfiles.d/<program>.conf</filename></para>
+ <filename>/etc/tmpfiles.d/<program>.conf</filename>.</para>
</refsect1>
<refsect1>
@@ -73,37 +77,37 @@ d /var/run/user 0755 root root 10d</programlisting>
<variablelist>
<varlistentry>
<term><varname>f</varname></term>
- <listitem><para>create a file if it doesn't exist yet</para></listitem>
+ <listitem><para>Create a file if it doesn't exist yet</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>F</varname></term>
- <listitem><para>create or truncate a file</para></listitem>
+ <listitem><para>Create or truncate a file</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>d</varname></term>
- <listitem><para>create a directory if it doesn't exist yet</para></listitem>
+ <listitem><para>Create a directory if it doesn't exist yet</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>D</varname></term>
- <listitem><para>create or empty a directory</para></listitem>
+ <listitem><para>Create or empty a directory</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>x</varname></term>
- <listitem><para>ignore a path</para></listitem>
+ <listitem><para>Ignore a path</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>r</varname></term>
- <listitem><para>remove a path</para></listitem>
+ <listitem><para>Remove a path</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>R</varname></term>
- <listitem><para>recursively remove a path</para></listitem>
+ <listitem><para>Recursively remove a path</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
commit e17fb72914e328f962e5df1bf88f301c0e7fa6e1
Author: Lennart Poettering <lennart at poettering.net>
Date: Sun Nov 21 20:05:51 2010 +0100
man: document /etc/os-release
diff --git a/Makefile.am b/Makefile.am
index 06cd3c5..35bbc3a 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -508,7 +508,8 @@ MANPAGES = \
man/tmpfiles.d.5 \
man/hostname.5 \
man/vconsole.conf.5 \
- man/locale.conf.5
+ man/locale.conf.5 \
+ man/os-release.5
MANPAGES_ALIAS = \
man/reboot.8 \
diff --git a/man/os-release.xml b/man/os-release.xml
new file mode 100644
index 0000000..c6eb28f
--- /dev/null
+++ b/man/os-release.xml
@@ -0,0 +1,194 @@
+<?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="os-release">
+ <refentryinfo>
+ <title>os-release</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart at poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>os-release</refentrytitle>
+ <manvolnum>5</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>os-release</refname>
+ <refpurpose>Operating system identification</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>/etc/os-release</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>The <filename>/etc/os-release</filename> file
+ contains operating system identification data.</para>
+
+ <para>The basic file format of
+ <filename>os-release</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><filename>/etc/os-release</filename> contains
+ data that is defined by the operating system vendor
+ and should not be changed by the administrator.</para>
+
+ <para>Depending on the operating system other
+ configuration files might be checked for OS
+ identification as well, however only as
+ fallback.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <para>The following OS identifications parameters may be set using
+ <filename>/etc/os-release</filename>:</para>
+
+ <variablelist>
+
+ <varlistentry>
+ <term><varname>NAME=</varname></term>
+
+ <listitem><para>A string identifying
+ the operating system, without a
+ version string, and not necessarily
+ suitable for presentation to the
+ user. If not set defaults to
+ <literal>Linux</literal>. Example:
+ <literal>NAME=Fedora</literal> or
+ <literal>NAME="Debian
+ GNU/Linux"</literal>.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>VERSION=</varname></term>
+
+ <listitem><para>A string identifying
+ the operating system version,
+ excluding any name information and
+ suitable for presentation to the
+ user. Example:
+ <literal>VERSION=15</literal> or
+ <literal>VERSION="15
+ (Rawhide)"</literal>.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>ID=</varname></term>
+
+ <listitem><para>A lower-case string
+ identifying the operating system,
+ excluding any version information and
+ suitable for processing by scripts. If
+ not set defaults to
+ <literal>linux</literal>. Example:
+ <literal>ID=fedora</literal>.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>VERSION_ID=</varname></term>
+
+ <listitem><para>A lower-case string
+ (mostly numeric) identifying the
+ operating system version, excluding
+ any name information and suitable for
+ processing by scripts. Example:
+ <literal>VERSION_ID=15</literal>.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>PRETTY_NAME=</varname></term>
+
+ <listitem><para>A pretty operating
+ system name in a format suitable for
+ presentation to the user. May or may
+ not contain an OS version of some
+ kind, as suitable. If not set defaults
+ to <literal>Linux</literal>. Example:
+ <literal>PRETTY_NAME=Fedora 15
+ (Rawhide)</literal>.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>ANSI_COLOR=</varname></term>
+
+ <listitem><para>A suggested
+ presentation color when showing the
+ distribution name on the console. This
+ should be specified as string suitable
+ for inclusion in the ESC [ m
+ ANSI/ECMA-48 escape code for setting
+ graphical rendition. Example:
+ <literal>ANSI_COLOR=0;31</literal> for
+ red, or
+ <literal>ANSI_COLOR=1;34</literal> for
+ light blue.</para></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>If you interpreting this file from code or a
+ shell script, use the ID and VERSION_ID fields. When
+ looking for an OS indetification string for
+ presentation to the user use the PRETTY_STRING
+ field.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Example</title>
+
+ <programlisting>NAME=Fedora
+VERSION=15 (Rawhide)
+ID=fedora
+VERSION_ID=15
+PRETTY_NAME=Fedora 15 (Rawhide)
+ANSI_COLOR=0;34</programlisting>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>lsb_release</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
commit ee48647271132188e9ecc3507e62b6c7c7a6c9eb
Author: Lennart Poettering <lennart at poettering.net>
Date: Sun Nov 21 19:29:27 2010 +0100
man: document locale.conf
diff --git a/Makefile.am b/Makefile.am
index 1ed4054..06cd3c5 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -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
--- 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
index 0000000..fa446a8
--- /dev/null
+++ b/man/locale.conf.xml
@@ -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 at 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>
diff --git a/man/vconsole.conf.xml b/man/vconsole.conf.xml
index 1926f33..d6ac579 100644
--- a/man/vconsole.conf.xml
+++ b/man/vconsole.conf.xml
@@ -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>
@@ -59,20 +59,21 @@
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
commit eeca220bc280ebbed98bb3fc2c8d63efeccbfca1
Author: Lennart Poettering <lennart at poettering.net>
Date: Sun Nov 21 19:12:44 2010 +0100
man: document /etc/vconsole.conf
diff --git a/Makefile.am b/Makefile.am
index 2e6b978..1ed4054 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -506,7 +506,8 @@ MANPAGES = \
man/pam_systemd.8 \
man/systemd.conf.5 \
man/tmpfiles.d.5 \
- man/hostname.5
+ man/hostname.5 \
+ man/vconsole.conf.5
MANPAGES_ALIAS = \
man/reboot.8 \
diff --git a/man/hostname.xml b/man/hostname.xml
index b55f8db..f226ef0 100644
--- a/man/hostname.xml
+++ b/man/hostname.xml
@@ -69,7 +69,7 @@
<para>Depending on the operating system other
configuration files might be checked for configuration
- of the host name, however only as fallback.</para>
+ of the host name as well, however only as fallback.</para>
</refsect1>
<refsect1>
diff --git a/man/vconsole.conf.xml b/man/vconsole.conf.xml
new file mode 100644
index 0000000..1926f33
--- /dev/null
+++ b/man/vconsole.conf.xml
@@ -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="hostname">
+ <refentryinfo>
+ <title>vconsole.conf</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart at poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>vconsole.conf</refentrytitle>
+ <manvolnum>5</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>vconsole.conf</refname>
+ <refpurpose>configuration file for the virtual console</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>/etc/vconsole.conf</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>The <filename>/etc/vconsole.conf</filename> file
+ configures the virtual console, i.e. keyboard mapping
+ 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>
+
+ <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
+ to override the console settings at boot.</para>
+
+ <para>Depending on the operating system other
+ configuration files might be checked for configuration
+ of the virtual console as well, however only as
+ fallback.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+
+ <para>The following options are understood:</para>
+
+ <variablelist>
+
+ <varlistentry>
+ <term><varname>KEYMAP=</varname></term>
+ <term><varname>KEYMAP_TOGGLE=</varname></term>
+
+ <listitem><para>Configures the key
+ mapping table of for they
+ keyboard. <varname>KEYMAP=</varname>
+ defaults to <literal>us</literal> if
+ not set. The
+ <varname>KEYMAP_TOGGLE=</varname> can
+ be used to configured a second toggle
+ keymap and is by default
+ unset.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><varname>FONT=</varname></term>
+ <term><varname>FONT_MAP=</varname></term>
+ <term><varname>FONT_UNIMAP=</varname></term>
+
+ <listitem><para>Configures the console
+ font, the console map and the unicode
+ font map. <varname>FONT=</varname>
+ defaults to
+ <literal>latarcyrheb-sun16</literal>.</para></listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
commit 6a7e63eff2a03be705342f6c33d2aada01a9f544
Author: Lennart Poettering <lennart at poettering.net>
Date: Sun Nov 21 16:29:56 2010 +0100
man: document /etc/hostname
diff --git a/Makefile.am b/Makefile.am
index e1f6fe0..2e6b978 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -505,7 +505,8 @@ MANPAGES = \
man/shutdown.8 \
man/pam_systemd.8 \
man/systemd.conf.5 \
- man/tmpfiles.d.5
+ man/tmpfiles.d.5 \
+ man/hostname.5
MANPAGES_ALIAS = \
man/reboot.8 \
diff --git a/man/hostname.xml b/man/hostname.xml
new file mode 100644
index 0000000..b55f8db
--- /dev/null
+++ b/man/hostname.xml
@@ -0,0 +1,92 @@
+<?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="hostname">
+ <refentryinfo>
+ <title>/etc/hostname</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart at poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>hostname</refentrytitle>
+ <manvolnum>5</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>hostname</refname>
+ <refpurpose>local host name configuration file</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>/etc/hostname</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>The <filename>/etc/hostname</filename> file
+ configures the name of the local system that is set
+ during boot, with the
+ <citerefentry><refentrytitle>sethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+ system call. It should contain a single
+ newline-terminated host name string. The
+ host name may be a free-form string up to 64 characters
+ in length, however it is recommended that it consists
+ only of 7bit ASCII characters and no spaces or dots,
+ and limit itself to the format allowed for DNS domain
+ name labels, even though this is not a
+ requirement.</para>
+
+ <para>Depending on the operating system other
+ configuration files might be checked for configuration
+ of the host name, however only as fallback.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>History</title>
+
+ <para>The simple configuration file format of
+ <filename>/etc/hostname</filename> originates from
+ Debian GNU/Linux.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>sethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>
More information about the systemd-commits
mailing list