man/hostnamectl.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   This file is part of systemd.
   7
   8   Copyright 2012 Lennart Poettering
   9
  10   systemd is free software; you can redistribute it and/or modify it
  11   under the terms of the GNU Lesser General Public License as published by
  12   the Free Software Foundation; either version 2.1 of the License, or
  13   (at your option) any later version.
  14
  15   systemd is distributed in the hope that it will be useful, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18   Lesser General Public License for more details.
  19
  20   You should have received a copy of the GNU Lesser General Public License
  21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="hostnamectl">
  25
  26         <refentryinfo>
  27                 <title>hostnamectl</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>hostnamectl</refentrytitle>
  42                 <manvolnum>1</manvolnum>
  43         </refmeta>
  44
  45         <refnamediv>
  46                 <refname>hostnamectl</refname>
  47                 <refpurpose>Control the system hostname</refpurpose>
  48         </refnamediv>
  49
  50         <refsynopsisdiv>
  51                 <cmdsynopsis>
  52                         <command>hostnamectl <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg></command>
  53                 </cmdsynopsis>
  54         </refsynopsisdiv>
  55
  56         <refsect1>
  57                 <title>Description</title>
  58
  59                 <para><command>hostnamectl</command> may be used to
  60                 query and change the system hostname and related
  61                settings.</para>
  62
  63                 <para>This tool distuingishes three different host
  64                 names: the high-level "pretty" hostname which might
  65                 include all all kinds of special characters
  66                 (e.g. "Lennart's Laptop"), the static hostname which
  67                 is used to initialize the kernel hostname at boot
  68                 (e.g. "lennarts-laptop"), and the transient hostname
  69                 which might be assigned temporarily due to network
  70                 configuration and might revert back to the static
  71                 hostname if network connectivity is lost and is only
  72                 temporarily written to the kernel hostname
  73                 (e.g. "dhcp-47-11").</para>
  74
  75                 <para>Note that the pretty hostname has little
  76                 restrictions on the characters used, while the static
  77                 and transient hostnames are limited to the usually
  78                 accepted characters of internet domain names.</para>
  79
  80                 <para>The static host name is stored in
  81                 <filename>/etc/hostname</filename>, see
  82                 <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  83                 for more information. The pretty host name and icon
  84                 name are stored in
  85                 <filename>/etc/machine-info</filename>, see
  86                 <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
  87         </refsect1>
  88
  89         <refsect1>
  90                 <title>Options</title>
  91
  92                 <para>The following options are understood:</para>
  93
  94                 <variablelist>
  95                         <varlistentry>
  96                                 <term><option>--help</option></term>
  97                                 <term><option>-h</option></term>
  98
  99                                 <listitem><para>Prints a short help
 100                                 text and exits.</para></listitem>
 101                         </varlistentry>
 102
 103                         <varlistentry>
 104                                 <term><option>--version</option></term>
 105
 106                                 <listitem><para>Prints a short version
 107                                 string and exits.</para></listitem>
 108                         </varlistentry>
 109
 110                         <varlistentry>
 111                                 <term><option>--no-ask-password</option></term>
 112
 113                                 <listitem><para>Don't query the user
 114                                 for authentication for privileged
 115                                 operations.</para></listitem>
 116                         </varlistentry>
 117
 118                         <varlistentry>
 119                                 <term><option>-H</option></term>
 120                                 <term><option>--host</option></term>
 121
 122                                 <listitem><para>Execute operation
 123                                 remotely. Specify a hostname, or
 124                                 username and hostname separated by @,
 125                                 to connect to. This will use SSH to
 126                                 talk to a remote
 127                                 system.</para></listitem>
 128                         </varlistentry>
 129
 130                         <varlistentry>
 131                                 <term><option>--static</option></term>
 132                                 <term><option>--transient</option></term>
 133                                 <term><option>--pretty</option></term>
 134
 135                                 <listitem><para>If
 136                                 <command>set-hostname</command> is
 137                                 invoked and one or more of these
 138                                 options are passed only the selected
 139                                 hostnames is
 140                                 updated.</para></listitem>
 141                         </varlistentry>
 142                 </variablelist>
 143
 144                 <para>The following commands are understood:</para>
 145
 146                 <variablelist>
 147                         <varlistentry>
 148                                 <term><command>status</command></term>
 149
 150                                 <listitem><para>Show current system
 151                                 hostname and related
 152                                 information.</para></listitem>
 153                         </varlistentry>
 154
 155                         <varlistentry>
 156                                 <term><command>set-hostname [NAME]</command></term>
 157
 158                                 <listitem><para>Set the system
 159                                 hostname. By default this will alter
 160                                 the pretty, the static, and the
 161                                 transient hostname alike, however if
 162                                 one or more of
 163                                 <option>--static</option>,
 164                                 <option>--transient</option>,
 165                                 <option>--pretty</option> are used
 166                                 only the selected hostnames are
 167                                 changed. If the pretty hostname is
 168                                 being set, and static or transient are
 169                                 being set as well the specified host
 170                                 name will be simplified in regards to
 171                                 the character set used before the
 172                                 latter are updated. This is done by
 173                                 replacing spaces by "-" and removing
 174                                 special characters. This ensures that
 175                                 the pretty and the static hostname
 176                                 are always closely related while still
 177                                 following the validity rules of the
 178                                 specific name. This simplification of
 179                                 the hostname string is not done if
 180                                 only the transient and/or static host
 181                                 names are set, and the pretty host
 182                                 name is left untouched. Pass the empty
 183                                 string "" as hostname to reset the
 184                                 selected hostnames to their default
 185                                 (usually
 186                                 "localhost").</para></listitem>
 187                         </varlistentry>
 188
 189                         <varlistentry>
 190                                 <term><command>set-icon-name [NAME]</command></term>
 191
 192                                 <listitem><para>Set the system icon
 193                                 name. The icon name is used by some
 194                                 graphical applications to visualize
 195                                 this host. The icon name should follow
 196                                 the <ulink
 197                                 url="http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon
 198                                 Naming Specification</ulink>. Pass an
 199                                 empty string to this operatoin to
 200                                 reset the icon name to the default
 201                                 value which is determined from the
 202                                 system form factor and possibly other
 203                                 parameters.</para></listitem>
 204                         </varlistentry>
 205
 206                 </variablelist>
 207         </refsect1>
 208
 209         <refsect1>
 210                 <title>Exit status</title>
 211
 212                 <para>On success 0 is returned, a non-zero failure
 213                 code otherwise.</para>
 214         </refsect1>
 215
 216         <refsect1>
 217                 <title>See Also</title>
 218                 <para>
 219                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 220                         <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 221                         <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 222                         <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 223                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 224                         <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 225                 </para>
 226         </refsect1>
 227
 228 </refentry>