X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_journal_open.xml;h=0f4178274e3f87efb6b9709922944eff50a1b6a5;hb=602c0e740f8290cc9c4f13f2eb4b23fbbd7a8d2b;hp=ff089a88e03de792d44483f8fc389609b1853f24;hpb=4a010f4e6e95964d7acaa33be768dbdb5e46d72a;p=elogind.git
diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml
index ff089a88e..0f4178274 100644
--- a/man/sd_journal_open.xml
+++ b/man/sd_journal_open.xml
@@ -45,7 +45,13 @@
sd_journal_open
sd_journal_open_directory
+ sd_journal_open_files
sd_journal_close
+ sd_journal
+ SD_JOURNAL_LOCAL_ONLY
+ SD_JOURNAL_RUNTIME_ONLY
+ SD_JOURNAL_SYSTEM
+ SD_JOURNAL_CURRENT_USER
Open the system journal for reading
@@ -67,7 +73,14 @@
- int sd_journal_close
+ int sd_journal_open_files
+ sd_journal** ret
+ const char** paths
+ int flags
+
+
+
+ void sd_journal_close
sd_journal* j
@@ -76,23 +89,27 @@
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_SYSTEM_ONLY
- will ensure that only journal files of system services
- and the kernel (in opposition to user session processes) will
- be opened.
+ excluding those which are stored on persistent
+ storage. SD_JOURNAL_SYSTEM
+ will cause journal files of system services and the
+ kernel (in opposition to user session processes) to
+ be opened. SD_JOURNAL_CURRENT_USER
+ will cause journal files of the current user to be
+ opened. If neither SD_JOURNAL_SYSTEM
+ nor SD_JOURNAL_CURRENT_USER are
+ specified, all journal file types will be opened.
sd_journal_open_directory()
is similar to sd_journal_open()
@@ -102,6 +119,18 @@
flags argument, but it must be passed as 0 as no flags
are currently understood for this call.
+ sd_journal_open_files()
+ is similar to sd_journal_open()
+ but takes a NULL-terminated list
+ of file paths to open. All files will be opened and
+ interleaved automatically. This call also takes a
+ flags argument, but it must be passed as 0 as no flags
+ are currently understood for this call. Please note
+ that in case of a live journal, this function is only
+ useful for debugging, because individual journal files
+ can be rotated at any moment, and the opening of
+ specific files in inherently racy.
+
sd_journal_close() will
close the journal context allocated with
sd_journal_open() or
@@ -116,7 +145,7 @@
See
sd_journal_next3
for an example how to iterate through the journal
- after opening it it with
+ after opening it with
sd_journal_open().
A journal context object returned by
@@ -137,13 +166,18 @@
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.
Return Value
- The sd_journal_open() and
- sd_journal_open_directory() calls
+ The sd_journal_open(),
+ sd_journal_open_directory(), and
+ sd_journal_open_files() calls
return 0 on success or a negative errno-style error
code. sd_journal_close() returns
nothing.
@@ -162,6 +196,27 @@
file.
+
+ History
+
+ sd_journal_open(),
+ sd_journal_close(),
+ SD_JOURNAL_LOCAL_ONLY,
+ SD_JOURNAL_RUNTIME_ONLY,
+ SD_JOURNAL_SYSTEM_ONLY were added
+ in systemd-38.
+
+ sd_journal_open_directory()
+ was added in systemd-187.
+
+ SD_JOURNAL_SYSTEM,
+ SD_JOURNAL_CURRENT_USER,
+ and sd_journal_open_files()
+ were added in systemd-205.
+ SD_JOURNAL_SYSTEM_ONLY
+ was deprecated.
+
+
See Also