Initial import
[samba] / docs / manpages / vfstest.1
diff --git a/docs/manpages/vfstest.1 b/docs/manpages/vfstest.1
new file mode 100644 (file)
index 0000000..dd96db6
--- /dev/null
@@ -0,0 +1,222 @@
+.\"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 "" "" ""
+.SH NAME
+vfstest \- tool for testing samba VFS modules
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.HP 8
+\fBvfstest\fR [\-d\ debuglevel] [\-c\ command] [\-l\ logdir] [\-h]
+.ad
+.hy
+
+.SH "DESCRIPTION"
+
+.PP
+This tool is part of the \fBsamba\fR(7) 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\&.
+
+.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 program version number\&.
+
+.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 \fIsmb\&.conf\fR for more information\&. The default configuration file name is determined at compile time\&.
+
+.TP
+\-d|\-\-debuglevel=level
+\fIlevel\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  parameter in the \fIsmb\&.conf\fR file\&.
+
+.TP
+\-l|\-\-logfile=logdirectory
+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\&.
+
+.SH "COMMANDS"
+
+.PP
+\fBVFS COMMANDS\fR
+
+.TP 3
+\(bu
+\fBload <module\&.so>\fR \- Load specified VFS module
+.TP
+\(bu
+\fBpopulate <char> <size>\fR \- Populate a data buffer with the specified data
+.TP
+\(bu
+\fBshowdata [<offset> <len>]\fR \- Show data currently in data buffer
+.TP
+\(bu
+\fBconnect\fR \- VFS connect()
+.TP
+\(bu
+\fBdisconnect\fR \- VFS disconnect()
+.TP
+\(bu
+\fBdisk_free\fR \- VFS disk_free()
+.TP
+\(bu
+\fBopendir\fR \- VFS opendir()
+.TP
+\(bu
+\fBreaddir\fR \- VFS readdir()
+.TP
+\(bu
+\fBmkdir\fR \- VFS mkdir()
+.TP
+\(bu
+\fBrmdir\fR \- VFS rmdir()
+.TP
+\(bu
+\fBclosedir\fR \- VFS closedir()
+.TP
+\(bu
+\fBopen\fR \- VFS open()
+.TP
+\(bu
+\fBclose\fR \- VFS close()
+.TP
+\(bu
+\fBread\fR \- VFS read()
+.TP
+\(bu
+\fBwrite\fR \- VFS write()
+.TP
+\(bu
+\fBlseek\fR \- VFS lseek()
+.TP
+\(bu
+\fBrename\fR \- VFS rename()
+.TP
+\(bu
+\fBfsync\fR \- VFS fsync()
+.TP
+\(bu
+\fBstat\fR \- VFS stat()
+.TP
+\(bu
+\fBfstat\fR \- VFS fstat()
+.TP
+\(bu
+\fBlstat\fR \- VFS lstat()
+.TP
+\(bu
+\fBunlink\fR \- VFS unlink()
+.TP
+\(bu
+\fBchmod\fR \- VFS chmod()
+.TP
+\(bu
+\fBfchmod\fR \- VFS fchmod()
+.TP
+\(bu
+\fBchown\fR \- VFS chown()
+.TP
+\(bu
+\fBfchown\fR \- VFS fchown()
+.TP
+\(bu
+\fBchdir\fR \- VFS chdir()
+.TP
+\(bu
+\fBgetwd\fR \- VFS getwd()
+.TP
+\(bu
+\fButime\fR \- VFS utime()
+.TP
+\(bu
+\fBftruncate\fR \- VFS ftruncate()
+.TP
+\(bu
+\fBlock\fR \- VFS lock()
+.TP
+\(bu
+\fBsymlink\fR \- VFS symlink()
+.TP
+\(bu
+\fBreadlink\fR \- VFS readlink()
+.TP
+\(bu
+\fBlink\fR \- VFS link()
+.TP
+\(bu
+\fBmknod\fR \- VFS mknod()
+.TP
+\(bu
+\fBrealpath\fR \- VFS realpath()
+.LP
+
+.PP
+\fBGENERAL COMMANDS\fR
+
+.TP 3
+\(bu
+\fBconf <smb\&.conf>\fR \- Load a different configuration file
+.TP
+\(bu
+\fBhelp [<command>]\fR \- Get list of commands or info about specified command
+.TP
+\(bu
+\fBdebuglevel <level>\fR \- Set debug level
+.TP
+\(bu
+\fBfreemem\fR \- Free memory currently in use
+.TP
+\(bu
+\fBexit\fR \- Exit vfstest
+.LP
+
+.SH "VERSION"
+
+.PP
+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\&.
+