summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2011-03-18 04:49:38 +0100
committerLennart Poettering <lennart@poettering.net>2011-03-18 04:53:31 +0100
commite2130f189a543c859b569985d8670132df40673e (patch)
treeef465bdb473acb597ef69e1ba4fd8beb55559f32
parentb1c66c44ef9e312805295395d728e47cdd08335c (diff)
units: deemphesize Names= settings, and explain why nobody whould use them
-rw-r--r--man/systemd.unit.xml44
1 files changed, 29 insertions, 15 deletions
diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 2ae986ad04..ff199e43cb 100644
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -219,21 +219,6 @@
dependent on the type of unit:</para>
<variablelist>
- <varlistentry>
- <term><varname>Names=</varname></term>
-
- <listitem><para>Additional names for
- this unit. The names listed here must
- have the same suffix (i.e. type) as
- the unit file name. This option may be
- specified more than once, in which
- case all listed names are used. Note
- that this option is different from the
- <varname>Alias=</varname> option from
- the [Install] section mentioned
- below. See below for details.</para>
- </listitem>
- </varlistentry>
<varlistentry>
<term><varname>Description=</varname></term>
@@ -660,6 +645,35 @@
pipe symbol must be passed first, the
exclamation second.</para></listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><varname>Names=</varname></term>
+
+ <listitem><para>Additional names for
+ this unit. The names listed here must
+ have the same suffix (i.e. type) as
+ the unit file name. This option may be
+ specified more than once, in which
+ case all listed names are used. Note
+ that this option is different from the
+ <varname>Alias=</varname> option from
+ the [Install] section mentioned
+ below. See below for details. Note
+ that in almost all cases this option
+ is not what you want. A symlink alias
+ in the file system is generally
+ preferable since it can be used as
+ lookup key. If a unit with a symlinked
+ alias name is not loaded and needs to
+ be it is easily found via the
+ symlink. However, if a unit with an
+ alias name configured with this
+ setting is not loaded it will not be
+ discovered. This settings' only use is
+ in conjunction with service
+ instances.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
<para>Unit file may include a [Install] section, which