We nowadays prefer positive options over negative.
<example>
<title>Extract the last core dump of /usr/bin/bar to a file named
- <filename noindex="true">bar.coredump</filename></title>
+ <filename index="false">bar.coredump</filename></title>
<programlisting># coredumpctl -o bar.coredump dump /usr/bin/bar</programlisting>
</example>
<title>Example</title>
<example>
<title>Setup environment to allow access to a program installed in
- <filename noindex='true'>/opt/foo</filename></title>
+ <filename index="false">/opt/foo</filename></title>
<para><filename>/etc/environment.d/60-foo.conf</filename>:
</para>
<refsect2>
<title><command>systemd-analyze condition <replaceable>CONDITION</replaceable>...</command></title>
- <para>This command will evaluate <varname noindex='true'>Condition*=...</varname> and
- <varname noindex='true'>Assert*=...</varname> assignments, and print their values, and
+ <para>This command will evaluate <varname index="false">Condition*=...</varname> and
+ <varname index="false">Assert*=...</varname> assignments, and print their values, and
the resulting value of the combined condition set. See
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for a list of available conditions and asserts.</para>
policy is not validated too.</para>
<example>
- <title>Analyze <filename noindex="true">systemd-logind.service</filename></title>
+ <title>Analyze <filename index="false">systemd-logind.service</filename></title>
<programlisting>$ systemd-analyze security --no-pager systemd-logind.service
NAME DESCRIPTION EXPOSURE
<example>
<title>Invoke a program</title>
- <para>This calls <filename noindex='true'>/bin/ls</filename>
+ <para>This calls <filename index="false">/bin/ls</filename>
with standard output and error connected to the journal:</para>
<programlisting># systemd-cat ls</programlisting>
# systemd-nspawn -bD /var/lib/machines/f&fedora_latest_version;</programlisting>
<para>This installs a minimal Fedora distribution into the
- directory <filename noindex='true'>/var/lib/machines/f&fedora_latest_version;</filename>
+ directory <filename index="false">/var/lib/machines/f&fedora_latest_version;</filename>
and then boots an OS in a namespace container in it. Because the installation
is located underneath the standard <filename>/var/lib/machines/</filename>
directory, it is also possible to start the machine using
are configured in the <literal>[Automount]</literal> section.</para>
<para>Automount units must be named after the automount directories they control. Example: the automount point
- <filename noindex='true'>/home/lennart</filename> must be configured in a unit file
+ <filename index="false">/home/lennart</filename> must be configured in a unit file
<filename>home-lennart.automount</filename>. For details about the escaping logic used to convert a file system
path to a unit name see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note that
<para>Device units are named after the <filename>/sys</filename>
and <filename>/dev</filename> paths they control. Example: the
- device <filename noindex='true'>/dev/sda5</filename> is exposed in
+ device <filename index="false">/dev/sda5</filename> is exposed in
systemd as <filename>dev-sda5.device</filename>. For details about
the escaping logic used to convert a file system path to a unit
name see
</programlisting>
<para>In this case, the interface was already renamed, so the <option>keep</option> policy specified as
- the first option in <filename noindex='true'>99-default.link</filename> means that the existing name is
+ the first option in <filename index="false">99-default.link</filename> means that the existing name is
preserved. If <option>keep</option> was removed, or if were in boot before the renaming has happened,
we might get the following instead:</para>
must be run as UID 0.</para>
<para>Mount units must be named after the mount point directories they control. Example: the mount point <filename
- noindex='true'>/home/lennart</filename> must be configured in a unit file <filename>home-lennart.mount</filename>.
+ index="false">/home/lennart</filename> must be configured in a unit file <filename>home-lennart.mount</filename>.
For details about the escaping logic used to convert a file system path to a unit name, see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note that mount
units cannot be templated, nor is possible to add multiple names to a mount unit by creating additional symlinks to
again. Previously, this naming policy applied implicitly, and now it must be explicitly
requested. Effectively, this means that network devices will be renamed according to the
configuration, even if they have been renamed already, if <constant>keep</constant> is not
- specified as the naming policy in the <filename noindex='true'>.link</filename> file. See
+ specified as the naming policy in the <filename index="false">.link</filename> file. See
<citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for a description of <varname>NamePolicy=</varname>.</para></listitem>
</varlistentry>
<listitem><para><option>MACAddressPolicy=persistent</option> was extended to set MAC addresses
based on the device name. Previously addresses were only based on the
- <varname noindex='true'>ID_NET_NAME_*</varname> attributes, which meant that interface names would
+ <varname index="false">ID_NET_NAME_*</varname> attributes, which meant that interface names would
never be generated for virtual devices. Now a persistent address will be generated for most
devices, including in particular bridges.</para>
<listitem>
<para>The package manager prepares system updates by downloading all (RPM or DEB or
whatever) packages to update off-line in a special directory
- <filename noindex="true">/var/lib/system-update</filename> (or
+ <filename index="false">/var/lib/system-update</filename> (or
another directory of the package/upgrade manager's choice).</para>
</listitem>
<listitem>
<para>When the user OK'ed the update, the symlink <filename>/system-update</filename> is
- created that points to <filename noindex="true">/var/lib/system-update</filename> (or
+ created that points to <filename index="false">/var/lib/system-update</filename> (or
wherever the directory with the upgrade files is located) and the system is rebooted. This
symlink is in the root directory, since we need to check for it very early at boot, at a
time where <filename>/var</filename> is not available yet.</para>
<orderedlist>
<listitem>
<para>To make things a bit more robust we recommend hooking the update script into
- <filename>system-update.target</filename> via a <filename noindex='true'>.wants/</filename>
+ <filename>system-update.target</filename> via a <filename index="false">.wants/</filename>
symlink in the distribution package, rather than depending on <command>systemctl
enable</command> in the postinst scriptlets of your package. More specifically, for your
update script create a .service file, without [Install] section, and then add a symlink like
- <filename noindex='true'>/usr/lib/systemd/system-update.target.wants/foobar.service</filename>
- → <filename noindex='true'>../foobar.service</filename> to your package.</para>
+ <filename index="false">/usr/lib/systemd/system-update.target.wants/foobar.service</filename>
+ → <filename index="false">../foobar.service</filename> to your package.</para>
</listitem>
<listitem>
<varname>Wants=system-update-pre.target</varname> and
<varname>Before=system-update-pre.target</varname> and add a symlink
to that file under
- <filename noindex='true'>/usr/lib/systemd/system-update.target.wants</filename>
+ <filename index="false">/usr/lib/systemd/system-update.target.wants</filename>
.</para>
</listitem>
</orderedlist>
<para><varname>Type=</varname><option>oneshot</option> are the
only service units that may have more than one
<varname>ExecStart=</varname> specified. For units with multiple
- commands (<varname noindex="true">Type=oneshot</varname>), all commands will be run again.</para>
- <para> For <varname noindex="true">Type=oneshot</varname>, <varname>Restart=</varname><option>always</option>
+ commands (<varname index="false">Type=oneshot</varname>), all commands will be run again.</para>
+ <para> For <varname index="false">Type=oneshot</varname>, <varname>Restart=</varname><option>always</option>
and <varname>Restart=</varname><option>on-success</option> are <emphasis>not</emphasis> allowed.</para>
</example>
unit.</para>
<para>Swap units must be named after the devices or files they control. Example: the swap device <filename
- noindex='true'>/dev/sda5</filename> must be configured in a unit file <filename>dev-sda5.swap</filename>. For
+ index="false">/dev/sda5</filename> must be configured in a unit file <filename>dev-sda5.swap</filename>. For
details about the escaping logic used to convert a file system path to a unit name, see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note that swap
units cannot be templated, nor is possible to add multiple names to a swap unit by creating additional symlinks to
escaping is used, in order to map strings containing arbitrary byte values (except NUL) into valid unit names and
their restricted character set. A common special case are unit names that reflect paths to objects in the file
system hierarchy. Example: a device unit <filename>dev-sda.device</filename> refers to a device with the device
- node <filename noindex='true'>/dev/sda</filename> in the file system.</para>
+ node <filename index="false">/dev/sda</filename> in the file system.</para>
<para>The escaping algorithm operates as follows: given a string, any <literal>/</literal> character is replaced by
<literal>-</literal>, and all other characters which are not ASCII alphanumerics or <literal>_</literal> are
<entry>Units of packages that have been installed in the home directory (<varname>$XDG_DATA_HOME</varname> is used if set, <filename>~/.local/share</filename> otherwise)</entry>
</row>
<row>
- <entry><filename>$dir/systemd/user</filename> for each <varname noindex='true'>$dir</varname> in <varname>$XDG_DATA_DIRS</varname></entry>
+ <entry><filename>$dir/systemd/user</filename> for each <varname index="false">$dir</varname> in <varname>$XDG_DATA_DIRS</varname></entry>
<entry>Additional locations for installed user units, one for each entry in <varname>$XDG_DATA_DIRS</varname></entry>
</row>
<row>
<refsect2>
<title>Conditions and Asserts</title>
- <para>Unit files may also include a number of <varname noindex="true">Condition…=</varname> and
- <varname noindex="true">Assert…=</varname> settings. Before the unit is started, systemd will verify
+ <para>Unit files may also include a number of <varname index="false">Condition…=</varname> and
+ <varname index="false">Assert…=</varname> settings. Before the unit is started, systemd will verify
that the specified conditions are true. If not, the starting of the unit will be (mostly silently)
skipped. Failing conditions will not result in the unit being moved into the <literal>failed</literal>
state. The conditions are checked at the time the queued start job is to be executed. The ordering
<row>
<entry><literal>%L</literal></entry>
<entry>Log directory root</entry>
- <entry>This is either <filename>/var/log</filename> (for the system manager) or the path <literal>$XDG_CONFIG_HOME</literal> resolves to with <filename noindex='true'>/log</filename> appended (for user managers).</entry>
+ <entry>This is either <filename>/var/log</filename> (for the system manager) or the path <literal>$XDG_CONFIG_HOME</literal> resolves to with <filename index="false">/log</filename> appended (for user managers).</entry>
</row>
<row>
<entry><literal>%m</literal></entry>
<row>
<entry><literal>%L</literal></entry>
<entry>System or user log directory</entry>
- <entry>In <option>--user</option> mode, this is the same as <varname>$XDG_CONFIG_HOME</varname> with <filename noindex='true'>/log</filename> appended, and <filename>/var/log</filename> otherwise.</entry>
+ <entry>In <option>--user</option> mode, this is the same as <varname>$XDG_CONFIG_HOME</varname> with <filename index="false">/log</filename> appended, and <filename>/var/log</filename> otherwise.</entry>
</row>
<row>
<entry><literal>%m</literal></entry>
different levels. As described in the previous section, <filename>user.slice</filename> contains
processes of all users, so any resource limits on that slice apply to all users together. The
usual way to configure them would be through drop-ins, e.g. <filename
- noindex='true'>/etc/systemd/system/user.slice.d/resources.conf</filename>.
+ index="false">/etc/systemd/system/user.slice.d/resources.conf</filename>.
</para>
<para>The processes of a single user are collected under
<filename>user-<replaceable>UID</replaceable>.slice</filename>. Resource limits for that user
can be configured through drop-ins for that unit, e.g. <filename
- noindex='true'>/etc/systemd/system/user-1000.slice.d/resources.conf</filename>. If the limits
+ index="false">/etc/systemd/system/user-1000.slice.d/resources.conf</filename>. If the limits
should apply to all users instead, they may be configured through drop-ins for the truncated
unit name, <filename>user-.slice</filename>. For example, configuration in <filename
- noindex='true'>/etc/systemd/system/user-.slice.d/resources.conf</filename> is included in all
+ index="false">/etc/systemd/system/user-.slice.d/resources.conf</filename> is included in all
<filename>user-<replaceable>UID</replaceable>.slice</filename> units, see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for a discussion of the drop-in mechanism.</para>
│ └─6706 /usr/bin/sleep 30
…</programlisting>
<para>User with UID 1000 is logged in using <command>gdm</command> (<filename
- noindex='true'>session-4.scope</filename>) and
+ index="false">session-4.scope</filename>) and
<citerefentry><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry>
- (<filename noindex='true'>session-19.scope</filename>), and also has a user manager instance
- running (<filename noindex='true'>user@1000.service</filename>). User with UID 1001 is logged
- in using <command>ssh</command> (<filename noindex='true'>session-20.scope</filename>) and
+ (<filename index="false">session-19.scope</filename>), and also has a user manager instance
+ running (<filename index="false">user@1000.service</filename>). User with UID 1001 is logged
+ in using <command>ssh</command> (<filename index="false">session-20.scope</filename>) and
also has a user manager instance running (<filename
- noindex='true'>user@1001.service</filename>). Those are all (leaf) system units, and form
- part of the slice hierarchy, with <filename noindex='true'>user-1000.slice</filename> and
- <filename noindex='true'>user-1001.slice</filename> below <filename
- noindex='true'>user.slice</filename>. User units are visible below the
+ index="false">user@1001.service</filename>). Those are all (leaf) system units, and form
+ part of the slice hierarchy, with <filename index="false">user-1000.slice</filename> and
+ <filename index="false">user-1001.slice</filename> below <filename
+ index="false">user.slice</filename>. User units are visible below the
<filename>user@.service</filename> instances (<filename
- noindex='true'>pulseaudio.service</filename>, <filename
- noindex='true'>gnome-terminal-server.service</filename>, <filename
- noindex='true'>init.scope</filename>, <filename noindex='true'>sleep.service</filename>).
+ index="false">pulseaudio.service</filename>, <filename
+ index="false">gnome-terminal-server.service</filename>, <filename
+ index="false">init.scope</filename>, <filename index="false">sleep.service</filename>).
</para>
</example>
for name in t.iterfind(xpath):
if absolute_only and not (name.text and name.text.startswith('/')):
continue
- if name.attrib.get('noindex'):
+ if name.attrib.get('index') == 'false':
continue
name.tail = ''
if name.text:
storfile = directive_groups['constants']
for name in t.iterfind('.//constant'):
- if name.attrib.get('noindex'):
+ if name.attrib.get('index') == 'false':
continue
name.tail = ''
if name.text.startswith('('): # a cast, strip it
projects / thirdparty / systemd.git / commitdiff
