mirror of
https://github.com/systemd/systemd.git
synced 2025-01-27 10:54:11 +08:00
man: document sd_journal_get_cutoff_realtime_usec()
This commit is contained in:
Lennart Poettering
parent
7a8a6e8854
commit
b59866aefa
@ -504,7 +504,8 @@ MANPAGES = \
|
||||
man/sd_journal_open.3 \
|
||||
man/sd_journal_next.3 \
|
||||
man/sd_journal_get_data.3 \
|
||||
man/sd_journal_get_realtime_usec.3
|
||||
man/sd_journal_get_realtime_usec.3 \
|
||||
man/sd_journal_get_cutoff_realtime_usec.3
|
||||
|
||||
MANPAGES_ALIAS = \
|
||||
man/reboot.8 \
|
||||
@ -555,7 +556,8 @@ MANPAGES_ALIAS = \
|
||||
man/sd_journal_enumerate_data.3 \
|
||||
man/sd_journal_restart_data.3 \
|
||||
man/SD_JOURNAL_FOREACH_DATA.3 \
|
||||
man/sd_journal_get_monotonic_usec.3
|
||||
man/sd_journal_get_monotonic_usec.3 \
|
||||
man/sd_journal_get_cutoff_monotonic_usec.3
|
||||
|
||||
man/reboot.8: man/halt.8
|
||||
man/poweroff.8: man/halt.8
|
||||
@ -606,6 +608,7 @@ 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
|
||||
man/sd_journal_get_cutoff_monotonic_usec.3: man/sd_journal_get_cutoff_realtime_usec.3
|
||||
|
||||
XML_FILES = \
|
||||
${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,${patsubst %.8,%.xml,$(MANPAGES)}}}}}
|
||||
|
||||
2
TODO
2
TODO
@ -34,6 +34,8 @@ Bugfixes:
|
||||
|
||||
Features:
|
||||
|
||||
* change mount access mode ot 0700 or so for debugfs?
|
||||
|
||||
* logind: wakelock/opportunistic suspend support
|
||||
|
||||
* seccomp filters for services
|
||||
|
||||
142
man/sd_journal_get_cutoff_realtime_usec.xml
Normal file
142
man/sd_journal_get_cutoff_realtime_usec.xml
Normal file
@ -0,0 +1,142 @@
|
||||
<?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_cutoff_realtime_usec">
|
||||
|
||||
<refentryinfo>
|
||||
<title>sd_journal_get_cutoff_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_cutoff_realtime_usec</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>sd_journal_get_cutoff_realtime_usec</refname>
|
||||
<refname>sd_journal_get_cutoff_monotonic_usec</refname>
|
||||
<refpurpose>Read timestamps from the current journal entry</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <systemd/sd-journal.h></funcsynopsisinfo>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_journal_get_cutoff_realtime_usec</function></funcdef>
|
||||
<paramdef>sd_journal* <parameter>j</parameter></paramdef>
|
||||
<paramdef>uint64_t* <parameter>from</parameter></paramdef>
|
||||
<paramdef>uint64_t* <parameter>to</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_journal_get_cutoff_monotonic_usec</function></funcdef>
|
||||
<paramdef>sd_journal* <parameter>j</parameter></paramdef>
|
||||
<paramdef>sd_id128_t <parameter>boot_id</parameter></paramdef>
|
||||
<paramdef>uint64_t* <parameter>from</parameter></paramdef>
|
||||
<paramdef>uint64_t* <parameter>to</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<para><function>sd_journal_get_cutoff_realtime_usec()</function>
|
||||
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.</para>
|
||||
|
||||
<para><function>sd_journal_get_cutoff_monotonic_usec()</function>
|
||||
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
|
||||
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
|
||||
<citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
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.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Return Value</title>
|
||||
|
||||
<para><function>sd_journal_get_cutoff_realtime_usec()</function>
|
||||
and
|
||||
<function>sd_journal_get_cutoff_monotonic_usec()</function>
|
||||
return 1 on success, 0 if not suitable entries are in
|
||||
the journal or a negative errno-style error code.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Notes</title>
|
||||
|
||||
<para>The
|
||||
<function>sd_journal_get_cutoff_realtime_usec()</function>
|
||||
and
|
||||
<function>sd_journal_get_cutoff_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_get_realtime_usec</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>
|
||||
@ -72,15 +72,15 @@
|
||||
<title>Description</title>
|
||||
|
||||
<para><function>sd_journal_get_realtime_usec()</function>
|
||||
gets the realtime (wallclock) timestamp of the the
|
||||
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.</para>
|
||||
|
||||
<para><function>sd_journal_get_realtime_usec()</function>
|
||||
gets the monotonic timestamp of the the current
|
||||
<para><function>sd_journal_get_monotonic_usec()</function>
|
||||
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
|
||||
@ -89,7 +89,7 @@
|
||||
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
|
||||
<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
|
||||
@ -138,7 +138,8 @@
|
||||
<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>
|
||||
<citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_journal_get_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
@ -639,7 +639,7 @@ int show_journal_by_unit(
|
||||
if (r < 0)
|
||||
goto finish;
|
||||
|
||||
if (not_before < cutoff)
|
||||
if (r > 0 && not_before < cutoff)
|
||||
printf("Warning: Journal has been rotated since unit was started. Log output is incomplete or unavailable.\n");
|
||||
|
||||
warn_cutoff = false;
|
||||
|
||||
Loading…
Reference in New Issue
Block a user