Changeset 427 for vendor/current/docs/manpages/vfs_smb_traffic_analyzer.8

Timestamp:

Apr 9, 2010, 3:20:58 PM (16 years ago)

Author:

Silvan Scherrer

Message:

Samba 3.5.x: update to 3.5.2

File:

• vendor/current/docs/manpages/vfs_smb_traffic_analyzer.8 (modified) (18 diffs)

vendor/current/docs/manpages/vfs_smb_traffic_analyzer.8

@@ -1 @@
-'\" t
 .\"     Title: smb_traffic_analyzer
 .\"    Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 02/19/2010
+.\" Generator: DocBook XSL Stylesheets v1.7 <http://docbook.sf.net/>
+.\"      Date: 0/2010
 .\"    Manual: System Administration tools
 .\"    Source: Samba 3.5
 .\"  Language: English
 .\"
-.TH "SMB_TRAFFIC_ANALYZER" "8" "02/19/2010" "Samba 3\&.5" "System Administration tools"
+.TH "SMB_TRAFFIC_ANALYZER" "8" "03/30/2010" "Samba 3\&.5" "System Administration tools"
+.\" -----------------------------------------------------------------
+.\" * (re)Define some macros
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" toupper - uppercase a string (locale-aware)
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de toupper
+.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
+\\$*
+.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH-xref - format a cross-reference to an SH section
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de SH-xref
+.ie n \{\
+.\}
+.toupper \\$*
+.el \{\
+\\$*
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH - level-one heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SH
+.\" put an extra blank line of space above the head in non-TTY output
+.if t \{\
+.sp 1
+.\}
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[an-margin]u
+.ti 0
+.HTML-TAG ".NH \\n[an-level]"
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+\." make the size of the head bigger
+.ps +3
+.ft B
+.ne (2v + 1u)
+.ie n \{\
+.\" if n (TTY output), use uppercase
+.toupper \\$*
+.\}
+.el \{\
+.nr an-break-flag 0
+.\" if not n (not TTY), use normal case (not uppercase)
+\\$1
+.in \\n[an-margin]u
+.ti 0
+.\" if not n (not TTY), put a border/line under subheading
+.sp -.6
+\l'\n(.lu'
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SS - level-two heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SS
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[IN]u
+.ti \\n[SN]u
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.ps \\n[PS-SS]u
+\." make the size of the head bigger
+.ps +2
+.ft B
+.ne (2v + 1u)
+.if \\n[.$] \&\\$*
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BB/BE - put background/screen (filled box) around block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BB
+.if t \{\
+.sp -.5
+.br
+.in +2n
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EB
+.if t \{\
+.if "\\$2"adjust-for-leading-newline" \{\
+.sp -1
+.\}
+.br
+.di
+.in
+.ll
+.gcolor
+.nr BW \\n(.lu-\\n(.i
+.nr BH \\n(dn+.5v
+.ne \\n(BHu+.5v
+.ie "\\$2"adjust-for-leading-newline" \{\
+\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.el \{\
+\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.in 0
+.sp -.5v
+.nf
+.BX
+.in
+.sp .5v
+.fi
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EM
+.if t \{\
+.br
+.di
+.ll
+.gcolor
+.nr BH \\n(dn
+.ne \\n(BHu
+\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
+.in 0
+.nf
+.BX
+.in
+.fi
+.\}
+..
 .\" -----------------------------------------------------------------
 .\" * set default formatting
@@ -19 +167 @@
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
-.SH "NAME"
+.SH "N"
 vfs_smb_traffic_analyzer \- log Samba VFS read and write operations through a socket to a helper application
-.SH "SYNOPSIS"
+.SH "Synopsis"
+.fam C
 .HP \w'\ 'u
-vfs objects = smb_traffic_analyzer
+\FCvfs objects = smb_traffic_analyzer\F[]
+.fam
 .SH "DESCRIPTION"
 .PP
@@ -31 +181 @@
 .PP
 The
-vfs_smb_traffic_analyzer
+\FCvfs_smb_traffic_analyzer\F[]
 VFS module logs client write and read operations on a Samba server and sends this data over a socket to a helper program, which feeds a SQL database\&. More information on the helper programs can be obtained from the homepage of the project at: http://holger123\&.wordpress\&.com/smb\-traffic\-analyzer/
 .PP
-vfs_smb_traffic_analyzer
+\FCvfs_smb_traffic_analyzer\F[]
 currently is aware of the following VFS operations:
 .RS 4
@@ -49 +199 @@
 .RE
 .PP
-vfs_smb_traffic_analyzer
+\FCvfs_smb_traffic_analyzer\F[]
 sends the following data in a fixed format seperated by a comma through either an internet or a unix domain socket:
 .sp
@@ -55 +205 @@
 .RS 4
 .\}
-.nf
+.fam C
+.ps -1
+.nf
+.if t \{\
+.sp -1
+.\}
+.BB lightgray adjust-for-leading-newline
+.sp -1
+
         BYTES|USER|DOMAIN|READ/WRITE|SHARE|FILENAME|TIMESTAMP
         
-.fi
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
+.fi
+.fam
+.ps +1
 .if n \{\
 .RE
@@ -73 +237 @@
 .IP \(bu 2.3
 .\}
-BYTES
+\FCBYTES\F[]
 \- the length in bytes of the VFS operation
 .RE
@@ -85 +249 @@
 .IP \(bu 2.3
 .\}
-USER
+\FCUSER\F[]
 \- the user who initiated the operation
 .RE
@@ -97 +261 @@
 .IP \(bu 2.3
 .\}
-DOMAIN
+\FCDOMAIN\F[]
 \- the domain of the user
 .RE
@@ -109 +273 @@
 .IP \(bu 2.3
 .\}
-READ/WRITE
+\FCREAD/WRITE\F[]
 \- either "W" for a write operation or "R" for read
 .RE
@@ -121 +285 @@
 .IP \(bu 2.3
 .\}
-SHARE
+\FCSHARE\F[]
 \- the name of the share on which the VFS operation occured
 .RE
@@ -133 +297 @@
 .IP \(bu 2.3
 .\}
-FILENAME
+\FCFILENAME\F[]
 \- the name of the file that was used by the VFS operation
 .RE
@@ -145 +309 @@
 .IP \(bu 2.3
 .\}
-TIMESTAMP
+\FCTIMESTAMP\F[]
 \- a timestamp, formatted as "yyyy\-mm\-dd hh\-mm\-ss\&.ms" indicating when the VFS operation occured
 .sp
@@ -184 +348 @@
 .RS 4
 .\}
-.nf
+.fam C
+.ps -1
+.nf
+.if t \{\
+.sp -1
+.\}
+.BB lightgray adjust-for-leading-newline
+.sp -1
+
         \fI[example_share]\fR
         \m[blue]\fBpath = /data/example\fR\m[]
@@ -190 +362 @@
         \m[blue]\fBsmb_traffic_analyzer:mode = unix_domain_socket\fR\m[]
         
-.fi
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
+.fi
+.fam
+.ps +1
 .if n \{\
 .RE
@@ -200 +378 @@
 .RS 4
 .\}
-.nf
+.fam C
+.ps -1
+.nf
+.if t \{\
+.sp -1
+.\}
+.BB lightgray adjust-for-leading-newline
+.sp -1
+
         \fI[example_share]\fR
         \m[blue]\fBpath = /data/example\fR\m[]
@@ -207 +393 @@
         \m[blue]\fBsmb_traffic_analyzer:port = 3491\fR\m[]
         
-.fi
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
+.fi
+.fam
+.ps +1
 .if n \{\
 .RE
@@ -217 +409 @@
 .RS 4
 .\}
-.nf
+.fam C
+.ps -1
+.nf
+.if t \{\
+.sp -1
+.\}
+.BB lightgray adjust-for-leading-newline
+.sp -1
+
         \fI[example_share]\fR
         \m[blue]\fBpath = /data/example\fR\m[]
@@ -225 +425 @@
         \m[blue]\fBsmb_traffic_analyzer:anonymize_prefix = User\fR\m[]
         
-.fi
+.EB lightgray adjust-for-leading-newline
+.if t \{\
+.sp 1
+.\}
+.fi
+.fam
+.ps +1
 .if n \{\
 .RE