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/systemd.unit.xml | |
| 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/systemd.unit.xml')
| -rw-r--r-- | man/systemd.unit.xml | 17 |
1 files changed, 17 insertions, 0 deletions
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 |