From 9aac0b2c19c558b853da7a6d67a0929b2d44dee4 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Thu, 15 Mar 2012 22:19:36 +0100 Subject: man: document systemd-cat(1) --- man/systemd-cat.xml | 205 +++++++++++++++++++++++++++++++++++++++++++++++++ man/systemd-notify.xml | 7 ++ 2 files changed, 212 insertions(+) create mode 100644 man/systemd-cat.xml (limited to 'man') diff --git a/man/systemd-cat.xml b/man/systemd-cat.xml new file mode 100644 index 0000000000..41b3685378 --- /dev/null +++ b/man/systemd-cat.xml @@ -0,0 +1,205 @@ + + + + + + + + + systemd-cat + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-cat + 1 + + + + systemd-cat + Connect a pipeline or program's output with the journal + + + + + systemd-cat OPTIONS COMMAND ARGUMENTS + + + systemd-cat OPTIONS + + + + + Description + + systemd-cat 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. + + If no parameter is passed + systemd-command will write + everything it reads from standard input (STDIN) to the journal. + + 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. + + + + Options + + The following options are understood: + + + + + + + Prints a short help + text and exits. + + + + + + Prints a short version + string and exits. + + + + + + + Specify a short string + that is used to identify the logging + tool. If not specified no identifying + string is written to the journal. + + + + + + + Specify the default + priority level for the logged + messages. Pass one of + emerg, + alert, + crit, + err, + warning, + notice, + info, + debug, resp. a + value between 0 and 7 (corresponding + to the same named levels). These + priority values are the same as + defined by + syslog3. Defaults + to info. Note that + this simply controls the default, + individual lines may be logged with + different levels if they are prefixed + accordingly. For details see + + below. + + + + + + Controls whether lines + read are parsed for syslog priority + level prefixes. If enabled (the + default) a line prefixed with a + priority prefix such as + <5> is logged + at priority 5 + (notice), and + similar for the other priority + levels. Takes a boolean + argument. + + + + + + + + Exit status + + On success 0 is returned, a non-zero failure + code otherwise. + + + + Examples + + + Invoke a program + + This calls /bin/ls + with STDOUT/STDERR connected to the + journal: + + # systemd-cat ls + + + + Usage in a shell pipeline + + This builds a shell pipeline also + invoking /bin/ls and + writes the output it generates to the + journal: + + # ls | systemd-cat + + + 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. + + + + See Also + + systemd1, + systemctl1, + logger1 + + + + diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml index 59d6b2fd87..c5ffafe895 100644 --- a/man/systemd-notify.xml +++ b/man/systemd-notify.xml @@ -94,6 +94,13 @@ text and exits. + + + + Prints a short version + string and exits. + + -- cgit v1.2.3-54-g00ecf