X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_journal_get_cutoff_realtime_usec.xml;h=673cff45910307b8714334c8e695b37fad018d0c;hp=ed014cb509394b90b97eef534832c46f2a1124fa;hb=92ff080be100aff15f292e2631921131c610afe7;hpb=f274ece0f76b5709408821e317e87aef76123db6
diff --git a/man/sd_journal_get_cutoff_realtime_usec.xml b/man/sd_journal_get_cutoff_realtime_usec.xml
index ed014cb50..673cff459 100644
--- a/man/sd_journal_get_cutoff_realtime_usec.xml
+++ b/man/sd_journal_get_cutoff_realtime_usec.xml
@@ -54,17 +54,17 @@
int sd_journal_get_cutoff_realtime_usec
- sd_journal* j
- uint64_t* from
- uint64_t* to
+ sd_journal *j
+ uint64_t *from
+ uint64_t *to
int sd_journal_get_cutoff_monotonic_usec
- sd_journal* j
+ sd_journal *j
sd_id128_t boot_id
- uint64_t* from
- uint64_t* to
+ uint64_t *from
+ uint64_t *to
@@ -74,23 +74,30 @@
Description
sd_journal_get_cutoff_realtime_usec()
- gets the realtime (wallclock) timestamps of the first
- and last entries accessible in the journal. It takes
- three arguments: the journal context object and two
- pointers to 64 Bit unsigned integers to store the
- timestamps in. The timestamps are in microseconds
- since the epoch, i.e. CLOCK_REALTIME. Either one of
- the two timestamp arguments may be passed as NULL in
- case the timestamp is not needed, but not both.
+ retrieves the realtime (wallclock) timestamps of the
+ first and last entries accessible in the journal. It
+ takes three arguments: the journal context object
+ j and two pointers
+ from and
+ to pointing at 64-bit unsigned
+ integers to store the timestamps in. The timestamps
+ are in microseconds since the epoch,
+ i.e. CLOCK_REALTIME. Either one
+ of the two timestamp arguments may be passed as
+ NULL in case the timestamp is not
+ needed, but not both.
sd_journal_get_cutoff_monotonic_usec()
- gets the monotonic timestamps of the first and last
- entries accessible in the journal. It takes three
- arguments: the journal context object, a 128 Bit
- identifier for the boot, and two pointers to 64 Bit
- unsigned integers to store the timestamps. The
- timestamps are in microseconds since boot-up of the
- specific boot, i.e. CLOCK_MONOTONIC. Since the
+ retrieves the monotonic timestamps of the first and
+ last entries accessible in the journal. It takes three
+ arguments: the journal context object
+ j, a 128-bit identifier for the
+ boot boot_id, and two pointers
+ to 64-bit unsigned integers to store the timestamps,
+ from and
+ to. The timestamps are 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 an identifier identifying the boot, see
@@ -98,8 +105,8 @@
for more information. The function will return the
timestamps for the boot identified by the passed boot
ID. Either one of the two timestamp arguments may be
- passed as NULL in case the timestamp is not needed,
- but not both.
+ passed as NULL in case the
+ timestamp is not needed, but not both.
@@ -110,6 +117,12 @@
sd_journal_get_cutoff_monotonic_usec()
return 1 on success, 0 if not suitable entries are in
the journal or a negative errno-style error code.
+
+ Locations pointed to by parameters
+ from and
+ to will be set only if the
+ return value is positive, and obviously, the
+ parameters are non-null.
@@ -119,10 +132,9 @@
sd_journal_get_cutoff_realtime_usec()
and
sd_journal_get_cutoff_monotonic_usec()
- interfaces are available as shared library, which can
+ interfaces are available as a shared library, which can
be compiled and linked to with the
- libsystemd-journal
- pkg-config1
+ libsystemd pkg-config1
file.