chiark / gitweb /
run: add a new "-t" mode for invoking a binary on an allocated TTY
[elogind.git] / man / sd_journal_seek_head.xml
index b10f069..2ef37e5 100644 (file)
 
                         <funcprototype>
                                 <funcdef>int <function>sd_journal_seek_head</function></funcdef>
-                                <paramdef>sd_journal<parameter>j</parameter></paramdef>
+                                <paramdef>sd_journal *<parameter>j</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_journal_seek_tail</function></funcdef>
-                                <paramdef>sd_journal<parameter>j</parameter></paramdef>
+                                <paramdef>sd_journal *<parameter>j</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_journal_seek_monotonic_usec</function></funcdef>
-                                <paramdef>sd_journal<parameter>j</parameter></paramdef>
+                                <paramdef>sd_journal *<parameter>j</parameter></paramdef>
                                 <paramdef>sd_id128_t <parameter>boot_id</parameter></paramdef>
                                 <paramdef>uint64_t <parameter>usec</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_journal_seek_realtime_usec</function></funcdef>
-                                <paramdef>sd_journal<parameter>j</parameter></paramdef>
+                                <paramdef>sd_journal *<parameter>j</parameter></paramdef>
                                 <paramdef>uint64_t <parameter>usec</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_journal_seek_cursor</function></funcdef>
-                                <paramdef>sd_journal<parameter>j</parameter></paramdef>
-                                <paramdef>const char * <parameter>cursor</parameter></paramdef>
+                                <paramdef>sd_journal *<parameter>j</parameter></paramdef>
+                                <paramdef>const char *<parameter>cursor</parameter></paramdef>
                         </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
                 seeks to the beginning of the journal, i.e. the oldest
                 available entry.</para>
 
-                <para>Similar,
+                <para>Similarly,
                 <function>sd_journal_seek_tail()</function> may be
                 used to seek to the end of the journal, i.e. the most
                 recent available entry.</para>
 
                 <para><function>sd_journal_seek_monotonic_usec()</function>
                 seeks to the entry with the specified monotonic
-                timestamp, i.e. CLOCK_MONOOTONIC. Since monotonic time
-                restarts on every reboot a boot ID needs to be
-                specified as well.</para>
+                timestamp,
+                i.e. <constant>CLOCK_MONOTONIC</constant>. Since
+                monotonic time restarts on every reboot a boot ID
+                needs to be specified as well.</para>
 
                 <para><function>sd_journal_seek_realtime_usec()</function>
                 seeks to the entry with the specified realtime
-                (wallclock) timestamp, i.e. CLOCK_REALTIME. Note that
-                the realtime clock is not necessary monotonic. If a
-                realtime timestamp is ambiguous it is not defined
+                (wallclock) timestamp,
+                i.e. <constant>CLOCK_REALTIME</constant>. Note that
+                the realtime clock is not necessarily monotonic. If a
+                realtime timestamp is ambiguous, it is not defined
                 which position is sought to.</para>
 
                 <para><function>sd_journal_seek_cursor()</function>
                 seeks to the entry located at the specified cursor
-                string. For details on cursors see
+                string. For details on cursors, see
                 <citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>. If
                 no entry matching the specified cursor is found the
                 call will seek to the next closest entry (in terms of
                 time) instead. To verify whether the newly selected
-                entry actually matches the cursor use
+                entry actually matches the cursor, use
                 <citerefentry><refentrytitle>sd_journal_test_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
 
                 <para>Note that these calls do not actually make any
                 entry the new current entry, this needs to be done in
                 a separate step with a subsequent
                 <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>
-                invocation (or a similar call). Only then entry data
+                invocation (or a similar call). Only then, entry data
                 may be retrieved via
                 <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>. If
                 no entry exists that matches exactly the specified
-                seek address the next closest is sought to. If
+                seek address, the next closest is sought to. If
                 <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>
-                is used the closest following entry will be sought to,
+                is used, the closest following entry will be sought to,
                 if
                 <citerefentry><refentrytitle>sd_journal_previous</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 is used the closest preceding entry is sought
                 <function>sd_journal_seek_monotonic_usec()</function>,
                 <function>sd_journal_seek_realtime_usec()</function>,
                 and <function>sd_journal_seek_cursor()</function>
-                interfaces are available as shared library, which can
+                interfaces are available as 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 project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
         </refsect1>