summaryrefslogtreecommitdiff
path: root/man/sd_journal_open.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2012-07-13 20:39:05 +0200
committerLennart Poettering <lennart@poettering.net>2012-07-13 20:39:05 +0200
commit4a010f4e6e95964d7acaa33be768dbdb5e46d72a (patch)
tree31383ad96a167b32aac98700c39354aba4dc23cf /man/sd_journal_open.xml
parentb59866aefa110d368460edc14f98cd6d79fe05cd (diff)
man: document sd_journal_get_cursor()
Diffstat (limited to 'man/sd_journal_open.xml')
-rw-r--r--man/sd_journal_open.xml19
1 files changed, 19 insertions, 0 deletions
diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml
index 12b80551a2..ff089a88e0 100644
--- a/man/sd_journal_open.xml
+++ b/man/sd_journal_open.xml
@@ -118,6 +118,25 @@
for an example how to iterate through the journal
after opening it it with
<function>sd_journal_open()</function>.</para>
+
+ <para>A journal context object returned by
+ <function>sd_journal_open()</function> references a
+ specific journal entry as <emphasis>current</emphasis> entry,
+ similar to a file seek index in a classic file system
+ file, but without absolute positions. It may be
+ altered with
+ <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+ and
+ <citerefentry><refentrytitle>sd_journal_seek_head</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+ and related calls. The current entry position may be
+ exported in <emphasis>cursor</emphasis> strings, as accessible
+ via
+ <citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Cursor
+ strings may be used to globally identify a specific
+ journal entry in a stable way and then later to seek
+ to it (or if the specific entry is not available
+ locally, to its closest entry in time)
+ <citerefentry><refentrytitle>sd_journal_seek_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1>