aboutsummaryrefslogblamecommitdiffstats
path: root/doc/src/logger.xml
blob: 28a610a5c857d62993bda68988ffed741bf98c56 (plain) (tree)


















                                                                                       
                                                                              
                          
                                                                             
                          
                                                                             
















                                                           
                                                        


















                                                        
                                                       













                                                                









                                                             
                                                       

























                                                                        
<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>&nbsp;file</replaceable></group>
<arg choice="opt">-i</arg>
<group choice="opt"><arg>-p</arg><replaceable>&nbsp;pri</replaceable></group>
<arg choice="opt">-s</arg>
<group choice="opt"><arg>-t</arg><replaceable>&nbsp;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>&nbsp;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>&nbsp;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>-s</option>
					</term>
					<listitem>
						<para>
Log the message to standard error, as well as the system log.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>
<option>-t</option><replaceable>&nbsp;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>