journald: move /dev/log socket to /run

[elogind.git] / man / sd_journal_get_catalog.xml

diff --git a/man/sd_journal_get_catalog.xml b/man/sd_journal_get_catalog.xml
index b3c7b58b07e300d9143e5d6f85f0c0b838d56d3b..f84815022f7c8a2a95396d66b401de0be584e68b 100644 (file)
--- a/man/sd_journal_get_catalog.xml
+++ b/man/sd_journal_get_catalog.xml
@@ -54,14 +54,14 @@
 
                         <funcprototype>
                                 <funcdef>int <function>sd_journal_get_catalog</function></funcdef>
-                                <paramdef>sd_journal* <parameter>j</parameter></paramdef>
-                                <paramdef>const char** <parameter>ret</parameter></paramdef>
+                                <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>const char** <parameter>ret</parameter></paramdef>
+                                <paramdef>char **<parameter>ret</parameter></paramdef>
                         </funcprototype>
 
 
@@ -80,8 +80,8 @@
                 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
+                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>
@@ -89,7 +89,7 @@
                 <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>
+                field substitution is performed.</para>
 
                 <para>For more information about the journal message
                 catalog please refer to the <ulink
@@ -104,8 +104,13 @@
                 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
+                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>
@@ -113,10 +118,9 @@
 
                 <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
+                interfaces are available as a shared library, which can
                 be compiled and linked to with the
-                <literal>libsystemd-journal</literal>
-                <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
         </refsect1>
 
@@ -130,6 +134,7 @@
                         <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>