Ignore:
Timestamp:
Jul 2, 2011, 3:35:33 PM (14 years ago)
Author:
Herwig Bauernfeind
Message:

Samba 3.5: Update trunk to 3.5.8

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/server/docs/manpages/eventlogadm.8

    r480 r596  
     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: 06/18/2010
     4.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
     5.\"      Date: 03/06/2011
    56.\"    Manual: System Administration tools
    67.\"    Source: Samba 3.5
    78.\"  Language: English
    89.\"
    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"
    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
    180 .fam C
     27eventlogadm [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ write\ \fIEVENTLOG\fR
    18128.HP \w'\ 'u
    182 \FCeventlogadm\F[] [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ \FCdump\F[]\ \fIEVENTLOG\fR\ \fIRECORD_NUMBER\fR
    183 .fam
     29eventlogadm [\fB\-d\fR] [\fB\-h\fR] \fB\-o\fR\ dump\ \fIEVENTLOG\fR\ \fIRECORD_NUMBER\fR
    18430.SH "DESCRIPTION"
    18531.PP
     
    18834suite\&.
    18935.PP
    190 \FCeventlogadm\F[]
     36eventlogadm
    19137is 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\&.
    19238.SH "OPTIONS"
     
    19541.RS 4
    19642The
    197 \FC\-d\F[]
     43\-d
    19844option causes
    199 \FCeventlogadm\F[]
     45eventlogadm
    20046to emit debugging information\&.
    20147.RE
    20248.PP
    203 \fB\-o\fR \FCaddsource\F[] \fIEVENTLOG\fR \fISOURCENAME\fR \fIMSGFILE\fR
     49\fB\-o\fR addsource \fIEVENTLOG\fR \fISOURCENAME\fR \fIMSGFILE\fR
    20450.RS 4
    20551The
    206 \FC\-o addsource\F[]
     52\-o addsource
    20753option creates a new event log source\&.
    20854.RE
    20955.PP
    210 \fB\-o\fR \FCwrite\F[] \fIEVENTLOG\fR
     56\fB\-o\fR write \fIEVENTLOG\fR
    21157.RS 4
    21258The
    213 \FC\-o write\F[]
     59\-o write
    21460reads event log records from standard input and writes them to the Samba event log store named by EVENTLOG\&.
    21561.RE
    21662.PP
    217 \fB\-o\fR \FCdump\F[] \fIEVENTLOG\fR \fIRECORD_NUMBER\fR
     63\fB\-o\fR dump \fIEVENTLOG\fR \fIRECORD_NUMBER\fR
    21864.RS 4
    21965The
    220 \FC\-o dump\F[]
     66\-o dump
    22167reads event log records from a EVENTLOG tdb and dumps them to standard output on screen\&.
    22268.RE
     
    22975.PP
    23076For the write operation,
    231 \FCeventlogadm\F[]
     77eventlogadm
    23278expects 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\&.
    23379.PP
     
    24389.\}
    24490
    245 \FCLEN\F[]
     91LEN
    24692\- This field should be 0, since
    247 \FCeventlogadm\F[]
     93eventlogadm
    24894will calculate this value\&.
    24995.RE
     
    258104.\}
    259105
    260 \FCRS1\F[]
     106RS1
    261107\- This must be the value 1699505740\&.
    262108.RE
     
    271117.\}
    272118
    273 \FCRCN\F[]
     119RCN
    274120\- This field should be 0\&.
    275121.RE
     
    284130.\}
    285131
    286 \FCTMG\F[]
     132TMG
    287133\- The time the eventlog record was generated; format is the number of seconds since 00:00:00 January 1, 1970, UTC\&.
    288134.RE
     
    297143.\}
    298144
    299 \FCTMW\F[]
     145TMW
    300146\- The time the eventlog record was written; format is the number of seconds since 00:00:00 January 1, 1970, UTC\&.
    301147.RE
     
    310156.\}
    311157
    312 \FCEID\F[]
     158EID
    313159\- The eventlog ID\&.
    314160.RE
     
    323169.\}
    324170
    325 \FCETP\F[]
     171ETP
    326172\- The event type \-\- one of "INFO", "ERROR", "WARNING", "AUDIT SUCCESS" or "AUDIT FAILURE"\&.
    327173.RE
     
    336182.\}
    337183
    338 \FCECT\F[]
     184ECT
    339185\- The event category; this depends on the message file\&. It is primarily used as a means of filtering in the eventlog viewer\&.
    340186.RE
     
    349195.\}
    350196
    351 \FCRS2\F[]
     197RS2
    352198\- This field should be 0\&.
    353199.RE
     
    362208.\}
    363209
    364 \FCCRN\F[]
     210CRN
    365211\- This field should be 0\&.
    366212.RE
     
    375221.\}
    376222
    377 \FCUSL\F[]
     223USL
    378224\- This field should be 0\&.
    379225.RE
     
    388234.\}
    389235
    390 \FCSRC\F[]
     236SRC
    391237\- 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\&.
    392238.RE
     
    401247.\}
    402248
    403 \FCSRN\F[]
     249SRN
    404250\- The name of the machine on which the eventlog was generated\&. This is typically the host name\&.
    405251.RE
     
    414260.\}
    415261
    416 \FCSTR\F[]
     262STR
    417263\- The text associated with the eventlog\&. There may be more than one string in a record\&.
    418264.RE
     
    427273.\}
    428274
    429 \FCDAT\F[]
     275DAT
    430276\- This field should be left unset\&.
    431277.SH "EXAMPLES"
    432278.PP
    433279An 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
     280eventlogadm:
     281.sp
     282.if n \{\
     283.RS 4
     284.\}
    441285.nf
    442 .if t \{\
    443 .sp -1
    444 .\}
    445 .BB lightgray adjust-for-leading-newline
    446 .sp -1
    447 
    448286        LEN: 0
    449287        RS1: 1699505740
     
    462300        DAT:
    463301       
    464 .EB lightgray adjust-for-leading-newline
    465 .if t \{\
    466 .sp 1
    467 .\}
    468302.fi
    469 .fam
    470 .ps +1
    471303.if n \{\
    472304.RE
     
    478310.RS 4
    479311.\}
    480 .fam C
    481 .ps -1
    482312.nf
    483 .if t \{\
    484 .sp -1
    485 .\}
    486 .BB lightgray adjust-for-leading-newline
    487 .sp -1
    488 
    489313        eventlogadm \-o addsource Application MyApplication | \e\e
    490314                %SystemRoot%/system32/MyApplication\&.dll
    491315       
    492 .EB lightgray adjust-for-leading-newline
    493 .if t \{\
    494 .sp 1
    495 .\}
    496316.fi
    497 .fam
    498 .ps +1
    499317.if n \{\
    500318.RE
     
    506324.RS 4
    507325.\}
    508 .fam C
    509 .ps -1
    510326.nf
    511 .if t \{\
    512 .sp -1
    513 .\}
    514 .BB lightgray adjust-for-leading-newline
    515 .sp -1
    516 
    517327        tail \-f /var/log/messages | \e\e
    518328                my_program_to_parse_into_eventlog_records | \e\e
    519329                eventlogadm SystemLogEvents
    520330       
    521 .EB lightgray adjust-for-leading-newline
    522 .if t \{\
    523 .sp 1
    524 .\}
    525331.fi
    526 .fam
    527 .ps +1
    528332.if n \{\
    529333.RE
Note: See TracChangeset for help on using the changeset viewer.