From 7a8a6e88545bf22909941c9b022873709a1a1c9e Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 13 Jul 2012 19:32:11 +0200 Subject: [PATCH] man: document sd_journal_get_realtime_usec() --- Makefile.am | 7 +- man/sd_journal_get_data.xml | 5 +- man/sd_journal_get_realtime_usec.xml | 145 +++++++++++++++++++++++++++ 3 files changed, 153 insertions(+), 4 deletions(-) create mode 100644 man/sd_journal_get_realtime_usec.xml diff --git a/Makefile.am b/Makefile.am index b54c21b37..8e6e3fcbc 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 9d8a4a222..6f20c6201 100644 --- a/man/sd_journal_get_data.xml +++ b/man/sd_journal_get_data.xml @@ -126,7 +126,7 @@ Note that these functions will not work before sd_journal_next3 - (or related call) has not been called at least + (or related call) has been called at least once. @@ -192,7 +192,8 @@ int print_fields(sd_journal *j) { systemd.journal-fields7, sd-journal3, sd_journal_open3, - sd_journal_next3 + sd_journal_next3, + sd_journal_get_realtime_usec3 diff --git a/man/sd_journal_get_realtime_usec.xml b/man/sd_journal_get_realtime_usec.xml new file mode 100644 index 000000000..bebf4f5a3 --- /dev/null +++ b/man/sd_journal_get_realtime_usec.xml @@ -0,0 +1,145 @@ + + + + + + + + + sd_journal_get_realtime_usec + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + sd_journal_get_realtime_usec + 3 + + + + sd_journal_get_realtime_usec + sd_journal_get_monotonic_usec + Read timestamps from the current journal entry + + + + + #include <systemd/sd-journal.h> + + + int sd_journal_get_realtime_usec + sd_journal* j + uint64_t* usec + + + + int sd_journal_get_monotonic_usec + sd_journal* j + uint64_t* usec + sd_id128_t* boot_id + + + + + + + Description + + sd_journal_get_realtime_usec() + 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. + + sd_journal_get_realtime_usec() + 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 + sd_id128_get_boot3 + 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. + + Note that these functions will not work before + sd_journal_next3 + (or related call) has been called at least + once. + + + + Return Value + + sd_journal_get_realtime_usec() + and + sd_journal_get_monotonic_usec() + 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 sd_journal_get_monotonic_usec(). + + + + Notes + + The + sd_journal_get_realtime_usec() + and + sd_journal_get_monotonic_usec() + interfaces are available as shared library, which can + be compiled and linked to with the + libsystemd-journal + pkg-config1 + file. + + + + See Also + + + systemd1, + sd-journal3, + sd_journal_open3, + sd_journal_next3, + sd_journal_get_data3, + sd_id128_get_boot3, + clock_gettime2 + + + + -- 2.30.2