chiark / gitweb /
man: document /etc/hostname
authorLennart Poettering <lennart@poettering.net>
Sun, 21 Nov 2010 15:29:56 +0000 (16:29 +0100)
committerLennart Poettering <lennart@poettering.net>
Sun, 21 Nov 2010 15:29:56 +0000 (16:29 +0100)
Makefile.am
man/hostname.xml [new file with mode: 0644]

index e1f6fe0..2e6b978 100644 (file)
@@ -505,7 +505,8 @@ MANPAGES = \
        man/shutdown.8 \
        man/pam_systemd.8 \
        man/systemd.conf.5 \
        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 \
 
 MANPAGES_ALIAS = \
        man/reboot.8 \
diff --git a/man/hostname.xml b/man/hostname.xml
new file mode 100644 (file)
index 0000000..b55f8db
--- /dev/null
@@ -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@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>