]>
Commit | Line | Data |
---|---|---|
f9378423 | 1 | <?xml version='1.0'?> <!--*-nxml-*--> |
3a54a157 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
0307f791 | 4 | <!-- SPDX-License-Identifier: LGPL-2.1+ --> |
f9378423 | 5 | |
6a70f3aa | 6 | <refentry id="sd-daemon" |
798d3a52 ZJS |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
8 | ||
9 | <refentryinfo> | |
10 | <title>sd-daemon</title> | |
11 | <productname>systemd</productname> | |
798d3a52 ZJS |
12 | </refentryinfo> |
13 | ||
14 | <refmeta> | |
15 | <refentrytitle>sd-daemon</refentrytitle> | |
16 | <manvolnum>3</manvolnum> | |
17 | </refmeta> | |
18 | ||
19 | <refnamediv> | |
20 | <refname>sd-daemon</refname> | |
21 | <refname>SD_EMERG</refname> | |
22 | <refname>SD_ALERT</refname> | |
23 | <refname>SD_CRIT</refname> | |
24 | <refname>SD_ERR</refname> | |
25 | <refname>SD_WARNING</refname> | |
26 | <refname>SD_NOTICE</refname> | |
27 | <refname>SD_INFO</refname> | |
28 | <refname>SD_DEBUG</refname> | |
29 | <refpurpose>APIs for | |
30 | new-style daemons</refpurpose> | |
31 | </refnamediv> | |
32 | ||
33 | <refsynopsisdiv> | |
34 | <funcsynopsis> | |
35 | <funcsynopsisinfo>#include <systemd/sd-daemon.h></funcsynopsisinfo> | |
36 | </funcsynopsis> | |
37 | ||
38 | <cmdsynopsis> | |
39 | <command>pkg-config --cflags --libs libsystemd</command> | |
40 | </cmdsynopsis> | |
41 | ||
42 | </refsynopsisdiv> | |
43 | ||
44 | <refsect1> | |
45 | <title>Description</title> | |
46 | ||
dc83f27a | 47 | <para><filename>sd-daemon.h</filename> provides APIs for new-style |
798d3a52 ZJS |
48 | daemons, as implemented by the |
49 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
dc83f27a | 50 | service manager.</para> |
798d3a52 ZJS |
51 | |
52 | <para>See | |
53 | <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
54 | <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
55 | <citerefentry><refentrytitle>sd_booted</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
56 | <citerefentry><refentrytitle>sd_is_fifo</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
57 | <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry> | |
58 | for more information about the functions implemented. In addition | |
59 | to these functions, a couple of logging prefixes are defined as | |
60 | macros:</para> | |
61 | ||
62 | <programlisting>#define SD_EMERG "<0>" /* system is unusable */ | |
f9378423 LP |
63 | #define SD_ALERT "<1>" /* action must be taken immediately */ |
64 | #define SD_CRIT "<2>" /* critical conditions */ | |
65 | #define SD_ERR "<3>" /* error conditions */ | |
66 | #define SD_WARNING "<4>" /* warning conditions */ | |
67 | #define SD_NOTICE "<5>" /* normal but significant condition */ | |
68 | #define SD_INFO "<6>" /* informational */ | |
69 | #define SD_DEBUG "<7>" /* debug-level messages */</programlisting> | |
70 | ||
9e76a88f LP |
71 | <para>These prefixes are intended to be used in conjunction with stderr-based logging (or stdout-based |
72 | logging) as implemented by systemd. If a systemd service definition file is configured with | |
73 | <varname>StandardError=journal</varname>, <varname>StandardError=syslog</varname> or | |
74 | <varname>StandardError=kmsg</varname> (and similar with <varname>StandardOutput=</varname>), these | |
75 | prefixes can be used to encode a log level in lines printed. This is similar to the kernel | |
76 | <function>printk()</function>-style logging. See | |
77 | <citerefentry><refentrytitle>klogctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> for more | |
78 | information.</para> | |
798d3a52 ZJS |
79 | |
80 | <para>The log levels are identical to | |
81 | <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>'s | |
82 | log level system. To use these prefixes simply prefix every line | |
83 | with one of these strings. A line that is not prefixed will be | |
84 | logged at the default log level SD_INFO.</para> | |
85 | ||
86 | <example> | |
87 | <title>Hello World</title> | |
88 | ||
89 | <para>A daemon may log with the log level NOTICE by issuing this | |
90 | call:</para> | |
91 | ||
92 | <programlisting>fprintf(stderr, SD_NOTICE "Hello World!\n");</programlisting> | |
93 | </example> | |
94 | </refsect1> | |
95 | ||
96 | <xi:include href="libsystemd-pkgconfig.xml" /> | |
97 | ||
98 | <refsect1> | |
99 | <title>See Also</title> | |
100 | <para> | |
101 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
102 | <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
103 | <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
104 | <citerefentry><refentrytitle>sd_booted</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
105 | <citerefentry><refentrytitle>sd_is_fifo</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
106 | <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
107 | <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>, | |
108 | <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
109 | <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
110 | <citerefentry project='man-pages'><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
111 | <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
112 | </para> | |
113 | </refsect1> | |
f9378423 LP |
114 | |
115 | </refentry> |