summaryrefslogtreecommitdiff
path: root/man/sd_journal_get_catalog.xml
blob: f84815022f7c8a2a95396d66b401de0be584e68b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<?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 &lt;systemd/sd-journal.h&gt;</funcsynopsisinfo>

                        <funcprototype>
                                <funcdef>int <function>sd_journal_get_catalog</function></funcdef>
                                <paramdef>sd_journal *<parameter>j</parameter></paramdef>
                                <paramdef>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>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, in 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 performed.</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>
                return 0 on success or a negative errno-style error
                code. If no matching message catalog entry is found,
                -ENOENT is returned.</para>

                <para>On successful return, <parameter>ret</parameter>
                points to a new string, which must be freed with
                <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
                </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 a shared library, which can
                be compiled and linked to with the
                <constant>libsystemd</constant> <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>
                        <citerefentry><refentrytitle>malloc</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>