summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2012-07-13 19:32:11 +0200
committerLennart Poettering <lennart@poettering.net>2012-07-13 19:32:11 +0200
commit7a8a6e88545bf22909941c9b022873709a1a1c9e (patch)
tree9b8b7b2842501bd40aa18e950da6aec6cdbd5f8e
parent4171a6676c74846c9c189f3a92b97bbcd4a11a13 (diff)
man: document sd_journal_get_realtime_usec()
-rw-r--r--Makefile.am7
-rw-r--r--man/sd_journal_get_data.xml5
-rw-r--r--man/sd_journal_get_realtime_usec.xml145
3 files changed, 153 insertions, 4 deletions
diff --git a/Makefile.am b/Makefile.am
index b54c21b374..8e6e3fcbca 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -503,7 +503,8 @@ MANPAGES = \
man/sd_journal_stream_fd.3 \
man/sd_journal_open.3 \
man/sd_journal_next.3 \
- man/sd_journal_get_data.3
+ man/sd_journal_get_data.3 \
+ man/sd_journal_get_realtime_usec.3
MANPAGES_ALIAS = \
man/reboot.8 \
@@ -553,7 +554,8 @@ MANPAGES_ALIAS = \
man/SD_JOURNAL_FOREACH_BACKWARDS.3 \
man/sd_journal_enumerate_data.3 \
man/sd_journal_restart_data.3 \
- man/SD_JOURNAL_FOREACH_DATA.3
+ man/SD_JOURNAL_FOREACH_DATA.3 \
+ man/sd_journal_get_monotonic_usec.3
man/reboot.8: man/halt.8
man/poweroff.8: man/halt.8
@@ -603,6 +605,7 @@ man/SD_JOURNAL_FOREACH_BACKWARDS.3: man/sd_journal_next.3
man/sd_journal_enumerate_data.3: man/sd_journal_get_data.3
man/sd_journal_restart_data.3: man/sd_journal_get_data.3
man/SD_JOURNAL_FOREACH_DATA.3: man/sd_journal_get_data.3
+man/sd_journal_get_monotonic_usec.3: man/sd_journal_get_realtime_usec.3
XML_FILES = \
${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,${patsubst %.8,%.xml,$(MANPAGES)}}}}}
diff --git a/man/sd_journal_get_data.xml b/man/sd_journal_get_data.xml
index 9d8a4a2221..6f20c62012 100644
--- a/man/sd_journal_get_data.xml
+++ b/man/sd_journal_get_data.xml
@@ -126,7 +126,7 @@
<para>Note that these functions will not work before
<citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>
- (or related call) has not been called at least
+ (or related call) has been called at least
once.</para>
</refsect1>
@@ -192,7 +192,8 @@ int print_fields(sd_journal *j) {
<citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+ <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para>
</refsect1>
diff --git a/man/sd_journal_get_realtime_usec.xml b/man/sd_journal_get_realtime_usec.xml
new file mode 100644
index 0000000000..bebf4f5a3c
--- /dev/null
+++ b/man/sd_journal_get_realtime_usec.xml
@@ -0,0 +1,145 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+ This file is part of systemd.
+
+ Copyright 2012 Lennart Poettering
+
+ systemd is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
+ (at your option) any later version.
+
+ systemd is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<refentry id="sd_journal_get_realtime_usec">
+
+ <refentryinfo>
+ <title>sd_journal_get_realtime_usec</title>
+ <productname>systemd</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart@poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>sd_journal_get_realtime_usec</refentrytitle>
+ <manvolnum>3</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>sd_journal_get_realtime_usec</refname>
+ <refname>sd_journal_get_monotonic_usec</refname>
+ <refpurpose>Read timestamps from the current journal entry</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcsynopsisinfo>#include &lt;systemd/sd-journal.h&gt;</funcsynopsisinfo>
+
+ <funcprototype>
+ <funcdef>int <function>sd_journal_get_realtime_usec</function></funcdef>
+ <paramdef>sd_journal* <parameter>j</parameter></paramdef>
+ <paramdef>uint64_t* <parameter>usec</parameter></paramdef>
+ </funcprototype>
+
+ <funcprototype>
+ <funcdef>int <function>sd_journal_get_monotonic_usec</function></funcdef>
+ <paramdef>sd_journal* <parameter>j</parameter></paramdef>
+ <paramdef>uint64_t* <parameter>usec</parameter></paramdef>
+ <paramdef>sd_id128_t* <parameter>boot_id</parameter></paramdef>
+ </funcprototype>
+
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><function>sd_journal_get_realtime_usec()</function>
+ gets the realtime (wallclock) timestamp of the the
+ current journal entry. It takes two arguments: the
+ journal context object and a pointer to a 64 Bit
+ unsigned integer to store the timestamp in. The
+ timestamp is in microseconds since the epoch,
+ i.e. CLOCK_REALTIME.</para>
+
+ <para><function>sd_journal_get_realtime_usec()</function>
+ gets the monotonic timestamp of the the current
+ journal entry. It takes three arguments: the journal
+ context object, a pointer to a 64 Bit unsigned integer
+ to store the timestamp in as well as a 128 Bit ID
+ buffer to store the boot ID of the monotonic timestamp
+ in. The timestamp is in microseconds since boot-up of
+ the specific boot, i.e. CLOCK_MONOTONIC. Since the
+ monotonic clock begins new with every reboot it only
+ defines a well-defined point in time when used
+ together with a identifier identifying the boot, see
+ <citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+ for more information. If the boot ID parameter is
+ passed NULL the function will fail if the monotonic
+ timestamp of the current entry is not of the current
+ system boot.</para>
+
+ <para>Note that these functions will not work before
+ <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+ (or related call) has been called at least
+ once.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Return Value</title>
+
+ <para><function>sd_journal_get_realtime_usec()</function>
+ and
+ <function>sd_journal_get_monotonic_usec()</function>
+ returns 0 on success or a negative errno-style error
+ code. If the boot ID parameter was passed NULL and the
+ monotonic timestamp of the current journal entry is
+ not of the current system boot, -ESTALE is returned by <function>sd_journal_get_monotonic_usec()</function>.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>Notes</title>
+
+ <para>The
+ <function>sd_journal_get_realtime_usec()</function>
+ and
+ <function>sd_journal_get_monotonic_usec()</function>
+ 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>
+ file.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+
+ <para>
+ <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>sd_journal_open</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_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>