chiark / gitweb /
service: ifdef (more) distro-specific compat logic
[elogind.git] / man / hostname.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 General Public License as published by
13   the Free Software Foundation; either version 2 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   General Public License for more details.
20
21   You should have received a copy of the GNU General Public License
22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 -->
24
25 <refentry id="hostname">
26         <refentryinfo>
27                 <title>/etc/hostname</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>hostname</refentrytitle>
42                 <manvolnum>5</manvolnum>
43         </refmeta>
44
45         <refnamediv>
46                 <refname>hostname</refname>
47                 <refpurpose>local host name configuration file</refpurpose>
48         </refnamediv>
49
50         <refsynopsisdiv>
51                 <para><filename>/etc/hostname</filename></para>
52         </refsynopsisdiv>
53
54         <refsect1>
55                 <title>Description</title>
56
57                 <para>The <filename>/etc/hostname</filename> file
58                 configures the name of the local system that is set
59                 during boot, with the
60                 <citerefentry><refentrytitle>sethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>
61                 system call. It should contain a single
62                 newline-terminated host name string. The
63                 host name may be a free-form string up to 64 characters
64                 in length, however it is recommended that it consists
65                 only of 7bit ASCII characters and no spaces or dots,
66                 and limit itself to the format allowed for DNS domain
67                 name labels, even though this is not a
68                 requirement.</para>
69
70                 <para>Depending on the operating system other
71                 configuration files might be checked for configuration
72                 of the host name as well, however only as fallback.</para>
73         </refsect1>
74
75         <refsect1>
76                 <title>History</title>
77
78                 <para>The simple configuration file format of
79                 <filename>/etc/hostname</filename> originates from
80                 Debian GNU/Linux.</para>
81         </refsect1>
82
83         <refsect1>
84                   <title>See Also</title>
85                   <para>
86                           <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
87                           <citerefentry><refentrytitle>sethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
88                           <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>
89                   </para>
90         </refsect1>
91
92 </refentry>