mirror of
https://github.com/systemd/systemd.git
synced 2024-11-24 02:33:36 +08:00
845c53246f
Everything which is an absolute filename marked with <filename></filename> lands in the index, unless noindex= attribute is present. Should make it easier for people to find stuff when they are looking at a file on disk. Various formatting errors in manpages are fixed, kernel-install(1) is restored to formatting sanity.
206 lines
8.7 KiB
XML
206 lines
8.7 KiB
XML
<?xml version='1.0'?> <!--*-nxml-*-->
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
|
<!--
|
|
This file is part of systemd.
|
|
|
|
Copyright 2012 Lennart Poettering
|
|
|
|
systemd is free software; you can redistribute it and/or modify it
|
|
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
|
|
Lesser General Public License for more details.
|
|
|
|
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">
|
|
|
|
<refentryinfo>
|
|
<title>systemd-cat</title>
|
|
<productname>systemd</productname>
|
|
|
|
<authorgroup>
|
|
<author>
|
|
<contrib>Developer</contrib>
|
|
<firstname>Lennart</firstname>
|
|
<surname>Poettering</surname>
|
|
<email>lennart@poettering.net</email>
|
|
</author>
|
|
</authorgroup>
|
|
</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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>COMMAND</arg> <arg choice="opt" rep="repeat">ARGUMENTS</arg></command>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>systemd-cat <arg choice="opt" rep="repeat">OPTIONS</arg></command>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
|
|
<para><command>systemd-cat</command> may be used to
|
|
connect STDOUT and STDERR of a process with 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>
|
|
<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>
|
|
|
|
<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 identifying
|
|
string is written to the journal.</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><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>--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
|
|
similar for the other priority
|
|
levels. Takes a boolean
|
|
argument.</para></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 noindex='true'>/bin/ls</filename>
|
|
with STDOUT/STDERR 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>
|
|
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
<citerefentry><refentrytitle>logger</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|