1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd-cat"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd-cat</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-cat</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-cat</refname>
<refpurpose>Connect a pipeline or program's output with the journal</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>systemd-cat</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>COMMAND</arg> <arg choice="opt" rep="repeat">ARGUMENTS</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-cat</command> <arg choice="opt" rep="repeat">OPTIONS</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><command>systemd-cat</command> may be used to connect the
standard input and output of a process to the journal, or as a
filter tool in a shell pipeline to pass the output the previous
pipeline element generates to the journal.</para>
<para>If no parameter is passed, <command>systemd-cat</command>
will write everything it reads from standard input (stdin) to the
journal.</para>
<para>If parameters are passed, they are executed as command line
with standard output (stdout) and standard error output (stderr)
connected to the journal, so that all it writes is stored in the
journal.</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
<varlistentry>
<term><option>-t</option></term>
<term><option>--identifier=</option></term>
<listitem><para>Specify a short string that is used to
identify the logging tool. If not specified, no identification
string is set for the journal entry, and the executable name
(or <literal>cat</literal> if the input is read from a pipe)
will be used to describe the log source instead.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option></term>
<term><option>--priority=</option></term>
<listitem><para>Specify the default priority level for the
logged messages. Pass one of
<literal>emerg</literal>,
<literal>alert</literal>,
<literal>crit</literal>,
<literal>err</literal>,
<literal>warning</literal>,
<literal>notice</literal>,
<literal>info</literal>,
<literal>debug</literal>, or a
value between 0 and 7 (corresponding to the same named
levels). These priority values are the same as defined by
<citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
Defaults to <literal>info</literal>. Note that this simply
controls the default, individual lines may be logged with
different levels if they are prefixed accordingly. For details,
see <option>--level-prefix=</option> below.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--stderr-priority=</option></term>
<listitem><para>Specifies the default priority level for
messages from the process's standard error output (stderr).
Usage of this option is the same as the
<option>--priority=</option> option, above, and both can be
used at once. When both are used, <option>--priority=</option>
will specify the default priority for standard output (stdout).
</para>
<para>If <option>--stderr-priority=</option> is not specified,
messages from stderr will still be logged, with the same
default priority level as stdout.</para>
<para>Also, note that when stdout and stderr use the same
default priority, the messages will be strictly ordered,
because one channel is used for both. When the default priority
differs, two channels are used, and so stdout messages will not
be strictly ordered with respect to stderr messages - though
they will tend to be approximately ordered.</para>
<xi:include href="version-info.xml" xpointer="v241"/></listitem>
</varlistentry>
<varlistentry>
<term><option>--level-prefix=</option></term>
<listitem><para>Controls whether lines read are parsed for syslog priority level prefixes. If enabled
(the default), a line prefixed with a priority prefix such as <literal><5></literal> is logged
at priority 5 (<literal>notice</literal>), and similarly for the other priority levels. Takes a
boolean argument.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--namespace=</option></term>
<listitem><para>Specifies the journal namespace to which the standard IO should be connected.
For details about journal namespaces, see
<citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
<xi:include href="version-info.xml" xpointer="v256"/></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure code otherwise.</para>
</refsect1>
<refsect1>
<title>Examples</title>
<example>
<title>Invoke a program</title>
<para>This calls <filename index="false">/bin/ls</filename>
with standard output and error connected to the journal:</para>
<programlisting># systemd-cat ls</programlisting>
</example>
<example>
<title>Usage in a shell pipeline</title>
<para>This builds a shell pipeline also invoking
<filename>/bin/ls</filename> and writes the output it generates
to the journal:</para>
<programlisting># ls | systemd-cat</programlisting>
</example>
<para>Even though the two examples have very similar effects, the first is preferable, since only one
process is running at a time and both stdout and stderr are captured, while in the second example, only
stdout is captured.</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry project='man-pages'><refentrytitle>logger</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
</simplelist></para>
</refsect1>
</refentry>
|
