systemd-cat(1) — Chainguard OS Manuals

SYSTEMD-CAT(1)

systemd-cat

SYSTEMD-CAT(1)

.SH "NAME" systemd-cat - Connect a pipeline or program's output with the journal

.SH "SYNOPSIS"

.HP 288u

systemd-cat [OPTIONS...] [COMMAND] [ARGUMENTS...]

.HP 288u

systemd-cat [OPTIONS...]

.SH "DESCRIPTION"

.PP systemd-cat may be used to connect the standard output and error output of a command to the journal, or as a filter tool in a shell pipeline to pass the output the previous pipeline element generates to the journal.

.PP If no parameter is passed, systemd-cat will write everything it reads from standard input (stdin) to the journal.

.PP 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.

.SH "OPTIONS"

.PP The following options are understood:

.PP -h, --help

Print a short help text and exit.

.RE
.PP --version

Print a short version string and exit.

.RE

.PP -t, --identifier=

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 cat if the input is read from a pipe) will be used to describe the log source instead.

.RE

.PP -p, --priority=

Specify the default priority level for the logged messages. Pass one of emerg, alert, crit, err, warning, notice, info, debug, or a value between 0 and 7 (corresponding to the same named levels). These priority values are the same as defined by syslog(3). 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 --level-prefix= below.

.RE

.PP --stderr-priority=

Specifies the default priority level for messages from the process's standard error output (stderr). Usage of this option is the same as the --priority= option, above, and both can be used at once. When both are used, --priority= will specify the default priority for standard output (stdout).

If --stderr-priority= is not specified, messages from stderr will still be logged, with the same default priority level as stdout.

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.

Added in version 241.

.RE

.PP --level-prefix=

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 similarly for the other priority levels. Takes a boolean argument.

.RE

.PP --namespace=

Specifies the journal namespace to which the standard IO should be connected. For details about journal namespaces, see systemd-journald.service(8).

Added in version 256.

.RE

.SH "EXIT STATUS"

.PP On success, 0 is returned, a non-zero failure code otherwise.

.SH "EXAMPLES"

.PP Example 1. Invoke a program

.PP This calls /bin/ls with standard output and error connected to the journal:

# systemd-cat ls

.PP Example 2. Usage in a shell pipeline

.PP This builds a shell pipeline also invoking /bin/ls and writes the output it generates to the journal:

# ls | systemd-cat

.PP 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.

systemd 262.2