aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/logger.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/logger.xml')
-rw-r--r--doc/src/logger.xml103
1 files changed, 103 insertions, 0 deletions
diff --git a/doc/src/logger.xml b/doc/src/logger.xml
new file mode 100644
index 0000000..af7d735
--- /dev/null
+++ b/doc/src/logger.xml
@@ -0,0 +1,103 @@
+<refentry>
+
+ <refentryinfo>
+ <title>logger</title>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>logger</refentrytitle>
+ <manvolnum>1</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>logger</refname>
+ <refpurpose>a shell command interface to the syslog daemon</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>logger</command>
+<group choice="opt"><arg>-f</arg><replaceable>file</replaceable></group>
+<arg choice="opt">-i</arg>
+<group choice="opt"><arg>-p</arg><replaceable>pri</replaceable></group>
+<arg choice="opt">-s</arg>
+<group choice="opt"><arg>-t</arg><replaceable>tag</replaceable></group>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+<command>Logger</command> makes entries in the system log.
+It provides a shell command interface to the syslog daemon.
+ </para>
+ </refsect1>
+
+ <refsect1>
+ <title>Options</title>
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+<option>-f</option><replaceable>file</replaceable>
+ </term>
+ <listitem>
+ <para>
+Log the specified file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+<option>-i</option>
+ </term>
+ <listitem>
+ <para>
+Log the process id of the logger process with each line.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+<option>-p</option><replaceable>pri</replaceable>
+ </term>
+ <listitem>
+ <para>
+Enter the message with the specified priority.
+The priority may be specified numerically or as a
+<quote>facility.level</quote> pair.
+For example, <option>-p local3.info</option> logs the message(s)
+as informational level in the local3 facility.
+The default is <quote>user.notice</quote>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+<option>-t</option><replaceable>tag</replaceable>
+ </term>
+ <listitem>
+ <para>
+Mark every line in the log with the specified tag.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ <para>
+The logger utility exits 0 on success, and >0 if an error occurs.
+ </para>
+ <para>
+Valid facility names are: auth, authpriv (for security information of
+a sensitive nature), cron, daemon, ftp, kern, lpr, mail, news, security
+(deprecated synonym for auth), syslog, user, uucp, and local0 to local7,
+inclusive.
+ </para>
+ <para>
+Valid level names are: alert, crit, debug, emerg, err, error (deprecated
+synonym for err), info, notice, panic (deprecated synonym for emerg),
+warning, warn (deprecated synonym for warning).
+ </para>
+ </refsect1>
+
+</refentry>