X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_journal_get_realtime_usec.xml;h=8870c29e30a673c9ffe90d350e0982ab38ec64e4;hp=bebf4f5a3ce1a2dde1d911c04f2576d377465935;hb=accdd018ede77ef1c057775396c18c73406cbcb4;hpb=7a8a6e88545bf22909941c9b022873709a1a1c9e diff --git a/man/sd_journal_get_realtime_usec.xml b/man/sd_journal_get_realtime_usec.xml index bebf4f5a3..8870c29e3 100644 --- a/man/sd_journal_get_realtime_usec.xml +++ b/man/sd_journal_get_realtime_usec.xml @@ -72,34 +72,35 @@ 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 + gets the realtime (wallclock) timestamp of 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 + i.e. CLOCK_REALTIME. + + sd_journal_get_monotonic_usec() + gets the monotonic timestamp of 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. + 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 + together with an 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. + 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. + once, in order to position the read pointer at a valid entry. @@ -109,7 +110,7 @@ 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 + 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(). @@ -123,8 +124,7 @@ sd_journal_get_monotonic_usec() interfaces are available as shared library, which can be compiled and linked to with the - libsystemd-journal - pkg-config1 + libsystemd-journal pkg-config1 file. @@ -138,7 +138,8 @@ sd_journal_next3, sd_journal_get_data3, sd_id128_get_boot3, - clock_gettime2 + clock_gettime2, + sd_journal_get_cutoff_realtime_usec3