sd-journal.xml revision 3c1668da6202f1ead3d4d3981b89e9da1a0e98e3
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering This file is part of systemd.
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering Copyright 2012 Lennart Poettering
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering systemd is free software; you can redistribute it and/or modify it
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering under the terms of the GNU Lesser General Public License as published by
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering the Free Software Foundation; either version 2.1 of the License, or
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering (at your option) any later version.
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering systemd is distributed in the hope that it will be useful, but
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering WITHOUT ANY WARRANTY; without even the implied warranty of
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering Lesser General Public License for more details.
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering You should have received a copy of the GNU Lesser General Public License
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering along with systemd; If not, see <http://www.gnu.org/licenses/>.
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <refentryinfo>
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering </authorgroup>
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering </refentryinfo>
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <refentrytitle>sd-journal</refentrytitle>
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <refpurpose>APIs for submitting and querying log entries to and from the journal</refpurpose>
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <refsynopsisdiv>
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <funcsynopsis>
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <funcsynopsisinfo>#include <systemd/sd-journal.h></funcsynopsisinfo>
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering </funcsynopsis>
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <command>pkg-config --cflags --libs libsystemd-journal</command>
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering </cmdsynopsis>
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering </refsynopsisdiv>
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <para><filename>sd-journal.h</filename> provides APIs
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering to submit and query log entries. The APIs exposed act
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering both as client for the
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering journal service and as parser for the journal files
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>sd_journal_seek_head</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>sd_journal_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>sd_journal_get_usage</refentrytitle><manvolnum>3</manvolnum></citerefentry>
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>sd_journal_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering for more information about the functions
2cfbd749af308bdbe56edcfed7f3eea0fc2b93d2Lennart Poettering implemented.</para>
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <para>Command line access for submitting entries to
2cfbd749af308bdbe56edcfed7f3eea0fc2b93d2Lennart Poettering the journal is available with the
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>systemd-cat</refentrytitle><manvolnum>1</manvolnum></citerefentry>
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering tool. Command line access for querying entries from
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering the journal is available with the
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <para>These APIs are implemented as shared library,
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering which can be compiled and linked to with the
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>sd_journal_seek_head</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
41f9172f427bdbb8221c64029f78364b8dd4e527Lennart Poettering <citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2cfbd749af308bdbe56edcfed7f3eea0fc2b93d2Lennart Poettering <citerefentry><refentrytitle>sd_journal_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2cfbd749af308bdbe56edcfed7f3eea0fc2b93d2Lennart Poettering <citerefentry><refentrytitle>sd_journal_get_usage</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2cfbd749af308bdbe56edcfed7f3eea0fc2b93d2Lennart Poettering <citerefentry><refentrytitle>sd_journal_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2cfbd749af308bdbe56edcfed7f3eea0fc2b93d2Lennart Poettering <citerefentry><refentrytitle>sd_journal_query_unique</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
19f6d710772305610b928bc2678b9d77fe11e770Lennart Poettering <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>