journald: move /dev/log socket to /run

[elogind.git] / man / sd_journal_open.xml

diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml
index 36c9d16019d5484ff83bbd715112972521aa8132..3d8a23ddfcc21b2bcfcffb89c1c57bbeb48bf184 100644 (file)
--- 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</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>
                 <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>
 
                         <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>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>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>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>
                         </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>


@@ -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
                 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 <literal>sd_journal</literal> pointer, which on
+                a <varname>sd_journal</varname> 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:
                 success will contain a journal context object. The
                 second argument is a flags field, which may consist of
                 the following flags ORed together:

-                <literal>SD_JOURNAL_LOCAL_ONLY</literal> makes sure
+                <constant>SD_JOURNAL_LOCAL_ONLY</constant> makes sure

                 only journal files generated on the local machine will
                 only journal files generated on the local machine will

-                be opened. <literal>SD_JOURNAL_RUNTIME_ONLY</literal>
+                be opened. <constant>SD_JOURNAL_RUNTIME_ONLY</constant>

                 makes sure only volatile journal files will be opened,
                 excluding those which are stored on persistent
                 makes sure only volatile journal files will be opened,
                 excluding those which are stored on persistent

-                storage. <literal>SD_JOURNAL_SYSTEM</literal>
+                storage. <constant>SD_JOURNAL_SYSTEM</constant>

                 will cause journal files of system services and the
                 kernel (in opposition to user session processes) to
                 will cause journal files of system services and the
                 kernel (in opposition to user session processes) to

-                be opened. <literal>SD_JOURNAL_CURRENT_USER</literal>
+                be opened. <constant>SD_JOURNAL_CURRENT_USER</constant>

                 will cause journal files of the current user to be
                 will cause journal files of the current user to be

-                opened. If neither <literal>SD_JOURNAL_SYSTEM</literal>
-                nor <literal>SD_JOURNAL_CURRENT_USER</literal> are
+                opened. If neither <constant>SD_JOURNAL_SYSTEM</constant>
+                nor <constant>SD_JOURNAL_CURRENT_USER</constant> are

                 specified, all journal file types will be opened.</para>
 
                 <para><function>sd_journal_open_directory()</function>
                 specified, all journal file types will be opened.</para>
 
                 <para><function>sd_journal_open_directory()</function>


@@ -121,7 +129,7 @@
 
                 <para><function>sd_journal_open_files()</function>
                 is similar to <function>sd_journal_open()</function>
 
                 <para><function>sd_journal_open_files()</function>
                 is similar to <function>sd_journal_open()</function>

-                but takes a <literal>NULL</literal>-terminated list
+                but takes a <constant>NULL</constant>-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
                 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


@@ -131,6 +139,20 @@
                 can be rotated at any moment, and the opening of
                 specific files is inherently racy.</para>
 
                 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
                 <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
 
                 <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
                 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
                 <function>sd_journal_close()</function> interfaces are
                 available as a shared library, which can be compiled and
                 linked to with the

-                <literal>libsystemd-journal</literal>
-                <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>

                 file.</para>
         </refsect1>
 
                 file.</para>
         </refsect1>
 


@@ -201,19 +222,19 @@
 
                 <para><function>sd_journal_open()</function>,
                 <function>sd_journal_close()</function>,
 
                 <para><function>sd_journal_open()</function>,
                 <function>sd_journal_close()</function>,

-                <literal>SD_JOURNAL_LOCAL_ONLY</literal>,
-                <literal>SD_JOURNAL_RUNTIME_ONLY</literal>,
-                <literal>SD_JOURNAL_SYSTEM_ONLY</literal> were added
+                <constant>SD_JOURNAL_LOCAL_ONLY</constant>,
+                <constant>SD_JOURNAL_RUNTIME_ONLY</constant>,
+                <constant>SD_JOURNAL_SYSTEM_ONLY</constant> were added

                 in systemd-38.</para>
 
                 <para><function>sd_journal_open_directory()</function>
                 was added in systemd-187.</para>
 
                 in systemd-38.</para>
 
                 <para><function>sd_journal_open_directory()</function>
                 was added in systemd-187.</para>
 

-                <para><literal>SD_JOURNAL_SYSTEM</literal>,
-                <literal>SD_JOURNAL_CURRENT_USER</literal>,
+                <para><constant>SD_JOURNAL_SYSTEM</constant>,
+                <constant>SD_JOURNAL_CURRENT_USER</constant>,

                 and <function>sd_journal_open_files()</function>
                 were added in systemd-205.
                 and <function>sd_journal_open_files()</function>
                 were added in systemd-205.

-                <literal>SD_JOURNAL_SYSTEM_ONLY</literal>
+                <constant>SD_JOURNAL_SYSTEM_ONLY</constant>

                 was deprecated.</para>
         </refsect1>
 
                 was deprecated.</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>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>
 
                 </para>
         </refsect1>