source: branches/samba-3.0/docs/manpages/vfstest.1@ 125

.\"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"
.HP 1
vfstest [-d debuglevel] [-c command] [-l logdir] [-h]
.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.
.SH "OPTIONS"
.PP
-c|--command=command
.RS 3n
Execute the specified (colon-separated) commands. See below for the commands that are available.
.RE
.PP
-h|--help
.RS 3n
Print a summary of command line options.
.RE
.PP
-l|--logfile=logbasename
.RS 3n
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
-V
.RS 3n
Prints the program version number.
.RE
.PP
-s <configuration file>
.RS 3n
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.
.RE
.PP
-d|--debuglevel=level
.RS 3n
\fIlevel\fR
is an integer from 0 to 10. The default value if this parameter is not specified is zero.
.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

parameter in the
\fIsmb.conf\fR
file.
.RE
.PP
-l|--logfile=logdirectory
.RS 3n
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"
.PP
\fBVFS COMMANDS\fR
.TP 3n
\(bu
load <module.so>
- Load specified VFS module
.TP 3n
\(bu
populate <char> <size>
- Populate a data buffer with the specified data
.TP 3n
\(bu
showdata [<offset> <len>]
- Show data currently in data buffer
.TP 3n
\(bu
connect
- VFS connect()
.TP 3n
\(bu
disconnect
- VFS disconnect()
.TP 3n
\(bu
disk_free
- VFS disk_free()
.TP 3n
\(bu
opendir
- VFS opendir()
.TP 3n
\(bu
readdir
- VFS readdir()
.TP 3n
\(bu
mkdir
- VFS mkdir()
.TP 3n
\(bu
rmdir
- VFS rmdir()
.TP 3n
\(bu
closedir
- VFS closedir()
.TP 3n
\(bu
open
- VFS open()
.TP 3n
\(bu
close
- VFS close()
.TP 3n
\(bu
read
- VFS read()
.TP 3n
\(bu
write
- VFS write()
.TP 3n
\(bu
lseek
- VFS lseek()
.TP 3n
\(bu
rename
- VFS rename()
.TP 3n
\(bu
fsync
- VFS fsync()
.TP 3n
\(bu
stat
- VFS stat()
.TP 3n
\(bu
fstat
- VFS fstat()
.TP 3n
\(bu
lstat
- VFS lstat()
.TP 3n
\(bu
unlink
- VFS unlink()
.TP 3n
\(bu
chmod
- VFS chmod()
.TP 3n
\(bu
fchmod
- VFS fchmod()
.TP 3n
\(bu
chown
- VFS chown()
.TP 3n
\(bu
fchown
- VFS fchown()
.TP 3n
\(bu
chdir
- VFS chdir()
.TP 3n
\(bu
getwd
- VFS getwd()
.TP 3n
\(bu
utime
- VFS utime()
.TP 3n
\(bu
ftruncate
- VFS ftruncate()
.TP 3n
\(bu
lock
- VFS lock()
.TP 3n
\(bu
symlink
- VFS symlink()
.TP 3n
\(bu
readlink
- VFS readlink()
.TP 3n
\(bu
link
- VFS link()
.TP 3n
\(bu
mknod
- VFS mknod()
.TP 3n
\(bu
realpath
- VFS realpath()
.PP
\fBGENERAL COMMANDS\fR
.TP 3n
\(bu
conf <smb.conf>
- Load a different configuration file
.TP 3n
\(bu
help [<command>]
- Get list of commands or info about specified command
.TP 3n
\(bu
debuglevel <level>
- Set debug level
.TP 3n
\(bu
freemem
- Free memory currently in use
.TP 3n
\(bu
exit
- Exit vfstest
.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.