From a3dc138e7515924ece2b20419825f4ad327451a5 Mon Sep 17 00:00:00 2001 From: Hiroki Sato Date: Fri, 23 Dec 2016 04:59:22 +0000 Subject: [PATCH] mdoc and style fixes. --- usr.sbin/syslogd/syslogd.8 | 129 +++++++++++++++++++++++-------------- 1 file changed, 82 insertions(+), 47 deletions(-) diff --git a/usr.sbin/syslogd/syslogd.8 b/usr.sbin/syslogd/syslogd.8 index 4508f7b82481..c3f8f00efc15 100644 --- a/usr.sbin/syslogd/syslogd.8 +++ b/usr.sbin/syslogd/syslogd.8 @@ -40,7 +40,7 @@ .Op Fl a Ar allowed_peer .Op Fl b Ar bind_address .Op Fl f Ar config_file -.Op Fl l Oo Ar mode \&: Oc Ns Ar path +.Op Fl l Oo Ar mode Ns \&: Oc Ns Ar path .Op Fl m Ar mark_interval .Op Fl P Ar pid_file .Op Fl p Ar log_socket @@ -48,7 +48,9 @@ .Sh DESCRIPTION The .Nm -utility reads and logs messages to the system console, log files, other +utility reads and logs messages to the system console, +log files, +other machines and/or users as specified by its configuration file. .Pp The options are as follows: @@ -64,7 +66,8 @@ to use IPv6 addresses only. .It Fl 8 Tells .Nm -not to interfere with 8-bit data. Normally +not to interfere with 8-bit data. +Normally .Nm will replace C1 control characters .Pq ISO 8859 and Unicode characters @@ -137,11 +140,13 @@ is IPv4 address, a missing .Ar masklen will be substituted by the historic class A or class B netmasks if .Ar ipaddr -belongs into the address range of class A or B, respectively, or -by 24 otherwise. +belongs into the address range of class A or B, +respectively, +or by 24 otherwise. If .Ar ipaddr -is IPv6 address, a missing +is IPv6 address, +a missing .Ar masklen will be substituted by 128. .It Xo @@ -191,29 +196,31 @@ is This option can be specified multiple times to bind to multiple addresses and/or ports. .It Fl C -Create log files that do not exist (permission is set to -.Li 0600 ) . +Create log files that do not exist +.Pq permission is set to Ql Li 0600 . .It Fl c Disable the compression of repeated instances of the same line into a single line of the form .Dq Li "last message repeated N times" when the output is a pipe to another program. -If specified twice, disable this compression in all cases. +If specified twice, +disable this compression in all cases. .It Fl d Put .Nm into debugging mode. This is probably only of use to developers working on .Nm . -.It Fl f +.It Fl f Ar config_file Specify the pathname of an alternate configuration file; the default is .Pa /etc/syslog.conf . .It Fl F Run .Nm -in the foreground, rather than going into daemon mode. This is useful if -some other process uses +in the foreground, +rather than going into daemon mode. +This is useful if some other process uses .Xr fork 2 and .Xr exec 3 @@ -230,52 +237,75 @@ Usually the .Dq kern facility is reserved for messages read directly from .Pa /dev/klog . -.It Fl m +.It Fl m Ar mark_interval Select the number of minutes between .Dq mark -messages; the default is 20 minutes. +messages; +the default is 20 minutes. .It Fl N -Disable binding on UDP sockets. RFC 3164 recommends that outgoing -syslogd messages should originate from the privileged port, this -option +Disable binding on UDP sockets. +RFC 3164 recommends that outgoing +.Nm +messages should originate from the privileged port, +this option .Em disables -the recommended behavior. This option inherits +the recommended behavior. +This option inherits .Fl s . .It Fl n -Disable dns query for every request. +Disable DNS query for every request. .It Fl o Prefix kernel messages with the full kernel boot file as determined by .Xr getbootfile 3 . Without this, the kernel message prefix is always .Dq Li kernel: . -.It Fl p +.It Fl p Ar log_socket Specify the pathname of an alternate log socket to be used instead; the default is .Pa /var/run/log . -.It Fl P +When a single +.Fl p +options are specified, +the default pathname is replaced with the specified one. +When two or more +.Fl p +options are specified, +the remaining pathnames are treated as additional log sockets. +.It Fl P Ar pid_file Specify an alternative file in which to store the process ID. The default is .Pa /var/run/syslog.pid . -.It Fl S +.It Fl S Ar logpriv_socket Specify the pathname of an alternate log socket for privileged -applications to be used instead; the default is +applications to be used instead; +the default is .Pa /var/run/logpriv . -.It Fl l +When a single +.Fl S +options are specified, +the default pathname is replaced with the specified one. +When two or more +.Fl S +options are specified, +the remaining pathnames are treated as additional log sockets. +.It Fl l Oo Ar mode Ns \&: Oc Ns Ar path Specify a location where .Nm should place an additional log socket. The primary use for this is to place additional log sockets in .Pa /var/run/log of various chroot filespaces. -File permissions for socket can be specified in octal representation -before socket name, delimited with a colon. -Path to socket location must be absolute. +File permissions for socket can be specified in octal representation in +.Ar mode , +delimited with a colon. +The socket location must be specified as an absolute pathname in +.Ar path . .It Fl s Operate in secure mode. Do not log messages from remote machines. -If -specified twice, no network socket will be opened at all, which also -disables logging to remote machines. +If specified twice, +no network socket will be opened at all, +which also disables logging to remote machines. .It Fl T Always use the local time and date for messages received from the network, instead of the timestamp field supplied in the message by the remote host. @@ -284,14 +314,16 @@ or are unable to generate a correct timestamp. .It Fl u Unique priority logging. Only log messages at the specified priority. -Without this option, messages at the stated priority or higher are logged. +Without this option, +messages at the stated priority or higher are logged. This option changes the default comparison from .Dq => to .Dq = . .It Fl v Verbose logging. -If specified once, the numeric facility and priority are +If specified once, +the numeric facility and priority are logged with each locally-written message. If specified more than once, the names of the facility and priority are logged with each locally-written @@ -318,7 +350,7 @@ from an Internet domain socket specified in .Pa /etc/services , and from the special device .Pa /dev/klog -(to read kernel messages). +.Pq to read kernel messages . .Pp The .Nm @@ -333,8 +365,10 @@ This can be used to kill or reconfigure The message sent to .Nm should consist of a single line. -The message can contain a priority code, which should be a preceding -decimal number in angle braces, for example, +The message can contain a priority code, +which should be a preceding +decimal number in angle braces, +for example, .Sq Aq 5 . This priority code should map into the priorities defined in the include file @@ -342,9 +376,10 @@ include file .Pp For security reasons, .Nm -will not append to log files that do not exist (unless -.Fl C -option is specified); +will not append to log files that do not exist +.Po unless Fl C +option is specified +.Pc ; therefore, they must be created manually before running .Nm . .Pp @@ -393,23 +428,23 @@ options are extensions. .Sh BUGS The ability to log messages received in UDP packets is equivalent to -an unauthenticated remote disk-filling service, and should probably be -disabled by default. +an unauthenticated remote disk-filling service, +and should probably be disabled by default. Some sort of .No inter- Ns Nm syslogd authentication mechanism ought to be worked out. -To prevent the worst -abuse, use of the +To prevent the worst abuse, +use of the .Fl a option is therefore highly recommended. .Pp The .Fl a -matching algorithm does not pretend to be very efficient; use of numeric -IP addresses is faster than domain name comparison. -Since the allowed -peer list is being walked linearly, peer groups where frequent messages -are being anticipated from should be put early into the +matching algorithm does not pretend to be very efficient; +use of numeric IP addresses is faster than domain name comparison. +Since the allowed peer list is being walked linearly, +peer groups where frequent messages are being anticipated +from should be put early into the .Fl a list. .Pp