Copyright 2012 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ Lesser General Public License for more details.
- You should have received a copy of the GNU General Public License
+ You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
-<refentry id="systemd-cat">
+<refentry id="systemd-cat"
+ xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd-cat</title>
<title>Description</title>
<para><command>systemd-cat</command> may be used to
- connect STDOUT and STDERR of a process with the
+ 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-command</command> will write
- everything it reads from standard input (STDIN) 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
+ <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>
<para>The following options are understood:</para>
<variablelist>
- <varlistentry>
- <term><option>--h</option></term>
- <term><option>--help</option></term>
-
- <listitem><para>Prints a short help
- text and exits.</para></listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--version</option></term>
-
- <listitem><para>Prints a short version
- string and exits.</para></listitem>
- </varlistentry>
+ <xi:include href="standard-options.xml" xpointer="help" />
+ <xi:include href="standard-options.xml" xpointer="version" />
<varlistentry>
<term><option>-t</option></term>
<listitem><para>Specify a short string
that is used to identify the logging
- tool. If not specified no identifying
+ tool. If not specified, no identification
string is written to the journal.</para></listitem>
</varlistentry>
<literal>warning</literal>,
<literal>notice</literal>,
<literal>info</literal>,
- <literal>debug</literal>, resp. a
+ <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><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Defaults
+ <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
<listitem><para>Controls whether lines
read are parsed for syslog priority
level prefixes. If enabled (the
- default) a line prefixed with a
+ default), a line prefixed with a
priority prefix such as
<literal><5></literal> is logged
at priority 5
<refsect1>
<title>Exit status</title>
- <para>On success 0 is returned, a non-zero failure
+ <para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<example>
<title>Invoke a program</title>
- <para>This calls <filename>/bin/ls</filename>
- with STDOUT/STDERR connected to the
+ <para>This calls <filename noindex='true'>/bin/ls</filename>
+ with standard output and error connected to the
journal:</para>
<programlisting># systemd-cat ls</programlisting>
<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
+ is running at a time, and both stdout and stderr are
+ captured while in the second example, only stdout is
captured.</para>
</refsect1>