man/sd-journal.3

   1 '\" t
   2 .TH "SD\-JOURNAL" "3" "" "systemd 220" "sd-journal"
   3 .\" -----------------------------------------------------------------
   4 .\" * Define some portability stuff
   5 .\" -----------------------------------------------------------------
   6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7 .\" http://bugs.debian.org/507673
   8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
   9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10 .ie \n(.g .ds Aq \(aq
  11 .el       .ds Aq '
  12 .\" -----------------------------------------------------------------
  13 .\" * set default formatting
  14 .\" -----------------------------------------------------------------
  15 .\" disable hyphenation
  16 .nh
  17 .\" disable justification (adjust text to left margin only)
  18 .ad l
  19 .\" -----------------------------------------------------------------
  20 .\" * MAIN CONTENT STARTS HERE *
  21 .\" -----------------------------------------------------------------
  22 .SH "NAME"
  23 sd-journal \- APIs for submitting and querying log entries to and from the journal
  24 .SH "SYNOPSIS"
  25 .sp
  26 .ft B
  27 .nf
  28 #include <systemd/sd\-journal\&.h>
  29 .fi
  30 .ft
  31 .HP \w'\fBpkg\-config\ \-\-cflags\ \-\-libs\ libsystemd\fR\ 'u
  32 \fBpkg\-config \-\-cflags \-\-libs libsystemd\fR
  33 .SH "DESCRIPTION"
  34 .PP
  35 sd\-journal\&.h
  36 provides APIs to submit and query log entries\&. The APIs exposed act both as client for the
  37 \fBsystemd-journald.service\fR(8)
  38 journal service and as parser for the journal files on disk\&.
  39 .PP
  40 See
  41 \fBsd_journal_print\fR(3),
  42 \fBsd_journal_stream_fd\fR(3),
  43 \fBsd_journal_open\fR(3),
  44 \fBsd_journal_next\fR(3),
  45 \fBsd_journal_get_realtime_usec\fR(3),
  46 \fBsd_journal_add_match\fR(3),
  47 \fBsd_journal_seek_head\fR(3),
  48 \fBsd_journal_get_cursor\fR(3),
  49 \fBsd_journal_get_cutoff_realtime_usec\fR(3),
  50 \fBsd_journal_get_cutoff_monotonic_usec\fR(3),
  51 \fBsd_journal_get_usage\fR(3),
  52 \fBsd_journal_get_catalog\fR(3)
  53 and
  54 \fBsd_journal_get_fd\fR(3)
  55 for more information about the functions implemented\&.
  56 .PP
  57 Command line access for submitting entries to the journal is available with the
  58 \fBsystemd-cat\fR(1)
  59 tool\&. Command line access for querying entries from the journal is available with the
  60 \fBjournalctl\fR(1)
  61 tool\&.
  62 .SH "NOTES"
  63 .PP
  64 These APIs are implemented as a shared library, which can be compiled and linked to with the
  65 \fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
  66 file\&.
  67 .SH "SEE ALSO"
  68 .PP
  69 \fBsystemd\fR(1),
  70 \fBsd_journal_print\fR(3),
  71 \fBsd_journal_stream_fd\fR(3),
  72 \fBsd_journal_open\fR(3),
  73 \fBsd_journal_next\fR(3),
  74 \fBsd_journal_get_data\fR(3),
  75 \fBsd_journal_get_realtime_usec\fR(3),
  76 \fBsd_journal_add_match\fR(3),
  77 \fBsd_journal_seek_head\fR(3),
  78 \fBsd_journal_get_cursor\fR(3),
  79 \fBsd_journal_get_cutoff_realtime_usec\fR(3),
  80 \fBsd_journal_get_cutoff_monotonic_usec\fR(3),
  81 \fBsd_journal_get_usage\fR(3),
  82 \fBsd_journal_get_fd\fR(3),
  83 \fBsd_journal_query_unique\fR(3),
  84 \fBsd_journal_get_catalog\fR(3),
  85 \fBjournalctl\fR(1),
  86 \fBsd-id128\fR(3),
  87 \fBpkg-config\fR(1)