71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt<?xml version='1.0'?> <!--*-nxml-*-->

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt<refentry id="sd-journal">

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <refentryinfo>

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt <title>sd-journal</title>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <productname>systemd</productname>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <authorgroup>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <author>

8a743600ddfcd97adbbd83f8e9f546ce7d365acbEvan Hunt <contrib>Developer</contrib>

8fda09fc85d395d2dc955d23c5eb476cf4d2dffbEvan Hunt <firstname>Lennart</firstname>

8fda09fc85d395d2dc955d23c5eb476cf4d2dffbEvan Hunt <surname>Poettering</surname>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <email>lennart@poettering.net</email>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt </author>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt </authorgroup>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt </refentryinfo>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <refmeta>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <refentrytitle>sd-journal</refentrytitle>

8a743600ddfcd97adbbd83f8e9f546ce7d365acbEvan Hunt <manvolnum>3</manvolnum>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt </refmeta>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <refnamediv>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <refname>sd-journal</refname>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <refpurpose>APIs for submitting and querying log entries to and from the journal</refpurpose>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt </refnamediv>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt

8a743600ddfcd97adbbd83f8e9f546ce7d365acbEvan Hunt <refsynopsisdiv>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <funcsynopsis>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <funcsynopsisinfo>#include &lt;systemd/sd-journal.h&gt;</funcsynopsisinfo>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt </funcsynopsis>

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <cmdsynopsis>

3916872f379457fe344afb02398a009701c5016aEvan Hunt <command>pkg-config --cflags --libs libsystemd-journal</command>

3916872f379457fe344afb02398a009701c5016aEvan Hunt </cmdsynopsis>

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt

3916872f379457fe344afb02398a009701c5016aEvan Hunt </refsynopsisdiv>

3916872f379457fe344afb02398a009701c5016aEvan Hunt

3916872f379457fe344afb02398a009701c5016aEvan Hunt <refsect1>

3916872f379457fe344afb02398a009701c5016aEvan Hunt <title>Description</title>

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt <para><filename>sd-journal.h</filename> provides APIs

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt to submit and query log entries. The APIs exposed act

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt both as client for the

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt journal service and as parser for the journal files

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt on disk.

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt </para>

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt <para>See

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

0994d3a21baeedf28cbf7e461b3bd8de5f9a6654Evan Hunt <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

8a743600ddfcd97adbbd83f8e9f546ce7d365acbEvan Hunt <citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

71bd858d8ed62672e7c23999dc7c02fd16a55089Evan Hunt <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_catalog</refentrytitle><manvolnum>3</manvolnum></citerefentry>

and

<citerefentry><refentrytitle>sd_journal_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>

for more information about the functions

implemented.</para>

<para>Command line access for submitting entries to

the journal is available with the

<citerefentry><refentrytitle>systemd-cat</refentrytitle><manvolnum>1</manvolnum></citerefentry>

tool. Command line access for querying entries from

the journal is available with the

<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>

tool.</para>

</refsect1>

<refsect1>

<title>Notes</title>

<para>These APIs are implemented as shared library,

which can be compiled and linked to with the

<constant>libsystemd-journal</constant>

<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_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>