Changeset 596 for trunk/server/docs/manpages/eventlogadm.8
- Timestamp:
- Jul 2, 2011, 3:35:33 PM (14 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/server/docs/manpages/eventlogadm.8
r480 r596 1 '\" t 1 2 .\" Title: eventlogadm 2 3 .\" Author: [see the "AUTHOR" section] 3 .\" Generator: DocBook XSL Stylesheets v1.7 4.0<http://docbook.sf.net/>4 .\" Date: 0 6/18/20104 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> 5 .\" Date: 03/06/2011 5 6 .\" Manual: System Administration tools 6 7 .\" Source: Samba 3.5 7 8 .\" Language: English 8 9 .\" 9 .TH "EVENTLOGADM" "8" "06/18/2010" "Samba 3\&.5" "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 .. 10 .TH "EVENTLOGADM" "8" "03/06/2011" "Samba 3\&.5" "System Administration tools" 159 11 .\" ----------------------------------------------------------------- 160 12 .\" * set default formatting … … 167 19 .\" * MAIN CONTENT STARTS HERE * 168 20 .\" ----------------------------------------------------------------- 169 .SH "N ame"21 .SH "NAME" 170 22 eventlogadm \- push records into the Samba event log store 171 .SH "Synopsis" 172 .fam C 23 .SH "SYNOPSIS" 173 24 .HP \w'\ 'u 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 25 eventlogadm [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ addsource\ \fIEVENTLOG\fR\ \fISOURCENAME\fR\ \fIMSGFILE\fR 177 26 .HP \w'\ 'u 178 \FCeventlogadm\F[] [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ \FCwrite\F[]\ \fIEVENTLOG\fR 179 .fam 180 .fam C 27 eventlogadm [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ write\ \fIEVENTLOG\fR 181 28 .HP \w'\ 'u 182 \FCeventlogadm\F[] [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ \FCdump\F[]\ \fIEVENTLOG\fR\ \fIRECORD_NUMBER\fR 183 .fam 29 eventlogadm [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ dump\ \fIEVENTLOG\fR\ \fIRECORD_NUMBER\fR 184 30 .SH "DESCRIPTION" 185 31 .PP … … 188 34 suite\&. 189 35 .PP 190 \FCeventlogadm\F[] 36 eventlogadm 191 37 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\&. 192 38 .SH "OPTIONS" … … 195 41 .RS 4 196 42 The 197 \ FC\-d\F[]43 \-d 198 44 option causes 199 \FCeventlogadm\F[] 45 eventlogadm 200 46 to emit debugging information\&. 201 47 .RE 202 48 .PP 203 \fB\-o\fR \FCaddsource\F[]\fIEVENTLOG\fR \fISOURCENAME\fR \fIMSGFILE\fR49 \fB\-o\fR addsource \fIEVENTLOG\fR \fISOURCENAME\fR \fIMSGFILE\fR 204 50 .RS 4 205 51 The 206 \ FC\-o addsource\F[]52 \-o addsource 207 53 option creates a new event log source\&. 208 54 .RE 209 55 .PP 210 \fB\-o\fR \FCwrite\F[]\fIEVENTLOG\fR56 \fB\-o\fR write \fIEVENTLOG\fR 211 57 .RS 4 212 58 The 213 \ FC\-o write\F[]59 \-o write 214 60 reads event log records from standard input and writes them to the Samba event log store named by EVENTLOG\&. 215 61 .RE 216 62 .PP 217 \fB\-o\fR \FCdump\F[]\fIEVENTLOG\fR \fIRECORD_NUMBER\fR63 \fB\-o\fR dump \fIEVENTLOG\fR \fIRECORD_NUMBER\fR 218 64 .RS 4 219 65 The 220 \ FC\-o dump\F[]66 \-o dump 221 67 reads event log records from a EVENTLOG tdb and dumps them to standard output on screen\&. 222 68 .RE … … 229 75 .PP 230 76 For the write operation, 231 \FCeventlogadm\F[] 77 eventlogadm 232 78 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\&. 233 79 .PP … … 243 89 .\} 244 90 245 \FCLEN\F[] 91 LEN 246 92 \- This field should be 0, since 247 \FCeventlogadm\F[] 93 eventlogadm 248 94 will calculate this value\&. 249 95 .RE … … 258 104 .\} 259 105 260 \FCRS1\F[] 106 RS1 261 107 \- This must be the value 1699505740\&. 262 108 .RE … … 271 117 .\} 272 118 273 \FCRCN\F[] 119 RCN 274 120 \- This field should be 0\&. 275 121 .RE … … 284 130 .\} 285 131 286 \FCTMG\F[] 132 TMG 287 133 \- The time the eventlog record was generated; format is the number of seconds since 00:00:00 January 1, 1970, UTC\&. 288 134 .RE … … 297 143 .\} 298 144 299 \FCTMW\F[] 145 TMW 300 146 \- The time the eventlog record was written; format is the number of seconds since 00:00:00 January 1, 1970, UTC\&. 301 147 .RE … … 310 156 .\} 311 157 312 \FCEID\F[] 158 EID 313 159 \- The eventlog ID\&. 314 160 .RE … … 323 169 .\} 324 170 325 \FCETP\F[] 171 ETP 326 172 \- The event type \-\- one of "INFO", "ERROR", "WARNING", "AUDIT SUCCESS" or "AUDIT FAILURE"\&. 327 173 .RE … … 336 182 .\} 337 183 338 \FCECT\F[] 184 ECT 339 185 \- The event category; this depends on the message file\&. It is primarily used as a means of filtering in the eventlog viewer\&. 340 186 .RE … … 349 195 .\} 350 196 351 \FCRS2\F[] 197 RS2 352 198 \- This field should be 0\&. 353 199 .RE … … 362 208 .\} 363 209 364 \FCCRN\F[] 210 CRN 365 211 \- This field should be 0\&. 366 212 .RE … … 375 221 .\} 376 222 377 \FCUSL\F[] 223 USL 378 224 \- This field should be 0\&. 379 225 .RE … … 388 234 .\} 389 235 390 \FCSRC\F[] 236 SRC 391 237 \- 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\&. 392 238 .RE … … 401 247 .\} 402 248 403 \FCSRN\F[] 249 SRN 404 250 \- The name of the machine on which the eventlog was generated\&. This is typically the host name\&. 405 251 .RE … … 414 260 .\} 415 261 416 \FCSTR\F[] 262 STR 417 263 \- The text associated with the eventlog\&. There may be more than one string in a record\&. 418 264 .RE … … 427 273 .\} 428 274 429 \FCDAT\F[] 275 DAT 430 276 \- This field should be left unset\&. 431 277 .SH "EXAMPLES" 432 278 .PP 433 279 An example of the record format accepted by 434 \FCeventlogadm\F[]: 435 .sp 436 .if n \{\ 437 .RS 4 438 .\} 439 .fam C 440 .ps -1 280 eventlogadm: 281 .sp 282 .if n \{\ 283 .RS 4 284 .\} 441 285 .nf 442 .if t \{\443 .sp -1444 .\}445 .BB lightgray adjust-for-leading-newline446 .sp -1447 448 286 LEN: 0 449 287 RS1: 1699505740 … … 462 300 DAT: 463 301 464 .EB lightgray adjust-for-leading-newline465 .if t \{\466 .sp 1467 .\}468 302 .fi 469 .fam470 .ps +1471 303 .if n \{\ 472 304 .RE … … 478 310 .RS 4 479 311 .\} 480 .fam C481 .ps -1482 312 .nf 483 .if t \{\484 .sp -1485 .\}486 .BB lightgray adjust-for-leading-newline487 .sp -1488 489 313 eventlogadm \-o addsource Application MyApplication | \e\e 490 314 %SystemRoot%/system32/MyApplication\&.dll 491 315 492 .EB lightgray adjust-for-leading-newline493 .if t \{\494 .sp 1495 .\}496 316 .fi 497 .fam498 .ps +1499 317 .if n \{\ 500 318 .RE … … 506 324 .RS 4 507 325 .\} 508 .fam C509 .ps -1510 326 .nf 511 .if t \{\512 .sp -1513 .\}514 .BB lightgray adjust-for-leading-newline515 .sp -1516 517 327 tail \-f /var/log/messages | \e\e 518 328 my_program_to_parse_into_eventlog_records | \e\e 519 329 eventlogadm SystemLogEvents 520 330 521 .EB lightgray adjust-for-leading-newline522 .if t \{\523 .sp 1524 .\}525 331 .fi 526 .fam527 .ps +1528 332 .if n \{\ 529 333 .RE
Note:
See TracChangeset
for help on using the changeset viewer.