journal: document new catalog APIs
This commit is contained in:
Lennart Poettering
parent
8f1e860f8a
commit
f2cf0403c9
|
|
@ -535,7 +535,8 @@ MANPAGES = \
|
|||
man/sd_journal_get_usage.3 \
|
||||
man/sd_journal_add_match.3 \
|
||||
man/sd_journal_seek_head.3 \
|
||||
man/sd_journal_query_unique.3
|
||||
man/sd_journal_query_unique.3 \
|
||||
man/sd_journal_get_catalog.3
|
||||
|
||||
MANPAGES_ALIAS = \
|
||||
man/reboot.8 \
|
||||
|
|
@ -610,7 +611,8 @@ MANPAGES_ALIAS = \
|
|||
man/sd_journal_test_cursor.3 \
|
||||
man/sd_journal_enumerate_unique.3 \
|
||||
man/sd_journal_restart_unique.3 \
|
||||
man/SD_JOURNAL_FOREACH_UNIQUE.3
|
||||
man/SD_JOURNAL_FOREACH_UNIQUE.3 \
|
||||
man/sd_journal_get_catalog_for_message_id.3
|
||||
|
||||
if HAVE_KMOD
|
||||
MANPAGES += \
|
||||
|
|
@ -694,6 +696,7 @@ man/sd_journal_test_cursor.3: man/sd_journal_get_cursor.3
|
|||
man/sd_journal_enumerate_unique.3: man/sd_journal_query_unique.3
|
||||
man/sd_journal_restart_unique.3: man/sd_journal_query_unique.3
|
||||
man/SD_JOURNAL_FOREACH_UNIQUE.3: man/sd_journal_query_unique.3
|
||||
man/sd_journal_get_catalog_for_message_id.3: man/sd_journal_get_catalog.3
|
||||
|
||||
XML_FILES = \
|
||||
${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,${patsubst %.8,%.xml,$(MANPAGES)}}}}}
|
||||
|
|
|
|||
|
|
@ -79,7 +79,8 @@
|
|||
<citerefentry><refentrytitle>sd_journal_seek_head</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_journal_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_journal_get_usage</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
<citerefentry><refentrytitle>sd_journal_get_usage</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_journal_get_catalog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
and
|
||||
<citerefentry><refentrytitle>sd_journal_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
for more information about the functions
|
||||
|
|
@ -121,6 +122,7 @@
|
|||
<citerefentry><refentrytitle>sd_journal_get_usage</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_journal_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_journal_query_unique</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_journal_get_catalog</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,136 @@
|
|||
<?xml version='1.0'?> <!--*-nxml-*-->
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||
|
||||
<!--
|
||||
This file is part of systemd.
|
||||
|
||||
Copyright 2012 Lennart Poettering
|
||||
|
||||
systemd is free software; you can redistribute it and/or modify it
|
||||
under the terms of the GNU Lesser General Public License as published by
|
||||
the Free Software Foundation; either version 2.1 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
systemd is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
Lesser General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Lesser General Public License
|
||||
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
||||
-->
|
||||
|
||||
<refentry id="sd_journal_get_catalog">
|
||||
|
||||
<refentryinfo>
|
||||
<title>sd_journal_get_catalog</title>
|
||||
<productname>systemd</productname>
|
||||
|
||||
<authorgroup>
|
||||
<author>
|
||||
<contrib>Developer</contrib>
|
||||
<firstname>Lennart</firstname>
|
||||
<surname>Poettering</surname>
|
||||
<email>lennart@poettering.net</email>
|
||||
</author>
|
||||
</authorgroup>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>sd_journal_get_catalog</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>sd_journal_get_catalog</refname>
|
||||
<refname>sd_journal_get_catalog_for_message_id</refname>
|
||||
<refpurpose>Retrieve message catalog entry</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <systemd/sd-journal.h></funcsynopsisinfo>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_journal_get_catalog</function></funcdef>
|
||||
<paramdef>sd_journal* <parameter>j</parameter></paramdef>
|
||||
<paramdef>const char** <parameter>ret</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_journal_get_catalog_for_message_id</function></funcdef>
|
||||
<paramdef>sd_id128_t <parameter>id</parameter></paramdef>
|
||||
<paramdef>const char** <parameter>ret</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<para><function>sd_journal_get_catalog()</function>
|
||||
retrieves a message catalog entry for the current
|
||||
journal entry. This will look up an entry in the
|
||||
message catalog by using the
|
||||
<literal>MESSAGE_ID=</literal> field of the current
|
||||
journal entry. Before returning the entry all journal
|
||||
field names in the catalog entry text enclosed in "@"
|
||||
will be replaced by the respective field values of the
|
||||
current entry. If a field name referenced in the
|
||||
message catalog entry does not exist it the current
|
||||
journal entry the "@" will be removed but the field
|
||||
name otherwise left untouched.</para>
|
||||
|
||||
<para><function>sd_journal_get_catalog_for_message_id()</function>
|
||||
works similar to
|
||||
<function>sd_journal_get_catalog()</function> but the
|
||||
entry is looked up by the specified message ID (no
|
||||
open journal context is necessary for this), and no
|
||||
field substitution is done.</para>
|
||||
|
||||
<para>For more information about the journal message
|
||||
catalog please refer to the <ulink
|
||||
url="http://www.freedesktop.org/wiki/Software/systemd/catalog">Journal
|
||||
Message Catalogs</ulink> documentation page.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Return Value</title>
|
||||
|
||||
<para><function>sd_journal_get_catalog()</function>
|
||||
and
|
||||
<function>sd_journal_get_catalog_for_message_id()</function>
|
||||
returns 0 on success or a negative errno-style error
|
||||
code. If no matching message catalog entry is found
|
||||
-ENOENT is returned.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Notes</title>
|
||||
|
||||
<para>The <function>sd_journal_get_catalog()</function> and
|
||||
<function>sd_journal_get_catalog_for_message_id()</function>
|
||||
interfaces are available as shared library, which can
|
||||
be compiled and linked to with the
|
||||
<literal>libsystemd-journal</literal>
|
||||
<citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
||||
file.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
|
||||
<para>
|
||||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
Loading…
Reference in New Issue