directive-index: journal directives

This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2012-08-10 19:35:43 +02:00
parent ffafe91b5a
commit f6c2e28b07
3 changed files with 46 additions and 35 deletions

View file

@ -704,7 +704,8 @@ XML_DIRECTIVE_FILES = \
man/systemd.exec.xml \ man/systemd.exec.xml \
man/systemd.kill.xml \ man/systemd.kill.xml \
man/systemd.device.xml \ man/systemd.device.xml \
man/systemd.conf.xml man/systemd.conf.xml \
man/systemd.journal-fields.xml
man/systemd.directives.xml: make-directive-index.py $(XML_DIRECTIVE_FILES) man/systemd.directives.xml: make-directive-index.py $(XML_DIRECTIVE_FILES)
$(AM_V_at)$(MKDIR_P) $(dir $@) $(AM_V_at)$(MKDIR_P) $(dir $@)

View file

@ -56,6 +56,15 @@ TEMPLATE = '''\
<variablelist id='udev-directives' /> <variablelist id='udev-directives' />
</refsect1> </refsect1>
<refsect1>
<title>Journal directives</title>
<para>Directives for configuring the behaviour of the
journald process.</para>
<variablelist id='journal-directives' />
</refsect1>
</refentry> </refentry>
''' '''
@ -111,6 +120,7 @@ def make_page(xml_files):
for name in ['unit-directives', for name in ['unit-directives',
'udev-directives', 'udev-directives',
'systemd-directives', 'systemd-directives',
'journal-directives',
]} ]}
for page in xml_files: for page in xml_files:
_extract_directives(directive_groups, page) _extract_directives(directive_groups, page)

View file

@ -68,9 +68,9 @@
<para>User fields are fields that are directly passed <para>User fields are fields that are directly passed
from clients and stored in the journal.</para> from clients and stored in the journal.</para>
<variablelist> <variablelist class='journal-directives'>
<varlistentry> <varlistentry>
<term>MESSAGE=</term> <term><varname>MESSAGE=</varname></term>
<listitem> <listitem>
<para>The human readable <para>The human readable
message string for this message string for this
@ -85,7 +85,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>MESSAGE_ID=</term> <term><varname>MESSAGE_ID=</varname></term>
<listitem> <listitem>
<para>A 128bit message <para>A 128bit message
identifier ID for recognizing identifier ID for recognizing
@ -107,7 +107,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>PRIORITY=</term> <term><varname>PRIORITY=</varname></term>
<listitem> <listitem>
<para>A priority value between <para>A priority value between
0 (<literal>emerg</literal>) 0 (<literal>emerg</literal>)
@ -121,9 +121,9 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>CODE_FILE=</term> <term><varname>CODE_FILE=</varname></term>
<term>CODE_LINE=</term> <term><varname>CODE_LINE=</varname></term>
<term>CODE_FUNC=</term> <term><varname>CODE_FUNC=</varname></term>
<listitem> <listitem>
<para>The code location <para>The code location
generating this message, if generating this message, if
@ -134,7 +134,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>ERRNO=</term> <term><varname>ERRNO=</varname></term>
<listitem> <listitem>
<para>The low-level Unix error <para>The low-level Unix error
number causing this entry, if number causing this entry, if
@ -147,9 +147,9 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>SYSLOG_FACILITY=</term> <term><varname>SYSLOG_FACILITY=</varname></term>
<term>SYSLOG_IDENTIFIER=</term> <term><varname>SYSLOG_IDENTIFIER=</varname></term>
<term>SYSLOG_PID=</term> <term><varname>SYSLOG_PID=</varname></term>
<listitem> <listitem>
<para>Syslog compatibility <para>Syslog compatibility
fields containing the facility fields containing the facility
@ -170,11 +170,11 @@
fields, i.e. fields that are implicitly added by the fields, i.e. fields that are implicitly added by the
journal and cannot be altered by client code.</para> journal and cannot be altered by client code.</para>
<variablelist> <variablelist class='journal-directives'>
<varlistentry> <varlistentry>
<term>_PID=</term> <term><varname>_PID=</varname></term>
<term>_UID=</term> <term><varname>_UID=</varname></term>
<term>_GID=</term> <term><varname>_GID=</varname></term>
<listitem> <listitem>
<para>The process, user and <para>The process, user and
group ID of the process the group ID of the process the
@ -185,9 +185,9 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>_COMM=</term> <term><varname>_COMM=</varname></term>
<term>_EXE=</term> <term><varname>_EXE=</varname></term>
<term>_CMDLINE=</term> <term><varname>_CMDLINE=</varname></term>
<listitem> <listitem>
<para>The name, the executable <para>The name, the executable
path and the command line of path and the command line of
@ -197,8 +197,8 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>_AUDIT_SESSION=</term> <term><varname>_AUDIT_SESSION=</varname></term>
<term>_AUDIT_LOGINUID=</term> <term><varname>_AUDIT_LOGINUID=</varname></term>
<listitem> <listitem>
<para>The session and login <para>The session and login
UID of the process the journal UID of the process the journal
@ -209,10 +209,10 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>_SYSTEMD_CGROUP=</term> <term><varname>_SYSTEMD_CGROUP=</varname></term>
<term>_SYSTEMD_SESSION=</term> <term><varname>_SYSTEMD_SESSION=</varname></term>
<term>_SYSTEMD_UNIT=</term> <term><varname>_SYSTEMD_UNIT=</varname></term>
<term>_SYSTEMD_OWNER_UID=</term> <term><varname>_SYSTEMD_OWNER_UID=</varname></term>
<listitem> <listitem>
<para>The contol group path in <para>The contol group path in
@ -227,7 +227,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>_SELINUX_CONTEXT=</term> <term><varname>_SELINUX_CONTEXT=</varname></term>
<listitem> <listitem>
<para>The SELinux security <para>The SELinux security
context of the process the context of the process the
@ -237,7 +237,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>_SOURCE_REALTIME_TIMESTAMP=</term> <term><varname>_SOURCE_REALTIME_TIMESTAMP=</varname></term>
<listitem> <listitem>
<para>The earliest trusted <para>The earliest trusted
timestamp of the message, if timestamp of the message, if
@ -251,7 +251,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>_BOOT_ID=</term> <term><varname>_BOOT_ID=</varname></term>
<listitem> <listitem>
<para>The kernel boot ID for <para>The kernel boot ID for
the boot the message was the boot the message was
@ -262,7 +262,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>_MACHINE_ID=</term> <term><varname>_MACHINE_ID=</varname></term>
<listitem> <listitem>
<para>The machine ID of the <para>The machine ID of the
originating host, as available originating host, as available
@ -272,7 +272,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>_HOSTNAME=</term> <term><varname>_HOSTNAME=</varname></term>
<listitem> <listitem>
<para>The name of the <para>The name of the
originating host.</para> originating host.</para>
@ -280,7 +280,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>_TRANSPORT=</term> <term><varname>_TRANSPORT=</varname></term>
<listitem> <listitem>
<para>How the entry was <para>How the entry was
received by the journal received by the journal
@ -383,9 +383,9 @@
may also not be used as matches for may also not be used as matches for
<citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry></para> <citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry></para>
<variablelist> <variablelist class='journal-directives'>
<varlistentry> <varlistentry>
<term>__CURSOR=</term> <term><varname>__CURSOR=</varname></term>
<listitem> <listitem>
<para>The cursor for the <para>The cursor for the
entry. A cursor is an opaque entry. A cursor is an opaque
@ -399,7 +399,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>__REALTIME_TIMESTAMP=</term> <term><varname>__REALTIME_TIMESTAMP=</varname></term>
<listitem> <listitem>
<para>The wallclock time <para>The wallclock time
(CLOCK_REALTIME) at the point (CLOCK_REALTIME) at the point
@ -416,7 +416,7 @@
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>__MONOTONIC_TIMESTAMP=</term> <term><varname>__MONOTONIC_TIMESTAMP=</varname></term>
<listitem> <listitem>
<para>The monotonic time <para>The monotonic time
(CLOCK_MONOTONIC) at the point (CLOCK_MONOTONIC) at the point