]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: briefly document the DOCUMENTATION= structure log field 15915/head
authorLennart Poettering <lennart@poettering.net>
Mon, 25 May 2020 17:39:50 +0000 (19:39 +0200)
committerLennart Poettering <lennart@poettering.net>
Fri, 29 May 2020 08:41:30 +0000 (10:41 +0200)
man/systemd.journal-fields.xml

index 4d35cfb6dc5cbe27ec0280a7175a04795ed2c923..31ad143113c6f190021bdc33438fa8b2318e4822 100644 (file)
           </para>
         </listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term><varname>DOCUMENTATION=</varname></term>
+        <listitem>
+          <para>A documentation URL with further information about the topic of the log message. Tools such
+          as <command>journalctl</command> will include a hyperlink to an URL specified this way in their
+          output. Should be a <literal>http://</literal>, <literal>https://</literal>,
+          <literal>file:/</literal>, <literal>man:</literal> or <literal>info:</literal> URL.</para>
+        </listitem>
+      </varlistentry>
     </variablelist>
   </refsect1>