X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_journal_get_catalog.xml;h=c38a645ede4c903c618183f8c3590ffe5b2f39d9;hb=79b1f37d95f08fe7620b071eec51d2810ed077c9;hp=b3c7b58b07e300d9143e5d6f85f0c0b838d56d3b;hpb=7ba9719595ee13612c9aea786233ffdd4d77ee46;p=elogind.git
diff --git a/man/sd_journal_get_catalog.xml b/man/sd_journal_get_catalog.xml
index b3c7b58b0..c38a645ed 100644
--- a/man/sd_journal_get_catalog.xml
+++ b/man/sd_journal_get_catalog.xml
@@ -54,14 +54,14 @@
int sd_journal_get_catalog
- sd_journal* j
- const char** ret
+ sd_journal *j
+ char **ret
int sd_journal_get_catalog_for_message_id
sd_id128_t id
- const char** ret
+ char **ret
@@ -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.
sd_journal_get_catalog_for_message_id()
@@ -89,7 +89,7 @@
sd_journal_get_catalog() 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.
+ field substitution is performed.
For more information about the journal message
catalog please refer to the sd_journal_get_catalog_for_message_id()
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.
+
+ On successful return, ret
+ points to a new string, which must be freed with
+ free3.
+
@@ -113,10 +118,9 @@
The sd_journal_get_catalog() and
sd_journal_get_catalog_for_message_id()
- interfaces are available as shared library, which can
+ interfaces are available as a shared library, which can
be compiled and linked to with the
- libsystemd-journal
- pkg-config1
+ libsystemd pkg-config1
file.
@@ -129,7 +133,8 @@
sd-journal3,
sd_journal_open3,
sd_journal_next3,
- sd_journal_get_data3
+ sd_journal_get_data3,
+ malloc3