components/rsyslog/patches/tools-rsyslogd.8.patch
author John Beck <John.Beck@Oracle.COM>
Thu, 31 May 2012 17:02:32 -0700
changeset 847 4ae04177ffa1
child 2149 375b11f6f4bc
permissions -rw-r--r--
PSARC 2012/197 rsyslog 4269283 RFE for syslogd to run over tcp with message sequencing 6869456 Syslog should support RFC 5424 7169028 ipmievd depends on system-log:default instance instead of just system-log service
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
847
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     1
--- rsyslog/tools/rsyslogd.8	Mon Apr 18 06:36:33 2011
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     2
+++ rsyslog/tools/rsyslogd.8	Fri May 25 11:13:23 2012
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     3
@@ -1,7 +1,8 @@
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     4
+'\" te
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     5
 .\" Copyright 2004-2008 Rainer Gerhards and Adiscon for the rsyslog modifications
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     6
 .\" May be distributed under the GNU General Public License
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     7
 .\"
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     8
-.TH RSYSLOGD 8 "29 July 2008" "Version 3.21.1" "Linux System Administration"
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
     9
+.TH RSYSLOGD 1M "16 May 2012" "Version 6.2.0" "System Administration Commands"
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    10
 .SH NAME
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    11
 rsyslogd \- reliable and extended syslogd 
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    12
 .SH SYNOPSIS
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    13
@@ -44,17 +45,14 @@
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    14
 unix domain sockets enables this utility to support both local
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    15
 and remote logging.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    16
 
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    17
-.B Note that this version of rsyslog ships with extensive documentation in html format.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    18
-This is provided in the ./doc subdirectory and probably
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    19
-in a separate package if you installed rsyslog via a packaging system.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    20
 To use rsyslog's advanced features, you
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    21
 .B need
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    22
-to look at the html documentation, because the man pages only cover
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    23
+to look at the online documentation, because the man pages only cover
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    24
 basic aspects of operation.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    25
-.B For details and configuration examples, see the rsyslog.conf (5)
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    26
+.B For details and configuration examples, see the rsyslog.conf (4)
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    27
 .B man page and the online documentation at http://www.rsyslog.com/doc
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    28
 
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    29
-.BR Rsyslogd (8)
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    30
+.BR rsyslogd (1M)
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    31
 is derived from the sysklogd package which in turn is derived from the
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    32
 stock BSD sources.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    33
 
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    34
@@ -170,7 +168,8 @@
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    35
 Avoid auto-backgrounding.  This is needed especially if the
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    36
 .B rsyslogd
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    37
 is started and controlled by
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    38
-.BR init (8).
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    39
+.BR init (1M),
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    40
+which is not the case on Solaris.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    41
 .TP
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    42
 .B "\-N " "level"
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    43
 Do a coNfig check. Do NOT run in regular mode, just check configuration
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    44
@@ -181,9 +180,6 @@
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    45
 not specifying the -N option at all (so this makes limited sense) and
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    46
 1 actually activates the code. Later, higher levels will mean more
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    47
 verbosity (this is a forward-compatibility option).
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    48
-.B rsyslogd
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    49
-is started and controlled by
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    50
-.BR init (8).
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    51
 .TP
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    52
 .BI "\-q " "add hostname if DNS fails during ACL processing"
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    53
 During ACL processing, hostnames are resolved to IP addresses for
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    54
@@ -257,7 +253,7 @@
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    55
 operation and should only be done when actually necessary. Actually, it is
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    56
 a rsyslgod stop immediately followed by a restart. Future versions will remove
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    57
 this restart functionality of HUP (it will go away in v5). So it is advised to use
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    58
-HUP only for closing files, and a "real restart" (e.g. /etc/rc.d/rsyslogd restart)
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    59
+HUP only for closing files, and a "real restart" (e.g. svcadm restart svc:/system/system-log:rsyslog)
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    60
 to activate configuration changes.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    61
 .TP
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    62
 .B TERM ", " INT ", " QUIT
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    63
@@ -330,12 +326,10 @@
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    64
 The file containing the process id of 
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    65
 .BR rsyslogd .
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    66
 .TP
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    67
-.I prefix/lib/rsyslog
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    68
+.I /usr/lib/rsyslog
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    69
 Default directory for
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    70
 .B rsyslogd
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    71
-modules. The
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    72
-.I prefix
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    73
-is specified during compilation (e.g. /usr/local).
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    74
+modules.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    75
 .SH ENVIRONMENT
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    76
 .TP
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    77
 .B RSYSLOG_DEBUG
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    78
@@ -378,20 +372,42 @@
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    79
 .B RSYSLOG_MODDIR
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    80
 Provides the default directory in which loadable modules reside.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    81
 .PD
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    82
-.SH BUGS
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    83
-Please review the file BUGS for up-to-date information on known
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    84
-bugs and annoyances.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    85
 .SH Further Information
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    86
 Please visit
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    87
 .BR http://www.rsyslog.com/doc
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    88
 for additional information, tutorials and a support forum.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    89
+.SH ATTRIBUTES
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    90
+.sp
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    91
+.LP
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    92
+See \fBattributes\fR(5) for descriptions of the following attributes:
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    93
+.sp
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    94
+
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    95
+.sp
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    96
+.TS
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    97
+tab() box;
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    98
+cw(2.75i) |cw(2.75i) 
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
    99
+lw(2.75i) |lw(2.75i) 
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   100
+.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   101
+ATTRIBUTE TYPEATTRIBUTE VALUE
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   102
+_
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   103
+Availabilitypkg:/system/rsyslog
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   104
+_
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   105
+Servicesvc:/system/system-log:rsyslog
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   106
+.TE
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   107
+
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   108
+.SH Solaris Usage
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   109
+The rsyslog instance of the system-log service is not enabled by default.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   110
+To enable it, first "svcadm disable svc:/system/system-log:default", then
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   111
+"svcadm enable svc:/system/system-log:rsyslog".  If you wish to enable log
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   112
+rotation, then add each file referenced in
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   113
+.BR rsyslog.conf(4)
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   114
+to /etc/logadm.conf.
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   115
 .SH SEE ALSO
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   116
-.BR rsyslog.conf (5),
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   117
+.BR rsyslog.conf (4),
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   118
 .BR logger (1),
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   119
-.BR syslog (2),
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   120
-.BR syslog (3),
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   121
-.BR services (5),
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   122
-.BR savelog (8)
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   123
+.BR syslog (3C),
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   124
+.BR services (4)
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   125
+.BR logadm.conf (4)
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   126
 .LP
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   127
 .SH COLLABORATORS
4ae04177ffa1 PSARC 2012/197 rsyslog
John Beck <John.Beck@Oracle.COM>
parents:
diff changeset
   128
 .B rsyslogd