Changeset 286 for branches/samba-3.0/docs/manpages/vfstest.1

Timestamp:

Jun 24, 2009, 5:09:21 PM (16 years ago)

Author:

Herwig Bauernfeind

Message:

Update 3.0 to 3.0.35

File:

• branches/samba-3.0/docs/manpages/vfstest.1 (modified) (43 diffs)

branches/samba-3.0/docs/manpages/vfstest.1

@@ -1 +1 @@
 .\"     Title: vfstest
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\"      Date: 08/25/2008
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
+.\"      Date: 06/22/2009
 .\"    Manual: User Commands
 .\"    Source: Samba 3.0
+.\"  Language: English
 .\"
-.TH "VFSTEST" "1" "08/25/2008" "Samba 3\.0" "User Commands"
+.TH "VFSTEST" "1" "06/22/2009" "Samba 3\&.0" "User Commands"
+.\" -----------------------------------------------------------------
+.\" * (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
+.\" -----------------------------------------------------------------
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
-.SH "NAME"
-vfstest - tool for testing samba VFS modules
-.SH "SYNOPSIS"
-.HP 1
-vfstest [\-d\ debuglevel] [\-c\ command] [\-l\ logdir] [\-h]
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+vfstest \- tool for testing samba VFS modules
+.SH "Synopsis"
+.fam C
+.HP \w'\ 'u
+\FCvfstest\F[] [\-d\ debuglevel] [\-c\ command] [\-l\ logdir] [\-h]
+.fam
 .SH "DESCRIPTION"
 .PP
 This tool is part of the
 \fBsamba\fR(7)
-suite\.
-.PP
-vfstest
-is a small command line utility that has the ability to test dso samba VFS modules\. It gives the user the ability to call the various VFS functions manually and supports cascaded VFS modules\.
+suite\&.
+.PP
+\FCvfstest\F[]
+is a small command line utility that has the ability to test dso samba VFS modules\&. It gives the user the ability to call the various VFS functions manually and supports cascaded VFS modules\&.
 .SH "OPTIONS"
 .PP
 \-c|\-\-command=command
 .RS 4
-Execute the specified (colon\-separated) commands\. See below for the commands that are available\.
+Execute the specified (colon\-separated) commands\&. See below for the commands that are available\&.
 .RE
 .PP
 \-h|\-\-help
 .RS 4
-Print a summary of command line options\.
+Print a summary of command line options\&.
 .RE
 .PP
 \-l|\-\-logfile=logbasename
 .RS 4
-File name for log/debug files\. The extension
-\fB\'\.client\'\fR
-will be appended\. The log file is never removed by the client\.
+File name for log/debug files\&. The extension
+\fB\'\&.client\'\fR
+will be appended\&. The log file is never removed by the client\&.
 .RE
 .PP
@@ -46 +204 @@
 .RS 4
 \fIlevel\fR
-is an integer from 0 to 10\. The default value if this parameter is not specified is 0\.
-.sp
-The higher this value, the more detail will be logged to the log files about the activities of the server\. At level 0, only critical errors and serious warnings will be logged\. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\.
-.sp
-Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\.
+is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
+.sp
+The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
+.sp
+Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
 .sp
 Note that specifying this parameter here will override the
-\fIlog level\fR
+\m[blue]\fBlog level\fR\m[]
 parameter in the
-\fIsmb\.conf\fR
-file\.
+\FCsmb\&.conf\F[]
+file\&.
 .RE
 .PP
 \-V
 .RS 4
-Prints the program version number\.
+Prints the program version number\&.
 .RE
 .PP
 \-s <configuration file>
 .RS 4
-The file specified contains the configuration details required by the server\. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\. See
-\fIsmb\.conf\fR
-for more information\. The default configuration file name is determined at compile time\.
+The file specified contains the configuration details required by the server\&. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See
+\FCsmb\&.conf\F[]
+for more information\&. The default configuration file name is determined at compile time\&.
 .RE
 .PP
 \-l|\-\-log\-basename=logdirectory
 .RS 4
-Base directory name for log/debug files\. The extension
-\fB"\.progname"\fR
-will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\.
+Base directory name for log/debug files\&. The extension
+\fB"\&.progname"\fR
+will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
 .RE
 .SH "COMMANDS"
@@ -89 +247 @@
 .IP \(bu 2.3
 .\}
-load <module\.so>
+\FCload <module\&.so>\F[]
 \- Load specified VFS module
 .RE
@@ -101 +259 @@
 .IP \(bu 2.3
 .\}
-populate <char> <size>
+\FCpopulate <char> <size>\F[]
 \- Populate a data buffer with the specified data
 .RE
@@ -113 +271 @@
 .IP \(bu 2.3
 .\}
-showdata [<offset> <len>]
+\FCshowdata [<offset> <len>]\F[]
 \- Show data currently in data buffer
 .RE
@@ -125 +283 @@
 .IP \(bu 2.3
 .\}
-connect
+\FCconnect\F[]
 \- VFS connect()
 .RE
@@ -137 +295 @@
 .IP \(bu 2.3
 .\}
-disconnect
+\FCdisconnect\F[]
 \- VFS disconnect()
 .RE
@@ -149 +307 @@
 .IP \(bu 2.3
 .\}
-disk_free
+\FCdisk_free\F[]
 \- VFS disk_free()
 .RE
@@ -161 +319 @@
 .IP \(bu 2.3
 .\}
-opendir
+\FCopendir\F[]
 \- VFS opendir()
 .RE
@@ -173 +331 @@
 .IP \(bu 2.3
 .\}
-readdir
+\FCreaddir\F[]
 \- VFS readdir()
 .RE
