X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_journal_open.xml;h=3d8a23ddfcc21b2bcfcffb89c1c57bbeb48bf184;hb=811ba7a0e292eda0f2f470613cc28a97bda7ee66;hp=4ac94c4ce37f31cb3e9d7365ca4ecd24792d61ec;hpb=5302ebe15ff3a11eceb75e095e5a09d2a676de2b;p=elogind.git
diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml
index 4ac94c4ce..3d8a23ddf 100644
--- a/man/sd_journal_open.xml
+++ b/man/sd_journal_open.xml
@@ -46,6 +46,7 @@
sd_journal_open
sd_journal_open_directory
sd_journal_open_files
+ sd_journal_open_container
sd_journal_close
sd_journal
SD_JOURNAL_LOCAL_ONLY
@@ -61,27 +62,34 @@
int sd_journal_open
- sd_journal** ret
+ sd_journal **ret
int flags
int sd_journal_open_directory
- sd_journal** ret
- const char* path
+ sd_journal **ret
+ const char *path
int flags
int sd_journal_open_files
- sd_journal** ret
- const char** paths
+ sd_journal **ret
+ const char **paths
+ int flags
+
+
+
+ int sd_journal_open_container
+ sd_journal **ret
+ const char *machine
int flags
void sd_journal_close
- sd_journal* j
+ sd_journal *j
@@ -93,22 +101,22 @@
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 object afterwards. The
+ a sd_journal pointer, which on
+ success will contain a journal context object. The
second argument is a flags field, which may consist of
the following flags ORed together:
- SD_JOURNAL_LOCAL_ONLY makes sure
+ SD_JOURNAL_LOCAL_ONLY makes sure
only journal files generated on the local machine will
- be opened. SD_JOURNAL_RUNTIME_ONLY
+ be opened. SD_JOURNAL_RUNTIME_ONLY
makes sure only volatile journal files will be opened,
excluding those which are stored on persistent
- storage. SD_JOURNAL_SYSTEM
+ 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
+ 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
+ opened. If neither SD_JOURNAL_SYSTEM
+ nor SD_JOURNAL_CURRENT_USER are
specified, all journal file types will be opened.
sd_journal_open_directory()
@@ -121,11 +129,29 @@
sd_journal_open_files()
is similar to sd_journal_open()
- but takes a NULL-terminated list
+ 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.
+ are currently understood for this call. Please note
+ that in the 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 is inherently racy.
+
+ sd_journal_open_container()
+ is similar to sd_journal_open()
+ but opens the journal files of a running
+ OS container. The specified machine name refers to a
+ container that is registered with
+ systemd-machined8.
+
+ sd_journal objects cannot be
+ used in the child after a fork. Functions which take a
+ journal object as an argument
+ (sd_journal_next() and others)
+ will return -ECHILD after a fork.
+
sd_journal_close() will
close the journal context allocated with
@@ -135,12 +161,12 @@
When opening the journal only journal files
accessible to the calling user will be opened. If
- journal files are not accessible to the caller this
+ 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
+ for an example of how to iterate through the journal
after opening it with
sd_journal_open().
@@ -171,8 +197,9 @@
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.
@@ -184,10 +211,9 @@
The sd_journal_open(),
sd_journal_open_directory() and
sd_journal_close() interfaces are
- available as shared library, which can be compiled and
+ available as a shared library, which can be compiled and
linked to with the
- libsystemd-journal
- pkg-config1
+ libsystemd pkg-config1
file.
@@ -196,19 +222,19 @@
sd_journal_open(),
sd_journal_close(),
- SD_JOURNAL_LOCAL_ONLY,
- SD_JOURNAL_RUNTIME_ONLY,
- SD_JOURNAL_SYSTEM_ONLY were added
+ 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,
+ SD_JOURNAL_SYSTEM,
+ SD_JOURNAL_CURRENT_USER,
and sd_journal_open_files()
were added in systemd-205.
- SD_JOURNAL_SYSTEM_ONLY
+ SD_JOURNAL_SYSTEM_ONLY
was deprecated.
@@ -219,7 +245,8 @@
systemd1,
sd-journal3,
sd_journal_next3,
- sd_journal_get_data3
+ sd_journal_get_data3,
+ systemd-machined8