summaryrefslogtreecommitdiff
path: root/docs/manpages/vfstest.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/manpages/vfstest.1')
-rw-r--r--docs/manpages/vfstest.1266
1 files changed, 95 insertions, 171 deletions
diff --git a/docs/manpages/vfstest.1 b/docs/manpages/vfstest.1
index a6d01fba57..9877e2e461 100644
--- a/docs/manpages/vfstest.1
+++ b/docs/manpages/vfstest.1
@@ -1,271 +1,195 @@
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "VFSTEST" 1 "" "" ""
+.\" This manpage has been automatically generated by docbook2man
+.\" from a DocBook document. This tool can be found at:
+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
+.\" Please send any bug reports, improvements, comments, patches,
+.\" etc. to Steve Cheng <steve@ggi-project.org>.
+.TH "VFSTEST" "1" "04 March 2003" "" ""
.SH NAME
vfstest \- tool for testing samba VFS modules
-.SH "SYNOPSIS"
+.SH SYNOPSIS
-.nf
-\fBvfstest\fR [-d debuglevel] [-c command] [-l logfile] [-h]
-.fi
+\fBvfstest\fR [ \fB-d debuglevel\fR ] [ \fB-c command\fR ] [ \fB-l logfile\fR ] [ \fB-h\fR ]
.SH "DESCRIPTION"
-
.PP
-This tool is part of the \fBSamba\fR(7) suite\&.
-
+This tool is part of the Samba suite.
.PP
-\fBvfstest\fR 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\&.
-
+\fBvfstest\fR 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"
-
-.TP
--c|--command=command
-Execute the specified (colon-separated) commands\&. See below for the commands that are available\&.
-
-
-.TP
--h|--help
-Print a summary of command line options\&.
-
-
.TP
--l|--logfile=logbasename
-File name for log/debug files\&. The extension \fB'\&.client'\fR will be appended\&. The log file is never removed by the client\&.
-
-
-.TP
--V
-Prints the version number for \fBsmbd\fR\&.
-
-
-.TP
--s <configuration file>
-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 \fI smb\&.conf(5)\fR for more information\&. The default configuration file name is determined at compile time\&.
-
-
-.TP
--d|--debug=debuglevel
-\fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
-
-
-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\&.
-
-
-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\&.
-
-
-Note that specifying this parameter here will override the log level parameter in the \fIsmb\&.conf(5)\fR file\&.
-
-
-.TP
--l|--logfile=logbasename
-File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&.
-
-
+\fB-c|--command=command\fR
+Execute the specified (colon-separated) commands.
+See below for the commands that are available.
+.TP
+\fB-d|--debug=debuglevel\fR
+\fIdebuglevel\fR is an integer
+from 0 to 10. The default value if this parameter is
+not specified is zero.
+
+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.
+
+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.
+
+Note that specifying this parameter here will
+override the log
+level file.
+.TP
+\fB-h|--help\fR
+Print a summary of command line options.
+.TP
+\fB-l|--logfile=logbasename\fR
+File name for log/debug files. The extension
+\&'.client' will be appended. The log file is never removed
+by the client.
.SH "COMMANDS"
-
.PP
\fBVFS COMMANDS\fR
-
-.TP 3
+.TP 0.2i
\(bu
-\fBload <module.so>\fR - Load specified VFS module
-
-.TP
+\fBload <module.so>\fR - Load specified VFS module
+.TP 0.2i
\(bu
\fBpopulate <char> <size>\fR - Populate a data buffer with the specified data
-
-.TP
+.TP 0.2i
\(bu
\fBshowdata [<offset> <len>]\fR - Show data currently in data buffer
-
-.TP
+.TP 0.2i
\(bu
\fBconnect\fR - VFS connect()
-
-.TP
+.TP 0.2i
\(bu
\fBdisconnect\fR - VFS disconnect()
-
-.TP
+.TP 0.2i
\(bu
\fBdisk_free\fR - VFS disk_free()
-
-.TP
+.TP 0.2i
\(bu
\fBopendir\fR - VFS opendir()
-
-.TP
+.TP 0.2i
\(bu
\fBreaddir\fR - VFS readdir()
-
-.TP
+.TP 0.2i
\(bu
\fBmkdir\fR - VFS mkdir()
-
-.TP
+.TP 0.2i
\(bu
\fBrmdir\fR - VFS rmdir()
-
-.TP
+.TP 0.2i
\(bu
\fBclosedir\fR - VFS closedir()
-
-.TP
+.TP 0.2i
\(bu
\fBopen\fR - VFS open()
-
-.TP
+.TP 0.2i
\(bu
\fBclose\fR - VFS close()
-
-.TP
+.TP 0.2i
\(bu
\fBread\fR - VFS read()
-
-.TP
+.TP 0.2i
\(bu
\fBwrite\fR - VFS write()
-
-.TP
+.TP 0.2i
\(bu
\fBlseek\fR - VFS lseek()
-
-.TP
+.TP 0.2i
\(bu
\fBrename\fR - VFS rename()
-
-.TP
+.TP 0.2i
\(bu
\fBfsync\fR - VFS fsync()
-
-.TP
+.TP 0.2i
\(bu
\fBstat\fR - VFS stat()
-
-.TP
+.TP 0.2i
\(bu
\fBfstat\fR - VFS fstat()
-
-.TP
+.TP 0.2i
\(bu
\fBlstat\fR - VFS lstat()
-
-.TP
+.TP 0.2i
\(bu
\fBunlink\fR - VFS unlink()
-
-.TP
+.TP 0.2i
\(bu
\fBchmod\fR - VFS chmod()
-
-.TP
+.TP 0.2i
\(bu
\fBfchmod\fR - VFS fchmod()
-
-.TP
+.TP 0.2i
\(bu
\fBchown\fR - VFS chown()
-
-.TP
+.TP 0.2i
\(bu
\fBfchown\fR - VFS fchown()
-
-.TP
+.TP 0.2i
\(bu
\fBchdir\fR - VFS chdir()
-
-.TP
+.TP 0.2i
\(bu
\fBgetwd\fR - VFS getwd()
-
-.TP
+.TP 0.2i
\(bu
\fButime\fR - VFS utime()
-
-.TP
+.TP 0.2i
\(bu
\fBftruncate\fR - VFS ftruncate()
-
-.TP
+.TP 0.2i
\(bu
\fBlock\fR - VFS lock()
-
-.TP
+.TP 0.2i
\(bu
\fBsymlink\fR - VFS symlink()
-
-.TP
+.TP 0.2i
\(bu
\fBreadlink\fR - VFS readlink()
-
-.TP
+.TP 0.2i
\(bu
\fBlink\fR - VFS link()
-
-.TP
+.TP 0.2i
\(bu
\fBmknod\fR - VFS mknod()
-
-.TP
+.TP 0.2i
\(bu
\fBrealpath\fR - VFS realpath()
-
-.LP
-
.PP
\fBGENERAL COMMANDS\fR
-
-.TP 3
+.TP 0.2i
\(bu
\fBconf <smb.conf>\fR - Load a different configuration file
-
-.TP
+.TP 0.2i
\(bu
\fBhelp [<command>]\fR - Get list of commands or info about specified command
-
-.TP
+.TP 0.2i
\(bu
\fBdebuglevel <level>\fR - Set debug level
-
-.TP
+.TP 0.2i
\(bu
\fBfreemem\fR - Free memory currently in use
-
-.TP
+.TP 0.2i
\(bu
\fBexit\fR - Exit vfstest
-
-.LP
-
.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\&.
-
+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 vfstest man page was written by Jelmer Vernooij.