X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_journal_open.xml;h=76b857b9916e7a0faf194d4a47f067a02701d2b8;hb=aa6c53bf05f27bb094735e7bc2bbfc73ac7bc2ba;hp=eb0b8c515ec8b8aa8946f642b02590eda3428e8f;hpb=3bb55eee6aecdab6bfdbb670299fa59801145cb6;p=elogind.git
diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml
index eb0b8c515..76b857b99 100644
--- a/man/sd_journal_open.xml
+++ b/man/sd_journal_open.xml
@@ -46,6 +46,10 @@
sd_journal_open
sd_journal_open_directory
sd_journal_close
+ sd_journal
+ SD_JOURNAL_LOCAL_ONLY
+ SD_JOURNAL_RUNTIME_ONLY
+ SD_JOURNAL_SYSTEM_ONLY
Open the system journal for reading
@@ -67,7 +71,7 @@
- int sd_journal_close
+ void sd_journal_close
sd_journal* j
@@ -76,20 +80,20 @@
Description
- sd_journal_open() opens the
+ sd_journal_open() opens
the log journal for reading. It will find all journal
files automatically and interleave them automatically
when reading. As first argument it takes a pointer to
a sd_journal pointer, which on
- success will contain journal context afterwards. The
+ success will contain journal context object afterwards. The
second argument is a flags field, which may consist of
the following flags ORed together:
SD_JOURNAL_LOCAL_ONLY makes sure
only journal files generated on the local machine will
be opened. SD_JOURNAL_RUNTIME_ONLY
makes sure only volatile journal files will be opened,
- excluding those which are stored on persistant
- storage. SD_JOURNAL_RUNTIME_ONLY
+ excluding those which are stored on persistent
+ storage. SD_JOURNAL_SYSTEM_ONLY
will ensure that only journal files of system services
and the kernel (in opposition to user session processes) will
be opened.
@@ -112,6 +116,35 @@
accessible to the calling user will be opened. If
journal files are not accessible to the caller this
will be silently ignored.
+
+ See
+ sd_journal_next3
+ for an example how to iterate through the journal
+ after opening it with
+ sd_journal_open().
+
+ A journal context object returned by
+ sd_journal_open() references a
+ specific journal entry as current entry,
+ similar to a file seek index in a classic file system
+ file, but without absolute positions. It may be
+ altered with
+ sd_journal_next3
+ and
+ sd_journal_seek_head3
+ and related calls. The current entry position may be
+ exported in cursor strings, as accessible
+ via
+ sd_journal_get_cursor3. 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)
+ sd_journal_seek_cursor3.
+
+ Notification of journal changes is available via
+ sd_journal_get_fd() and related
+ calls.