author | Michael Nestler <Michael.Nestler@Oracle.COM> |
Wed, 15 Oct 2014 09:26:27 -0700 | |
branch | s11-update |
changeset 3394 | 9758aff98adb |
parent 847 | 4ae04177ffa1 |
permissions | -rw-r--r-- |
3394
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
1 |
# Solaris-specific patch. Not going upstream. |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
2 |
# Covers Solaris-specific configuration and makes it compatible with nroff. |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
3 |
--- rsyslog/tools/rsyslogd.8 2011-04-18 06:36:33.000000000 -0700 |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
4 |
+++ rsyslog/tools/rsyslogd.8 2014-10-14 09:41:01.559928606 -0700 |
847 | 5 |
@@ -1,7 +1,8 @@ |
6 |
+'\" te |
|
7 |
.\" Copyright 2004-2008 Rainer Gerhards and Adiscon for the rsyslog modifications |
|
8 |
.\" May be distributed under the GNU General Public License |
|
9 |
.\" |
|
10 |
-.TH RSYSLOGD 8 "29 July 2008" "Version 3.21.1" "Linux System Administration" |
|
11 |
+.TH RSYSLOGD 1M "16 May 2012" "Version 6.2.0" "System Administration Commands" |
|
12 |
.SH NAME |
|
13 |
rsyslogd \- reliable and extended syslogd |
|
14 |
.SH SYNOPSIS |
|
3394
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
15 |
@@ -44,17 +45,16 @@ |
847 | 16 |
unix domain sockets enables this utility to support both local |
17 |
and remote logging. |
|
18 |
||
19 |
-.B Note that this version of rsyslog ships with extensive documentation in html format. |
|
20 |
-This is provided in the ./doc subdirectory and probably |
|
21 |
-in a separate package if you installed rsyslog via a packaging system. |
|
3394
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
22 |
+.B "Note that this version of rsyslog ships with extensive documentation in html format." |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
23 |
+This is provided in the /usr/share/doc/rsyslog directory. |
847 | 24 |
To use rsyslog's advanced features, you |
25 |
.B need |
|
3394
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
26 |
to look at the html documentation, because the man pages only cover |
847 | 27 |
basic aspects of operation. |
28 |
-.B For details and configuration examples, see the rsyslog.conf (5) |
|
3394
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
29 |
-.B man page and the online documentation at http://www.rsyslog.com/doc |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
30 |
+.B "For details and configuration examples, see the rsyslog.conf (4)" |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
31 |
+.B "man page and the online documentation at http://www.rsyslog.com/doc" |
847 | 32 |
|
33 |
-.BR Rsyslogd (8) |
|
34 |
+.BR rsyslogd (1M) |
|
35 |
is derived from the sysklogd package which in turn is derived from the |
|
36 |
stock BSD sources. |
|
37 |
||
3394
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
38 |
@@ -93,9 +93,9 @@ |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
39 |
|
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
40 |
.LP |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
41 |
.SH OPTIONS |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
42 |
-.B Note that in version 3 of rsyslog a number of command line options |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
43 |
-.B have been deprecated and replaced with config file directives. The |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
44 |
-.B -c option controls the backward compatibility mode in use. |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
45 |
+.B "Note that in version 3 of rsyslog a number of command line options" |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
46 |
+.B "have been deprecated and replaced with config file directives. The" |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
47 |
+.B "-c option controls the backward compatibility mode in use." |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
48 |
.TP |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
49 |
.BI "\-A" |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
50 |
When sending UDP messages, there are potentially multiple paths to |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
51 |
@@ -132,8 +132,8 @@ |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
52 |
is the rsyslog version that it shall be |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
53 |
compatible with. Using -c0 tells rsyslog to be command-line compatible |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
54 |
to sysklogd, which is the default if -c is not given. |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
55 |
-.B Please note that rsyslogd issues warning messages if the -c3 |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
56 |
-.B command line option is not given. |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
57 |
+.B "Please note that rsyslogd issues warning messages if the -c3" |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
58 |
+.B "command line option is not given." |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
59 |
This is to alert you that your are running in compatibility |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
60 |
mode. Compatibility mode interferes with your rsyslog.conf commands and |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
61 |
may cause some undesired side-effects. It is meant to be used with a |
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
62 |
@@ -170,7 +170,8 @@ |
847 | 63 |
Avoid auto-backgrounding. This is needed especially if the |
64 |
.B rsyslogd |
|
65 |
is started and controlled by |
|
66 |
-.BR init (8). |
|
67 |
+.BR init (1M), |
|
68 |
+which is not the case on Solaris. |
|
69 |
.TP |
|
70 |
.B "\-N " "level" |
|
71 |
Do a coNfig check. Do NOT run in regular mode, just check configuration |
|
3394
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
72 |
@@ -181,9 +182,6 @@ |
847 | 73 |
not specifying the -N option at all (so this makes limited sense) and |
74 |
1 actually activates the code. Later, higher levels will mean more |
|
75 |
verbosity (this is a forward-compatibility option). |
|
76 |
-.B rsyslogd |
|
77 |
-is started and controlled by |
|
78 |
-.BR init (8). |
|
79 |
.TP |
|
80 |
.BI "\-q " "add hostname if DNS fails during ACL processing" |
|
81 |
During ACL processing, hostnames are resolved to IP addresses for |
|
3394
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
82 |
@@ -257,7 +255,7 @@ |
847 | 83 |
operation and should only be done when actually necessary. Actually, it is |
84 |
a rsyslgod stop immediately followed by a restart. Future versions will remove |
|
85 |
this restart functionality of HUP (it will go away in v5). So it is advised to use |
|
86 |
-HUP only for closing files, and a "real restart" (e.g. /etc/rc.d/rsyslogd restart) |
|
87 |
+HUP only for closing files, and a "real restart" (e.g. svcadm restart svc:/system/system-log:rsyslog) |
|
88 |
to activate configuration changes. |
|
89 |
.TP |
|
90 |
.B TERM ", " INT ", " QUIT |
|
3394
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
91 |
@@ -330,12 +328,10 @@ |
847 | 92 |
The file containing the process id of |
93 |
.BR rsyslogd . |
|
94 |
.TP |
|
95 |
-.I prefix/lib/rsyslog |
|
96 |
+.I /usr/lib/rsyslog |
|
97 |
Default directory for |
|
98 |
.B rsyslogd |
|
99 |
-modules. The |
|
100 |
-.I prefix |
|
101 |
-is specified during compilation (e.g. /usr/local). |
|
102 |
+modules. |
|
103 |
.SH ENVIRONMENT |
|
104 |
.TP |
|
105 |
.B RSYSLOG_DEBUG |
|
3394
9758aff98adb
19789649 rsyslog complete documentation is missing
Michael Nestler <Michael.Nestler@Oracle.COM>
parents:
847
diff
changeset
|
106 |
@@ -378,20 +374,42 @@ |
847 | 107 |
.B RSYSLOG_MODDIR |
108 |
Provides the default directory in which loadable modules reside. |
|
109 |
.PD |
|
110 |
-.SH BUGS |
|
111 |
-Please review the file BUGS for up-to-date information on known |
|
112 |
-bugs and annoyances. |
|
113 |
.SH Further Information |
|
114 |
Please visit |
|
115 |
.BR http://www.rsyslog.com/doc |
|
116 |
for additional information, tutorials and a support forum. |
|
117 |
+.SH ATTRIBUTES |
|
118 |
+.sp |
|
119 |
+.LP |
|
120 |
+See \fBattributes\fR(5) for descriptions of the following attributes: |
|
121 |
+.sp |
|
122 |
+ |
|
123 |
+.sp |
|
124 |
+.TS |
|
125 |
+tab() box; |
|
126 |
+cw(2.75i) |cw(2.75i) |
|
127 |
+lw(2.75i) |lw(2.75i) |
|
128 |
+. |
|
129 |
+ATTRIBUTE TYPEATTRIBUTE VALUE |
|
130 |
+_ |
|
131 |
+Availabilitypkg:/system/rsyslog |
|
132 |
+_ |
|
133 |
+Servicesvc:/system/system-log:rsyslog |
|
134 |
+.TE |
|
135 |
+ |
|
136 |
+.SH Solaris Usage |
|
137 |
+The rsyslog instance of the system-log service is not enabled by default. |
|
138 |
+To enable it, first "svcadm disable svc:/system/system-log:default", then |
|
139 |
+"svcadm enable svc:/system/system-log:rsyslog". If you wish to enable log |
|
140 |
+rotation, then add each file referenced in |
|
141 |
+.BR rsyslog.conf(4) |
|
142 |
+to /etc/logadm.conf. |
|
143 |
.SH SEE ALSO |
|
144 |
-.BR rsyslog.conf (5), |
|
145 |
+.BR rsyslog.conf (4), |
|
146 |
.BR logger (1), |
|
147 |
-.BR syslog (2), |
|
148 |
-.BR syslog (3), |
|
149 |
-.BR services (5), |
|
150 |
-.BR savelog (8) |
|
151 |
+.BR syslog (3C), |
|
152 |
+.BR services (4) |
|
153 |
+.BR logadm.conf (4) |
|
154 |
.LP |
|
155 |
.SH COLLABORATORS |
|
156 |
.B rsyslogd |