Changeset 411 for branches/samba-3.3.x/docs/manpages/eventlogadm.8
- Timestamp:
- Mar 1, 2010, 3:05:48 PM (15 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
branches/samba-3.3.x/docs/manpages/eventlogadm.8
r368 r411 1 '\" t2 1 .\" Title: eventlogadm 3 2 .\" Author: [see the "AUTHOR" section] 4 .\" Generator: DocBook XSL Stylesheets v1.7 5.2<http://docbook.sf.net/>5 .\" Date: 0 1/14/20103 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/> 4 .\" Date: 02/22/2010 6 5 .\" Manual: System Administration tools 7 6 .\" Source: Samba 3.3 8 7 .\" Language: English 9 8 .\" 10 .TH "EVENTLOGADM" "8" "01/14/2010" "Samba 3\&.3" "System Administration tools" 9 .TH "EVENTLOGADM" "8" "02/22/2010" "Samba 3\&.3" "System Administration tools" 10 .\" ----------------------------------------------------------------- 11 .\" * (re)Define some macros 12 .\" ----------------------------------------------------------------- 13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 14 .\" toupper - uppercase a string (locale-aware) 15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 16 .de toupper 17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ 18 \\$* 19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz 20 .. 21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 22 .\" SH-xref - format a cross-reference to an SH section 23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 24 .de SH-xref 25 .ie n \{\ 26 .\} 27 .toupper \\$* 28 .el \{\ 29 \\$* 30 .\} 31 .. 32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 33 .\" SH - level-one heading that works better for non-TTY output 34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 35 .de1 SH 36 .\" put an extra blank line of space above the head in non-TTY output 37 .if t \{\ 38 .sp 1 39 .\} 40 .sp \\n[PD]u 41 .nr an-level 1 42 .set-an-margin 43 .nr an-prevailing-indent \\n[IN] 44 .fi 45 .in \\n[an-margin]u 46 .ti 0 47 .HTML-TAG ".NH \\n[an-level]" 48 .it 1 an-trap 49 .nr an-no-space-flag 1 50 .nr an-break-flag 1 51 \." make the size of the head bigger 52 .ps +3 53 .ft B 54 .ne (2v + 1u) 55 .ie n \{\ 56 .\" if n (TTY output), use uppercase 57 .toupper \\$* 58 .\} 59 .el \{\ 60 .nr an-break-flag 0 61 .\" if not n (not TTY), use normal case (not uppercase) 62 \\$1 63 .in \\n[an-margin]u 64 .ti 0 65 .\" if not n (not TTY), put a border/line under subheading 66 .sp -.6 67 \l'\n(.lu' 68 .\} 69 .. 70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 71 .\" SS - level-two heading that works better for non-TTY output 72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 73 .de1 SS 74 .sp \\n[PD]u 75 .nr an-level 1 76 .set-an-margin 77 .nr an-prevailing-indent \\n[IN] 78 .fi 79 .in \\n[IN]u 80 .ti \\n[SN]u 81 .it 1 an-trap 82 .nr an-no-space-flag 1 83 .nr an-break-flag 1 84 .ps \\n[PS-SS]u 85 \." make the size of the head bigger 86 .ps +2 87 .ft B 88 .ne (2v + 1u) 89 .if \\n[.$] \&\\$* 90 .. 91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 92 .\" BB/BE - put background/screen (filled box) around block of text 93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 94 .de BB 95 .if t \{\ 96 .sp -.5 97 .br 98 .in +2n 99 .ll -2n 100 .gcolor red 101 .di BX 102 .\} 103 .. 104 .de EB 105 .if t \{\ 106 .if "\\$2"adjust-for-leading-newline" \{\ 107 .sp -1 108 .\} 109 .br 110 .di 111 .in 112 .ll 113 .gcolor 114 .nr BW \\n(.lu-\\n(.i 115 .nr BH \\n(dn+.5v 116 .ne \\n(BHu+.5v 117 .ie "\\$2"adjust-for-leading-newline" \{\ 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] 119 .\} 120 .el \{\ 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[] 122 .\} 123 .in 0 124 .sp -.5v 125 .nf 126 .BX 127 .in 128 .sp .5v 129 .fi 130 .\} 131 .. 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 133 .\" BM/EM - put colored marker in margin next to block of text 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 135 .de BM 136 .if t \{\ 137 .br 138 .ll -2n 139 .gcolor red 140 .di BX 141 .\} 142 .. 143 .de EM 144 .if t \{\ 145 .br 146 .di 147 .ll 148 .gcolor 149 .nr BH \\n(dn 150 .ne \\n(BHu 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[] 152 .in 0 153 .nf 154 .BX 155 .in 156 .fi 157 .\} 158 .. 11 159 .\" ----------------------------------------------------------------- 12 160 .\" * set default formatting … … 19 167 .\" * MAIN CONTENT STARTS HERE * 20 168 .\" ----------------------------------------------------------------- 21 .SH "N AME"169 .SH "Name" 22 170 eventlogadm \- push records into the Samba event log store 23 .SH "SYNOPSIS" 171 .SH "Synopsis" 172 .fam C 24 173 .HP \w'\ 'u 25 eventlogadm [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ addsource\ \fIEVENTLOG\fR\ \fISOURCENAME\fR\ \fIMSGFILE\fR 174 \FCeventlogadm\F[] [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ \FCaddsource\F[]\ \fIEVENTLOG\fR\ \fISOURCENAME\fR\ \fIMSGFILE\fR 175 .fam 176 .fam C 26 177 .HP \w'\ 'u 27 eventlogadm [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ write\ \fIEVENTLOG\fR 178 \FCeventlogadm\F[] [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ \FCwrite\F[]\ \fIEVENTLOG\fR 179 .fam 28 180 .SH "DESCRIPTION" 29 181 .PP … … 32 184 suite\&. 33 185 .PP 34 eventlogadm 186 \FCeventlogadm\F[] 35 187 is a filter that accepts formatted event log records on standard input and writes them to the Samba event log store\&. Windows client can then manipulate these record using the usual administration tools\&. 36 188 .SH "OPTIONS" … … 39 191 .RS 4 40 192 The 41 \ -d193 \FC\-d\F[] 42 194 option causes 43 eventlogadm 195 \FCeventlogadm\F[] 44 196 to emit debugging information\&. 45 197 .RE 46 198 .PP 47 \fB\-o\fR addsource\fIEVENTLOG\fR \fISOURCENAME\fR \fIMSGFILE\fR199 \fB\-o\fR \FCaddsource\F[] \fIEVENTLOG\fR \fISOURCENAME\fR \fIMSGFILE\fR 48 200 .RS 4 49 201 The 50 \ -o addsource202 \FC\-o addsource\F[] 51 203 option creates a new event log source\&. 52 204 .RE 53 205 .PP 54 \fB\-o\fR write\fIEVENTLOG\fR206 \fB\-o\fR \FCwrite\F[] \fIEVENTLOG\fR 55 207 .RS 4 56 208 The 57 \ -o write209 \FC\-o write\F[] 58 210 reads event log records from standard input and writes them to the Samba event log store named by EVENTLOG\&. 59 211 .RE … … 66 218 .PP 67 219 For the write operation, 68 eventlogadm 220 \FCeventlogadm\F[] 69 221 expects to be able to read structured records from standard input\&. These records are a sequence of lines, with the record key and data separated by a colon character\&. Records are separated by at least one or more blank line\&. 70 222 .PP … … 80 232 .\} 81 233 82 LEN 234 \FCLEN\F[] 83 235 \- This field should be 0, since 84 eventlogadm 236 \FCeventlogadm\F[] 85 237 will calculate this value\&. 86 238 .RE … … 95 247 .\} 96 248 97 RS1 249 \FCRS1\F[] 98 250 \- This must be the value 1699505740\&. 99 251 .RE … … 108 260 .\} 109 261 110 RCN 262 \FCRCN\F[] 111 263 \- This field should be 0\&. 112 264 .RE … … 121 273 .\} 122 274 123 TMG 275 \FCTMG\F[] 124 276 \- The time the eventlog record was generated; format is the number of seconds since 00:00:00 January 1, 1970, UTC\&. 125 277 .RE … … 134 286 .\} 135 287 136 TMW 288 \FCTMW\F[] 137 289 \- The time the eventlog record was written; format is the number of seconds since 00:00:00 January 1, 1970, UTC\&. 138 290 .RE … … 147 299 .\} 148 300 149 EID 301 \FCEID\F[] 150 302 \- The eventlog ID\&. 151 303 .RE … … 160 312 .\} 161 313 162 ETP 314 \FCETP\F[] 163 315 \- The event type \-\- one of "INFO", "ERROR", "WARNING", "AUDIT SUCCESS" or "AUDIT FAILURE"\&. 164 316 .RE … … 173 325 .\} 174 326 175 ECT 327 \FCECT\F[] 176 328 \- The event category; this depends on the message file\&. It is primarily used as a means of filtering in the eventlog viewer\&. 177 329 .RE … … 186 338 .\} 187 339 188 RS2 340 \FCRS2\F[] 189 341 \- This field should be 0\&. 190 342 .RE … … 199 351 .\} 200 352 201 CRN 353 \FCCRN\F[] 202 354 \- This field should be 0\&. 203 355 .RE … … 212 364 .\} 213 365 214 USL 366 \FCUSL\F[] 215 367 \- This field should be 0\&. 216 368 .RE … … 225 377 .\} 226 378 227 SRC 379 \FCSRC\F[] 228 380 \- This field contains the source name associated with the event log\&. If a message file is used with an event log, there will be a registry entry for associating this source name with a message file DLL\&. 229 381 .RE … … 238 390 .\} 239 391 240 SRN 392 \FCSRN\F[] 241 393 \- The name of the machine on which the eventlog was generated\&. This is typically the host name\&. 242 394 .RE … … 251 403 .\} 252 404 253 STR 405 \FCSTR\F[] 254 406 \- The text associated with the eventlog\&. There may be more than one string in a record\&. 255 407 .RE … … 264 416 .\} 265 417 266 DAT 418 \FCDAT\F[] 267 419 \- This field should be left unset\&. 268 420 .SH "EXAMPLES" 269 421 .PP 270 422 An example of the record format accepted by 271 eventlogadm:423 \FCeventlogadm\F[]: 272 424 .sp 273 425 .if n \{\ 274 426 .RS 4 275 427 .\} 428 .fam C 429 .ps -1 276 430 .nf 431 .if t \{\ 432 .sp -1 433 .\} 434 .BB lightgray adjust-for-leading-newline 435 .sp -1 436 277 437 LEN: 0 278 438 RS1: 1699505740 … … 291 451 DAT: 292 452 293 .fi 453 .EB lightgray adjust-for-leading-newline 454 .if t \{\ 455 .sp 1 456 .\} 457 .fi 458 .fam 459 .ps +1 294 460 .if n \{\ 295 461 .RE … … 301 467 .RS 4 302 468 .\} 469 .fam C 470 .ps -1 303 471 .nf 472 .if t \{\ 473 .sp -1 474 .\} 475 .BB lightgray adjust-for-leading-newline 476 .sp -1 477 304 478 eventlogadm \-o addsource Application MyApplication | \e\e 305 479 %SystemRoot%/system32/MyApplication\&.dll 306 480 307 .fi 481 .EB lightgray adjust-for-leading-newline 482 .if t \{\ 483 .sp 1 484 .\} 485 .fi 486 .fam 487 .ps +1 308 488 .if n \{\ 309 489 .RE … … 315 495 .RS 4 316 496 .\} 497 .fam C 498 .ps -1 317 499 .nf 500 .if t \{\ 501 .sp -1 502 .\} 503 .BB lightgray adjust-for-leading-newline 504 .sp -1 505 318 506 tail \-f /var/log/messages | \e\e 319 507 my_program_to_parse_into_eventlog_records | \e\e 320 508 eventlogadm SystemLogEvents 321 509 322 .fi 510 .EB lightgray adjust-for-leading-newline 511 .if t \{\ 512 .sp 1 513 .\} 514 .fi 515 .fam 516 .ps +1 323 517 .if n \{\ 324 518 .RE
Note:
See TracChangeset
for help on using the changeset viewer.