svn commit: r44345 - head/en_US.ISO8859-1/books/handbook/config
Dru Lavigne
dru at FreeBSD.org
Mon Mar 24 20:55:37 UTC 2014
Author: dru
Date: Mon Mar 24 20:55:36 2014
New Revision: 44345
URL: http://svnweb.freebsd.org/changeset/doc/44345
Log:
Finish editorial review of logging chapter.
Sponsored by: iXsystems
Modified:
head/en_US.ISO8859-1/books/handbook/config/chapter.xml
Modified: head/en_US.ISO8859-1/books/handbook/config/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/handbook/config/chapter.xml Mon Mar 24 16:53:46 2014 (r44344)
+++ head/en_US.ISO8859-1/books/handbook/config/chapter.xml Mon Mar 24 20:55:36 2014 (r44345)
@@ -1345,8 +1345,8 @@ cron.*
</listitem>
<listitem>
- <para>Line 33 is an example usage of a <emphasis>program
- specification</emphasis>. This makes the rules
+ <para>Line 33 is an example usage of a program
+ specification. This makes the rules
following it only valid for the specified program.
In this case, only the
messages generated by <application>ppp</application> are
@@ -1395,24 +1395,24 @@ cron.*
<indexterm><primary>log rotation</primary></indexterm>
<indexterm><primary>log management</primary></indexterm>
- <para>Log files tend to grow quickly and accumulate steadily.
- This leads to the files being full of less immediately useful
- information while filling up the hard drive. Log management
- attempts to mitigate this. In &os;, &man.newsyslog.8; is used
- to manage log files. This program periodically rotates and
+ <para>Log files can grow quickly, taking up disk space and
+ making it more difficult to locate useful
+ information. Log management
+ attempts to mitigate this. In &os;, <application>newsyslog</application> is used
+ to manage log files. This built-in program periodically rotates and
compresses log files, and optionally creates missing log files
and signals programs when log files are moved. The log files
- are not necessarily generated by &man.syslogd.8; as
- &man.newsyslog.8; works with any logs written from any
- program. While &man.newsyslog.8; is normally run from
+ may be generated by <application>syslogd</application> or
+ by any other program which generates log files.
+ While <application>syslogd</application> is normally run from
&man.cron.8;, it is not a system daemon. In the default
- configuration, it is run every hour.</para>
+ configuration, it runs every hour.</para>
- <para>To know which actions to take, &man.newsyslog.8; reads
- its configuration file, by default
+ <para>To know which actions to take, <application>newsyslog</application> reads
+ its configuration file,
<filename>/etc/newsyslog.conf</filename>. This
- configuration file contains one line for each file that
- &man.newsyslog.8; manages. Each line states the file
+ file contains one line for each log file that
+ <application>newsyslog</application> manages. Each line states the file
owner, permissions, when to rotate that file, optional flags
that affect log rotation, such as compression, and programs
to signal when the log is rotated. Here is the default
@@ -1451,36 +1451,39 @@ cron.*
/var/log/monthly.log 640 12 * $M1D0 JN
/var/log/pflog 600 3 100 * JB /var/run/pflogd.pid
/var/log/ppp.log root:network 640 3 100 * JC
+/var/log/devd.log 644 3 100 * JC
/var/log/security 600 10 100 * JC
/var/log/sendmail.st 640 10 * 168 B
/var/log/utx.log 644 3 * @01T05 B
/var/log/weekly.log 640 5 1 $W6D0 JN
/var/log/xferlog 600 7 100 * JC</programlisting>
- <para>Each line starts with the name of the file to be
+ <para>Each line starts with the name of the log to be
rotated, optionally followed by an owner and group for both
rotated and newly created files. The
<literal>mode</literal> field sets the permissions on the
log file and <literal>count</literal> denotes how many
rotated log files should be kept. The
<literal>size</literal> and <literal>when</literal> fields
- tell &man.newsyslog.8; when to rotate the file. A log
+ tell <application>newsyslog</application> when to rotate the file. A log
file is rotated when either its size is larger than the
- <literal>size</literal> field, or when the time in the
+ <literal>size</literal> field or when the time in the
<literal>when</literal> filed has passed.
- <literal>*</literal> means that this field is ignored. The
+ An asterisk (<literal>*</literal>) means that this field is ignored. The
<replaceable>flags</replaceable> field gives
- &man.newsyslog.8; further instructions, such as how to
+ further instructions, such as how to
compress the rotated file or to create the log file if it
- is missing. The last two fields are optional, and
- specify the
- <acronym role="Process Identifier">PID</acronym> file of a
+ is missing. The last two fields are optional and
+ specify the name of the Process ID
+ (<acronym>PID</acronym>) file of a
process and a signal number to send to that process when the
- file is rotated. For more information on all fields, valid
+ file is rotated.</para>
+
+ <para>For more information on all fields, valid
flags, and how to specify the rotation time, refer to
- &man.newsyslog.conf.5;. Since &man.newsyslog.8; is run from
+ &man.newsyslog.conf.5;. Since <application>newsyslog</application> is run from
&man.cron.8;, it can not rotate files more often than it is
- run from &man.cron.8;.</para>
+ scheduled to run from &man.cron.8;.</para>
</sect2>
<sect2 xml:id="network-syslogd">
@@ -1503,9 +1506,9 @@ cron.*
increases. Configuring centralized logging can reduce some of
the administrative burden of log file administration.</para>
- <para>Centralized log file aggregation, merging, and rotation can
- be configured using &os; native tools, such as &man.syslogd.8;
- and &man.newsyslog.8;. This section demonstrates an example
+ <para>In &os;, centralized log file aggregation, merging, and rotation can
+ be configured using <application>syslogd</application>
+ and<application>newsyslog</application>. This section demonstrates an example
configuration, where host <systemitem>A</systemitem>, named
<systemitem
class="fqdomainname">logserv.example.com</systemitem>, will
@@ -1722,7 +1725,7 @@ Logging to FILE /var/log/messages</scree
encrypted during use or after log rotation. Local users may
access log files to gain additional insight into system
configuration. Setting proper permissions on log files is
- critical. The built-in log rotator, &man.newsyslog.8;,
+ critical. The built-in log rotator, <application>newsyslog</application>,
supports setting permissions on newly created and rotated log
files. Setting log files to mode <literal>600</literal>
should prevent unwanted access by local users. Refer to
More information about the svn-doc-all
mailing list