chiark / gitweb /
core: if we cannot JOB_ISOLATE the default target JOB_REPLACE it instead
[elogind.git] / man / sd_journal_open.xml
index ff089a88e03de792d44483f8fc389609b1853f24..76b857b9916e7a0faf194d4a47f067a02701d2b8 100644 (file)
                 <refname>sd_journal_open</refname>
                 <refname>sd_journal_open_directory</refname>
                 <refname>sd_journal_close</refname>
+                <refname>sd_journal</refname>
+                <refname>SD_JOURNAL_LOCAL_ONLY</refname>
+                <refname>SD_JOURNAL_RUNTIME_ONLY</refname>
+                <refname>SD_JOURNAL_SYSTEM_ONLY</refname>
                 <refpurpose>Open the system journal for reading</refpurpose>
         </refnamediv>
 
@@ -67,7 +71,7 @@
                         </funcprototype>
 
                         <funcprototype>
-                                <funcdef>int <function>sd_journal_close</function></funcdef>
+                                <funcdef>void <function>sd_journal_close</function></funcdef>
                                 <paramdef>sd_journal* <parameter>j</parameter></paramdef>
                         </funcprototype>
                 </funcsynopsis>
         <refsect1>
                 <title>Description</title>
 
-                <para><function>sd_journal_open()</function> opens the
+                <para><function>sd_journal_open()</function> 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 <literal>sd_journal</literal> 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:
                 <literal>SD_JOURNAL_LOCAL_ONLY</literal> makes sure
                 only journal files generated on the local machine will
                 be opened. <literal>SD_JOURNAL_RUNTIME_ONLY</literal>
                 makes sure only volatile journal files will be opened,
-                excluding those which are stored on persistant
+                excluding those which are stored on persistent
                 storage. <literal>SD_JOURNAL_SYSTEM_ONLY</literal>
                 will ensure that only journal files of system services
                 and the kernel (in opposition to user session processes) will
                 <para>See
                 <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 for an example how to iterate through the journal
-                after opening it it with
+                after opening it with
                 <function>sd_journal_open()</function>.</para>
 
                 <para>A journal context object returned by
                 to it (or if the specific entry is not available
                 locally, to its closest entry in time)
                 <citerefentry><refentrytitle>sd_journal_seek_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
+
+                <para>Notification of journal changes is available via
+                <function>sd_journal_get_fd()</function> and related
+                calls.</para>
         </refsect1>
 
         <refsect1>