X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_journal_open.xml;h=2d1dbc32f8a1619c9c06646c311ab2ee2a9b4800;hp=d7ea8ff95b4fe9c2cf6a9b8c4be8bdf046fa8257;hb=6992efee44d3affd17dd9174e8673ae63ba01ec7;hpb=74d005783e355acc784d123024e33bbb66ef9ef1

diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml
index d7ea8ff95..2d1dbc32f 100644
--- a/man/sd_journal_open.xml
+++ b/man/sd_journal_open.xml
@@ -46,6 +46,7 @@
                 <refname>sd_journal_open</refname>
                 <refname>sd_journal_open_directory</refname>
                 <refname>sd_journal_open_files</refname>
+                <refname>sd_journal_open_container</refname>
                 <refname>sd_journal_close</refname>
                 <refname>sd_journal</refname>
                 <refname>SD_JOURNAL_LOCAL_ONLY</refname>
@@ -61,27 +62,34 @@
 
                         <funcprototype>
                                 <funcdef>int <function>sd_journal_open</function></funcdef>
-                                <paramdef>sd_journal** <parameter>ret</parameter></paramdef>
+                                <paramdef>sd_journal **<parameter>ret</parameter></paramdef>
                                 <paramdef>int <parameter>flags</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_journal_open_directory</function></funcdef>
-                                <paramdef>sd_journal** <parameter>ret</parameter></paramdef>
-                                <paramdef>const char* <parameter>path</parameter></paramdef>
+                                <paramdef>sd_journal **<parameter>ret</parameter></paramdef>
+                                <paramdef>const char *<parameter>path</parameter></paramdef>
                                 <paramdef>int <parameter>flags</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_journal_open_files</function></funcdef>
-                                <paramdef>sd_journal** <parameter>ret</parameter></paramdef>
-                                <paramdef>const char** <parameter>paths</parameter></paramdef>
+                                <paramdef>sd_journal **<parameter>ret</parameter></paramdef>
+                                <paramdef>const char **<parameter>paths</parameter></paramdef>
+                                <paramdef>int <parameter>flags</parameter></paramdef>
+                        </funcprototype>
+
+                        <funcprototype>
+                                <funcdef>int <function>sd_journal_open_container</function></funcdef>
+                                <paramdef>sd_journal **<parameter>ret</parameter></paramdef>
+                                <paramdef>const char *<parameter>machine</parameter></paramdef>
                                 <paramdef>int <parameter>flags</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>void <function>sd_journal_close</function></funcdef>
-                                <paramdef>sd_journal* <parameter>j</parameter></paramdef>
+                                <paramdef>sd_journal *<parameter>j</parameter></paramdef>
                         </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
@@ -131,6 +139,20 @@
                 can be rotated at any moment, and the opening of
                 specific files is inherently racy.</para>
 
+                <para><function>sd_journal_open_container()</function>
+                is similar to <function>sd_journal_open()</function>
+                but opens the journal files of a running
+                OS container. The specified machine name refers to a
+                container that is registered with
+                <citerefentry><refentrytitle>systemd-machined</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+
+                <para><varname>sd_journal</varname> objects cannot be
+                used in the child after a fork. Functions which take a
+                journal object as an argument
+                (<function>sd_journal_next()</function> and others)
+                will return <constant>-ECHILD</constant> after a fork.
+                </para>
+
                 <para><function>sd_journal_close()</function> will
                 close the journal context allocated with
                 <function>sd_journal_open()</function> or
@@ -139,7 +161,7 @@
 
                 <para>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.</para>
 
                 <para>See
@@ -191,8 +213,7 @@
                 <function>sd_journal_close()</function> interfaces are
                 available as a shared library, which can be compiled and
                 linked to with the
-                <constant>libsystemd-journal</constant>
-                <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
         </refsect1>
 
@@ -224,7 +245,8 @@
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>sd_journal_next</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>systemd-machined</refentrytitle><manvolnum>8</manvolnum></citerefentry>
                 </para>
         </refsect1>