sd-journal.xml revision 494a66821815e8109afa136bd42818b85da38c09
2N/A<?xml version='1.0'?> <!--*-nxml-*-->
2N/A<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2N/A "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
2N/A
2N/A<!--
2N/A This file is part of systemd.
2N/A
2N/A Copyright 2012 Lennart Poettering
2N/A
2N/A systemd is free software; you can redistribute it and/or modify it
2N/A under the terms of the GNU Lesser General Public License as published by
2N/A the Free Software Foundation; either version 2.1 of the License, or
2N/A (at your option) any later version.
2N/A
2N/A systemd is distributed in the hope that it will be useful, but
2N/A WITHOUT ANY WARRANTY; without even the implied warranty of
2N/A MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2N/A Lesser General Public License for more details.
2N/A
2N/A You should have received a copy of the GNU Lesser General Public License
2N/A along with systemd; If not, see <http://www.gnu.org/licenses/>.
2N/A-->
2N/A
2N/A<refentry id="sd-journal">
2N/A
2N/A <refentryinfo>
2N/A <title>sd-journal</title>
2N/A <productname>systemd</productname>
2N/A
2N/A <authorgroup>
2N/A <author>
2N/A <contrib>Developer</contrib>
2N/A <firstname>Lennart</firstname>
2N/A <surname>Poettering</surname>
2N/A <email>lennart@poettering.net</email>
2N/A </author>
2N/A </authorgroup>
2N/A </refentryinfo>
2N/A
2N/A <refmeta>
2N/A <refentrytitle>sd-journal</refentrytitle>
2N/A <manvolnum>3</manvolnum>
2N/A </refmeta>
2N/A
2N/A <refnamediv>
2N/A <refname>sd-journal</refname>
2N/A <refpurpose>APIs for submitting and querying log entries to and from the journal</refpurpose>
2N/A </refnamediv>
2N/A
2N/A <refsynopsisdiv>
2N/A <funcsynopsis>
2N/A <funcsynopsisinfo>#include &lt;systemd/sd-journal.h&gt;</funcsynopsisinfo>
2N/A </funcsynopsis>
2N/A
2N/A <cmdsynopsis>
2N/A <command>pkg-config --cflags --libs libsystemd-journal</command>
2N/A </cmdsynopsis>
2N/A
2N/A </refsynopsisdiv>
2N/A
2N/A <refsect1>
2N/A <title>Description</title>
2N/A
2N/A <para><filename>sd-journal.h</filename> provides APIs
2N/A to submit and query log entries. The APIs exposed act
2N/A both as client for the
2N/A <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
2N/A journal service and as parser for the journal files
2N/A on disk.
2N/A </para>
2N/A
2N/A <para>See
2N/A <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2N/A <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2N/A <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2N/A <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2N/A <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2N/A <citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2N/A <citerefentry><refentrytitle>sd_journal_seek_head</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2N/A <citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2N/A <citerefentry><refentrytitle>sd_journal_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2N/A <citerefentry><refentrytitle>sd_journal_get_usage</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2N/A <citerefentry><refentrytitle>sd_journal_get_catalog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
2N/A and
2N/A <citerefentry><refentrytitle>sd_journal_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>
2N/A for more information about the functions
2N/A implemented.</para>
2N/A
2N/A <para>Command line access for submitting entries to
2N/A the journal is available with the
2N/A <citerefentry><refentrytitle>systemd-cat</refentrytitle><manvolnum>1</manvolnum></citerefentry>
2N/A tool. Command line access for querying entries from
2N/A the journal is available with the
2N/A <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
2N/A tool.</para>
2N/A </refsect1>
2N/A
2N/A <refsect1>
2N/A <title>Notes</title>
2N/A
2N/A <para>These APIs are implemented as a shared library,
2N/A which can be compiled and linked to with the
2N/A <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
2N/A file.</para>
2N/A </refsect1>
2N/A
2N/A <refsect1>
2N/A <title>See Also</title>
2N/A <para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_stream_fd</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_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_seek_head</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_get_usage</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_query_unique</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_get_catalog</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>