Ignore:
Timestamp:
Jan 15, 2010, 8:21:06 AM (16 years ago)
Author:
Herwig Bauernfeind
Message:

Update Samba 3.3 to 3.3.10 (docs)

File:
1 edited

Legend:

Unmodified
Added
Removed

  • branches/samba-3.3.x/docs/manpages/eventlogadm.8

    r342 r368  
     1'\" t
    12.\"     Title: eventlogadm
    23.\"    Author: [see the "AUTHOR" section]
    3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
    4 .\"      Date: 10/12/2009
     4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
     5.\"      Date: 01/14/2010
    56.\"    Manual: System Administration tools
    67.\"    Source: Samba 3.3
    78.\"  Language: English
    89.\"
    9 .TH "EVENTLOGADM" "8" "10/12/2009" "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 ..
     10.TH "EVENTLOGADM" "8" "01/14/2010" "Samba 3\&.3" "System Administration tools"
    15911.\" -----------------------------------------------------------------
    16012.\" * set default formatting
    … …  
    16719.\" * MAIN CONTENT STARTS HERE *
    16820.\" -----------------------------------------------------------------
    169 .SH "Name"
     21.SH "NAME"
    17022eventlogadm \- push records into the Samba event log store
    171 .SH "Synopsis"
    172 .fam C
     23.SH "SYNOPSIS"
    17324.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
     25eventlogadm [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ addsource\ \fIEVENTLOG\fR\ \fISOURCENAME\fR\ \fIMSGFILE\fR
    17726.HP \w'\ 'u
    178 \FCeventlogadm\F[] [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ \FCwrite\F[]\ \fIEVENTLOG\fR
    179 .fam
     27eventlogadm [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ write\ \fIEVENTLOG\fR
    18028.SH "DESCRIPTION"
    18129.PP
    … …  
    18432suite\&.
    18533.PP
    186 \FCeventlogadm\F[]
     34eventlogadm
    18735is 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\&.
    18836.SH "OPTIONS"
    … …  
    19139.RS 4
    19240The
    193 \FC\-d\F[]
     41\-d
    19442option causes
    195 \FCeventlogadm\F[]
     43eventlogadm
    19644to emit debugging information\&.
    19745.RE
    19846.PP
    199 \fB\-o\fR \FCaddsource\F[] \fIEVENTLOG\fR \fISOURCENAME\fR \fIMSGFILE\fR
     47\fB\-o\fR addsource \fIEVENTLOG\fR \fISOURCENAME\fR \fIMSGFILE\fR
    20048.RS 4
    20149The
    202 \FC\-o addsource\F[]
     50\-o addsource
    20351option creates a new event log source\&.
    20452.RE
    20553.PP
    206 \fB\-o\fR \FCwrite\F[] \fIEVENTLOG\fR
     54\fB\-o\fR write \fIEVENTLOG\fR
    20755.RS 4
    20856The
    209 \FC\-o write\F[]
     57\-o write
    21058reads event log records from standard input and writes them to the Samba event log store named by EVENTLOG\&.
    21159.RE
    … …  
    21866.PP
    21967For the write operation,
    220 \FCeventlogadm\F[]
     68eventlogadm
    22169expects 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\&.
    22270.PP
    … …  
    23280.\}
    23381
    234 \FCLEN\F[]
     82LEN
    23583\- This field should be 0, since
    236 \FCeventlogadm\F[]
     84eventlogadm
    23785will calculate this value\&.
    23886.RE
    … …  
    24795.\}
    24896
    249 \FCRS1\F[]
     97RS1
    25098\- This must be the value 1699505740\&.
    25199.RE
    … …  
    260108.\}
    261109
    262 \FCRCN\F[]
     110RCN
    263111\- This field should be 0\&.
    264112.RE
    … …  
    273121.\}
    274122
    275 \FCTMG\F[]
     123TMG
    276124\- The time the eventlog record was generated; format is the number of seconds since 00:00:00 January 1, 1970, UTC\&.
    277125.RE
    … …  
    286134.\}
    287135
    288 \FCTMW\F[]
     136TMW
    289137\- The time the eventlog record was written; format is the number of seconds since 00:00:00 January 1, 1970, UTC\&.
    290138.RE
    … …  
    299147.\}
    300148
    301 \FCEID\F[]
     149EID
    302150\- The eventlog ID\&.
    303151.RE
    … …  
    312160.\}
    313161
    314 \FCETP\F[]
     162ETP
    315163\- The event type \-\- one of "INFO", "ERROR", "WARNING", "AUDIT SUCCESS" or "AUDIT FAILURE"\&.
    316164.RE
    … …  
    325173.\}
    326174
    327 \FCECT\F[]
     175ECT
    328176\- The event category; this depends on the message file\&. It is primarily used as a means of filtering in the eventlog viewer\&.
    329177.RE
    … …  
    338186.\}
    339187
    340 \FCRS2\F[]
     188RS2
    341189\- This field should be 0\&.
    342190.RE
    … …  
    351199.\}
    352200
    353 \FCCRN\F[]
     201CRN
    354202\- This field should be 0\&.
    355203.RE
    … …  
    364212.\}
    365213
    366 \FCUSL\F[]
     214USL
    367215\- This field should be 0\&.
    368216.RE
    … …  
    377225.\}
    378226
    379 \FCSRC\F[]
     227SRC
    380228\- 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\&.
    381229.RE
    … …  
    390238.\}
    391239
    392 \FCSRN\F[]
     240SRN
    393241\- The name of the machine on which the eventlog was generated\&. This is typically the host name\&.
    394242.RE
    … …  
    403251.\}
    404252
    405 \FCSTR\F[]
     253STR
    406254\- The text associated with the eventlog\&. There may be more than one string in a record\&.
    407255.RE
    … …  
    416264.\}
    417265
    418 \FCDAT\F[]
     266DAT
    419267\- This field should be left unset\&.
    420268.SH "EXAMPLES"
    421269.PP
    422270An example of the record format accepted by
    423 \FCeventlogadm\F[]:
    424 .sp
    425 .if n \{\
    426 .RS 4
    427 .\}
    428 .fam C
    429 .ps -1
     271eventlogadm:
     272.sp
     273.if n \{\
     274.RS 4
     275.\}
    430276.nf
    431 .if t \{\
    432 .sp -1
    433 .\}
    434 .BB lightgray adjust-for-leading-newline
    435 .sp -1
    436 
    437277        LEN: 0
    438278        RS1: 1699505740
    … …  
    451291        DAT:
    452292       
    453 .EB lightgray adjust-for-leading-newline
    454 .if t \{\
    455 .sp 1
    456 .\}
    457293.fi
    458 .fam
    459 .ps +1
    460294.if n \{\
    461295.RE
    … …  
    467301.RS 4
    468302.\}
    469 .fam C
    470 .ps -1
    471303.nf
    472 .if t \{\
    473 .sp -1
    474 .\}
    475 .BB lightgray adjust-for-leading-newline
    476 .sp -1
    477 
    478304        eventlogadm \-o addsource Application MyApplication | \e\e
    479305                %SystemRoot%/system32/MyApplication\&.dll
    480306       
    481 .EB lightgray adjust-for-leading-newline
    482 .if t \{\
    483 .sp 1
    484 .\}
    485307.fi
    486 .fam
    487 .ps +1
    488308.if n \{\
    489309.RE
    … …  
    495315.RS 4
    496316.\}
    497 .fam C
    498 .ps -1
    499317.nf
    500 .if t \{\
    501 .sp -1
    502 .\}
    503 .BB lightgray adjust-for-leading-newline
    504 .sp -1
    505 
    506318        tail \-f /var/log/messages | \e\e
    507319                my_program_to_parse_into_eventlog_records | \e\e
    508320                eventlogadm SystemLogEvents
    509321       
    510 .EB lightgray adjust-for-leading-newline
    511 .if t \{\
    512 .sp 1
    513 .\}
    514322.fi
    515 .fam
    516 .ps +1
    517323.if n \{\
    518324.RE
Note: See TracChangeset for help on using the changeset viewer.