diff options
| author | Lennart Poettering <lennart@poettering.net> | 2012-05-21 15:12:18 +0200 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2012-05-21 15:14:51 +0200 |
| commit | 49dbfa7b2b0bf3906704dac1eaeb4eba91056a19 (patch) | |
| tree | b7bf6ad5bef741f68b45a431807f58a81a5c845a /man | |
| parent | a223b325b409b325f4c2c2e11268596edd842631 (diff) | |
units: introduce new Documentation= field and make use of it everywhere
This should help making the boot process a bit easier to explore and
understand for the administrator. The simple idea is that "systemctl
status" now shows a link to documentation alongside the other status and
decriptionary information of a service.
This patch adds the necessary fields to all our shipped units if we have
proper documentation for them.
Diffstat (limited to 'man')
| -rw-r--r-- | man/systemd.special.xml | 65 | ||||
| -rw-r--r-- | man/systemd.unit.xml | 17 |
2 files changed, 82 insertions, 0 deletions
diff --git a/man/systemd.special.xml b/man/systemd.special.xml index 984e998aba..96befd5f5d 100644 --- a/man/systemd.special.xml +++ b/man/systemd.special.xml @@ -49,7 +49,9 @@ <refsynopsisdiv> <para><filename>basic.target</filename>, + <filename>bluetooth.target</filename>, <filename>ctrl-alt-del.target</filename>, + <filename>cryptsetup.target</filename>, <filename>dbus.service</filename>, <filename>dbus.socket</filename>, <filename>default.target</filename>, @@ -57,6 +59,7 @@ <filename>emergency.target</filename>, <filename>exit.service</filename>, <filename>final.service</filename>, + <filename>getty.target</filename>, <filename>graphical.target</filename>, <filename>hibernate.target</filename>, <filename>http-daemon.target</filename>, @@ -69,7 +72,9 @@ <filename>multi-user.target</filename>, <filename>network.target</filename>, <filename>nss-lookup.target</filename>, + <filename>nss-user-lookup.target</filename>, <filename>poweroff.target</filename>, + <filename>printer.target</filename>, <filename>reboot.target</filename>, <filename>remote-fs.target</filename>, <filename>remote-fs-pre.target</filename>, @@ -82,7 +87,9 @@ <filename>shutdown.target</filename>, <filename>sigpwr.target</filename>, <filename>sleep.target</filename>, + <filename>smartcard.target</filename>, <filename>sockets.target</filename>, + <filename>sound.target</filename>, <filename>suspend.target</filename>, <filename>swap.target</filename>, <filename>sysinit.target</filename>, @@ -128,6 +135,16 @@ </listitem> </varlistentry> <varlistentry> + <term><filename>bluetooth.target</filename></term> + <listitem> + <para>This target is started + automatically as soon as a + bluetooth controller is + plugged in or becomes + available at boot.</para> + </listitem> + </varlistentry> + <varlistentry> <term><filename>ctrl-alt-del.target</filename></term> <listitem> <para>systemd starts this @@ -140,6 +157,15 @@ </listitem> </varlistentry> <varlistentry> + <term><filename>cryptsetup.target</filename></term> + <listitem> + <para>A target that pulls in + setup services for all + encrypted block + devices.</para> + </listitem> + </varlistentry> + <varlistentry> <term><filename>dbus.service</filename></term> <listitem> <para>A special unit for the @@ -227,6 +253,15 @@ </listitem> </varlistentry> <varlistentry> + <term><filename>getty.target</filename></term> + <listitem> + <para>A special target unit + that pulls in all local TTY + <filename>getty</filename> instances. + </para> + </listitem> + </varlistentry> + <varlistentry> <term><filename>graphical.target</filename></term> <listitem> <para>A special target unit @@ -443,6 +478,16 @@ </listitem> </varlistentry> <varlistentry> + <term><filename>printer.target</filename></term> + <listitem> + <para>This target is started + automatically as soon as a + printer is plugged in or + becomes available at + boot.</para> + </listitem> + </varlistentry> + <varlistentry> <term><filename>reboot.target</filename></term> <listitem> <para>A special target unit @@ -616,6 +661,16 @@ </listitem> </varlistentry> <varlistentry> + <term><filename>smartcard.target</filename></term> + <listitem> + <para>This target is started + automatically as soon as a + smartcard controller is + plugged in or becomes + available at boot.</para> + </listitem> + </varlistentry> + <varlistentry> <term><filename>sockets.target</filename></term> <listitem> <para>A special target unit @@ -630,6 +685,16 @@ </listitem> </varlistentry> <varlistentry> + <term><filename>sound.target</filename></term> + <listitem> + <para>This target is started + automatically as soon as a + sound card is plugged in or + becomes available at + boot.</para> + </listitem> + </varlistentry> + <varlistentry> <term><filename>suspend.target</filename></term> <listitem> <para>A special target unit diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index c81c7a30b0..dbc5fedea9 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -295,6 +295,23 @@ </varlistentry> <varlistentry> + <term><varname>Documentation=</varname></term> + <listitem><para>A space separated list + of URIs referencing documentation for + this unit or its + configuration. Accepted are only URIs + of the types + <literal>http://</literal>, + <literal>https://</literal>, + <literal>file:</literal>, + <literal>info:</literal>, + <literal>man:</literal>. For more + information about the syntax of these + URIs see + <citerefentry><refentrytitle>uri</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para></listitem> + </varlistentry> + + <varlistentry> <term><varname>Requires=</varname></term> <listitem><para>Configures requirement |