man: document sd_journal_get_cursor()

[elogind.git] / man / sd_journal_next.xml

diff --git a/man/sd_journal_next.xml b/man/sd_journal_next.xml
index f55ee157444f5d954f11f4de84fe4a879a8c1223..95429fa6ff60b2af1657943187adc7f9481ead53 100644 (file)
--- a/man/sd_journal_next.xml
+++ b/man/sd_journal_next.xml
@@ -47,6 +47,8 @@
                 <refname>sd_journal_previous</refname>
                 <refname>sd_journal_next_skip</refname>
                 <refname>sd_journal_previous_skip</refname>
+                <refname>SD_JOURNAL_FOREACH</refname>
+                <refname>SD_JOURNAL_FOREACH_BACKWARDS</refname>
                 <refpurpose>Advance or set back the read pointer in the journal</refpurpose>
         </refnamediv>
 
@@ -76,6 +78,15 @@
                                 <paramdef>uint64_t <parameter>skip</parameter></paramdef>
                         </funcprototype>
 
+                        <funcprototype>
+                                <funcdef><function>SD_JOURNAL_FOREACH</function></funcdef>
+                                <paramdef>sd_journal* <parameter>j</parameter></paramdef>
+                        </funcprototype>
+
+                        <funcprototype>
+                                <funcdef><function>SD_JOURNAL_FOREACH_BACKWARDS</function></funcdef>
+                                <paramdef>sd_journal* <parameter>j</parameter></paramdef>
+                        </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
 
@@ -105,6 +116,13 @@
                 that the entry then pointing to is later in time than
                 then previous one, or has the same timestamp.</para>
 
+                <para>Note that
+                <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                and related calls will fail unless
+                <function>sd_journal_next()</function> has been
+                invoked at least once in order to position the read
+                pointer on a journal entry.</para>
+
                 <para>Note that the
                 <function>SD_JOURNAL_FOREACH()</function> macro may be used
                 as a wrapper around
@@ -187,7 +205,9 @@ int main(int argc, char *argv[]) {
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</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_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+                        <citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 </para>
         </refsect1>