@@ -185 +343 @@
 .IP \(bu 2.3
 .\}
-mkdir
+\FCmkdir\F[]
 \- VFS mkdir()
 .RE
@@ -197 +355 @@
 .IP \(bu 2.3
 .\}
-rmdir
+\FCrmdir\F[]
 \- VFS rmdir()
 .RE
@@ -209 +367 @@
 .IP \(bu 2.3
 .\}
-closedir
+\FCclosedir\F[]
 \- VFS closedir()
 .RE
@@ -221 +379 @@
 .IP \(bu 2.3
 .\}
-open
+\FCopen\F[]
 \- VFS open()
 .RE
@@ -233 +391 @@
 .IP \(bu 2.3
 .\}
-close
+\FCclose\F[]
 \- VFS close()
 .RE
@@ -245 +403 @@
 .IP \(bu 2.3
 .\}
-read
+\FCread\F[]
 \- VFS read()
 .RE
@@ -257 +415 @@
 .IP \(bu 2.3
 .\}
-write
+\FCwrite\F[]
 \- VFS write()
 .RE
@@ -269 +427 @@
 .IP \(bu 2.3
 .\}
-lseek
+\FClseek\F[]
 \- VFS lseek()
 .RE
@@ -281 +439 @@
 .IP \(bu 2.3
 .\}
-rename
+\FCrename\F[]
 \- VFS rename()
 .RE
@@ -293 +451 @@
 .IP \(bu 2.3
 .\}
-fsync
+\FCfsync\F[]
 \- VFS fsync()
 .RE
@@ -305 +463 @@
 .IP \(bu 2.3
 .\}
-stat
+\FCstat\F[]
 \- VFS stat()
 .RE
@@ -317 +475 @@
 .IP \(bu 2.3
 .\}
-fstat
+\FCfstat\F[]
 \- VFS fstat()
 .RE
@@ -329 +487 @@
 .IP \(bu 2.3
 .\}
-lstat
+\FClstat\F[]
 \- VFS lstat()
 .RE
@@ -341 +499 @@
 .IP \(bu 2.3
 .\}
-unlink
+\FCunlink\F[]
 \- VFS unlink()
 .RE
@@ -353 +511 @@
 .IP \(bu 2.3
 .\}
-chmod
+\FCchmod\F[]
 \- VFS chmod()
 .RE
@@ -365 +523 @@
 .IP \(bu 2.3
 .\}
-fchmod
+\FCfchmod\F[]
 \- VFS fchmod()
 .RE
@@ -377 +535 @@
 .IP \(bu 2.3
 .\}
-chown
+\FCchown\F[]
 \- VFS chown()
 .RE
@@ -389 +547 @@
 .IP \(bu 2.3
 .\}
-fchown
+\FCfchown\F[]
 \- VFS fchown()
 .RE
@@ -401 +559 @@
 .IP \(bu 2.3
 .\}
-chdir
+\FCchdir\F[]
 \- VFS chdir()
 .RE
@@ -413 +571 @@
 .IP \(bu 2.3
 .\}
-getwd
+\FCgetwd\F[]
 \- VFS getwd()
 .RE
@@ -425 +583 @@
 .IP \(bu 2.3
 .\}
-utime
+\FCutime\F[]
 \- VFS utime()
 .RE
@@ -437 +595 @@
 .IP \(bu 2.3
 .\}
-ftruncate
+\FCftruncate\F[]
 \- VFS ftruncate()
 .RE
@@ -449 +607 @@
 .IP \(bu 2.3
 .\}
-lock
+\FClock\F[]
 \- VFS lock()
 .RE
@@ -461 +619 @@
 .IP \(bu 2.3
 .\}
-symlink
+\FCsymlink\F[]
 \- VFS symlink()
 .RE
@@ -473 +631 @@
 .IP \(bu 2.3
 .\}
-readlink
+\FCreadlink\F[]
 \- VFS readlink()
 .RE
@@ -485 +643 @@
 .IP \(bu 2.3
 .\}
-link
+\FClink\F[]
 \- VFS link()
 .RE
@@ -497 +655 @@
 .IP \(bu 2.3
 .\}
-mknod
+\FCmknod\F[]
 \- VFS mknod()
 .RE
@@ -509 +667 @@
 .IP \(bu 2.3
 .\}
-realpath
+\FCrealpath\F[]
 \- VFS realpath()
 .sp
@@ -524 +682 @@
 .IP \(bu 2.3
 .\}
-conf <smb\.conf>
+\FCconf <smb\&.conf>\F[]
 \- Load a different configuration file
 .RE
@@ -536 +694 @@
 .IP \(bu 2.3
 .\}
-help [<command>]
+\FChelp [<command>]\F[]
 \- Get list of commands or info about specified command
 .RE
@@ -548 +706 @@
 .IP \(bu 2.3
 .\}
-debuglevel <level>
+\FCdebuglevel <level>\F[]
 \- Set debug level
 .RE
@@ -560 +718 @@
 .IP \(bu 2.3
 .\}
-freemem
+\FCfreemem\F[]
 \- Free memory currently in use
 .RE
@@ -572 +730 @@
 .IP \(bu 2.3
 .\}
-exit
+\FCexit\F[]
 \- Exit vfstest
 .SH "VERSION"
 .PP
-This man page is correct for version 3\.0 of the Samba suite\.
+This man page is correct for version 3\&.0 of the Samba suite\&.
 .SH "AUTHOR"
 .PP
-The original Samba software and related utilities were created by Andrew Tridgell\. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\.
-.PP
-The vfstest man page was written by Jelmer Vernooij\.
+The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
+.PP
+The vfstest man page was written by Jelmer Vernooij\&.