]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemd-hostnamed.service.xml
man: fix link markup
[thirdparty/systemd.git] / man / systemd-hostnamed.service.xml
index 19bd4c06f2fe9dcd6183889a846ce30c4395b994..1aa32a61cedc3b9a0291d2349e482fed407d1b3f 100644 (file)
@@ -18,7 +18,7 @@
   <refnamediv>
     <refname>systemd-hostnamed.service</refname>
     <refname>systemd-hostnamed</refname>
-    <refpurpose>Host name bus mechanism</refpurpose>
+    <refpurpose>Daemon to control system hostname from programs</refpurpose>
   </refnamediv>
 
   <refsynopsisdiv>
   <refsect1>
     <title>Description</title>
 
-    <para><filename>systemd-hostnamed</filename> is a system service
-    that may be used as a mechanism to change the system's hostname.
-    <filename>systemd-hostnamed</filename> is automatically activated
-    on request and terminates itself when it is unused.</para>
+    <para><filename>systemd-hostnamed.service</filename> is a system service that may be used to change the
+    system's hostname and related machine metadata from user programs. It is automatically activated on
+    request and terminates itself when unused.</para>
+
+    <para>It currently offers access to five variables:
+    <itemizedlist>
+      <listitem><para>The current hostname (Example: <literal>dhcp-192-168-47-11</literal>)</para>
+      </listitem>
+
+      <listitem><para>The static (configured) hostname (Example:
+      <literal>lennarts-computer</literal>)</para></listitem>
+
+      <listitem><para>The pretty hostname (Example: <literal>Lennart's Computer</literal>)</para>
+      </listitem>
+
+      <listitem><para>A suitable icon name for the local host (Example:
+      <literal>computer-laptop</literal>)</para></listitem>
+
+      <listitem><para>A chassis type (Example: <literal>tablet</literal>)</para>
+      </listitem>
+    </itemizedlist></para>
 
     <para>The tool
     <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     is a command line client to this service.</para>
 
-    <para>See the <ulink
-    url="https://www.freedesktop.org/wiki/Software/systemd/hostnamed">
-    developer documentation</ulink> for information about the APIs
-    <filename>systemd-hostnamed</filename> provides.</para>
+    <para>See
+    <citerefentry><refentrytitle>org.freedesktop.hostname1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    and
+    <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+    for a description of the D-Bus API.</para>
   </refsect1>
 
   <refsect1>