docs/manpages/vfstest.1

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "VFSTEST" "1" "04 March 2003" "" ""
   7 .SH NAME
   8 vfstest \- tool for testing samba VFS modules
   9 .SH SYNOPSIS
  10
  11 \fBvfstest\fR [ \fB-d debuglevel\fR ] [ \fB-c command\fR ] [ \fB-l logfile\fR ] [ \fB-h\fR ]
  12
  13 .SH "DESCRIPTION"
  14 .PP
  15 This tool is part of the  Samba suite.
  16 .PP
  17 \fBvfstest\fR is a small command line
  18 utility that has the ability to test dso samba VFS modules. It gives the
  19 user the ability to call the various VFS functions manually and
  20 supports cascaded VFS modules.
  21 .SH "OPTIONS"
  22 .TP
  23 \fB-c|--command=command\fR
  24 Execute the specified (colon-separated) commands.
  25 See below for the commands that are available.
  26 .TP
  27 \fB-d|--debug=debuglevel\fR
  28 \fIdebuglevel\fR is an integer
  29 from 0 to 10.  The default value if this parameter is
  30 not specified is zero.
  31
  32 The higher this value, the more detail will be
  33 logged to the log files about the activities of the
  34 server. At level 0, only critical errors and serious
  35 warnings will be logged. Level 1 is a reasonable level for
  36 day to day running - it generates a small amount of
  37 information about operations carried out.
  38
  39 Levels above 1 will generate considerable
  40 amounts of log data, and should only be used when
  41 investigating a problem. Levels above 3 are designed for
  42 use only by developers and generate HUGE amounts of log
  43 data, most of which is extremely cryptic.
  44
  45 Note that specifying this parameter here will
  46 override the log
  47 level file.
  48 .TP
  49 \fB-h|--help\fR
  50 Print a summary of command line options.
  51 .TP
  52 \fB-l|--logfile=logbasename\fR
  53 File name for log/debug files. The extension
  54 \&'.client' will be appended. The log file is never removed
  55 by the client.
  56 .SH "COMMANDS"
  57 .PP
  58 \fBVFS COMMANDS\fR
  59 .TP 0.2i
  60 \(bu
  61 \fBload <module.so>\fR - Load specified VFS module
  62 .TP 0.2i
  63 \(bu
  64 \fBpopulate <char> <size>\fR - Populate a data buffer with the specified data
  65 .TP 0.2i
  66 \(bu
  67 \fBshowdata [<offset> <len>]\fR - Show data currently in data buffer
  68 .TP 0.2i
  69 \(bu
  70 \fBconnect\fR - VFS connect()
  71 .TP 0.2i
  72 \(bu
  73 \fBdisconnect\fR - VFS disconnect()
  74 .TP 0.2i
  75 \(bu
  76 \fBdisk_free\fR - VFS disk_free()
  77 .TP 0.2i
  78 \(bu
  79 \fBopendir\fR - VFS opendir()
  80 .TP 0.2i
  81 \(bu
  82 \fBreaddir\fR - VFS readdir()
  83 .TP 0.2i
  84 \(bu
  85 \fBmkdir\fR - VFS mkdir()
  86 .TP 0.2i
  87 \(bu
  88 \fBrmdir\fR - VFS rmdir()
  89 .TP 0.2i
  90 \(bu
  91 \fBclosedir\fR - VFS closedir()
  92 .TP 0.2i
  93 \(bu
  94 \fBopen\fR - VFS open()
  95 .TP 0.2i
  96 \(bu
  97 \fBclose\fR - VFS close()
  98 .TP 0.2i
  99 \(bu
 100 \fBread\fR - VFS read()
 101 .TP 0.2i
 102 \(bu
 103 \fBwrite\fR - VFS write()
 104 .TP 0.2i
 105 \(bu
 106 \fBlseek\fR - VFS lseek()
 107 .TP 0.2i
 108 \(bu
 109 \fBrename\fR - VFS rename()
 110 .TP 0.2i
 111 \(bu
 112 \fBfsync\fR - VFS fsync()
 113 .TP 0.2i
 114 \(bu
 115 \fBstat\fR - VFS stat()
 116 .TP 0.2i
 117 \(bu
 118 \fBfstat\fR - VFS fstat()
 119 .TP 0.2i
 120 \(bu
 121 \fBlstat\fR - VFS lstat()
 122 .TP 0.2i
 123 \(bu
 124 \fBunlink\fR - VFS unlink()
 125 .TP 0.2i
 126 \(bu
 127 \fBchmod\fR - VFS chmod()
 128 .TP 0.2i
 129 \(bu
 130 \fBfchmod\fR - VFS fchmod()
 131 .TP 0.2i
 132 \(bu
 133 \fBchown\fR - VFS chown()
 134 .TP 0.2i
 135 \(bu
 136 \fBfchown\fR - VFS fchown()
 137 .TP 0.2i
 138 \(bu
 139 \fBchdir\fR - VFS chdir()
 140 .TP 0.2i
 141 \(bu
 142 \fBgetwd\fR - VFS getwd()
 143 .TP 0.2i
 144 \(bu
 145 \fButime\fR - VFS utime()
 146 .TP 0.2i
 147 \(bu
 148 \fBftruncate\fR - VFS ftruncate()
 149 .TP 0.2i
 150 \(bu
 151 \fBlock\fR - VFS lock()
 152 .TP 0.2i
 153 \(bu
 154 \fBsymlink\fR - VFS symlink()
 155 .TP 0.2i
 156 \(bu
 157 \fBreadlink\fR - VFS readlink()
 158 .TP 0.2i
 159 \(bu
 160 \fBlink\fR - VFS link()
 161 .TP 0.2i
 162 \(bu
 163 \fBmknod\fR - VFS mknod()
 164 .TP 0.2i
 165 \(bu
 166 \fBrealpath\fR - VFS realpath()
 167 .PP
 168 \fBGENERAL COMMANDS\fR
 169 .TP 0.2i
 170 \(bu
 171 \fBconf <smb.conf>\fR - Load a different configuration file
 172 .TP 0.2i
 173 \(bu
 174 \fBhelp [<command>]\fR - Get list of commands or info about specified command
 175 .TP 0.2i
 176 \(bu
 177 \fBdebuglevel <level>\fR - Set debug level
 178 .TP 0.2i
 179 \(bu
 180 \fBfreemem\fR - Free memory currently in use
 181 .TP 0.2i
 182 \(bu
 183 \fBexit\fR - Exit vfstest
 184 .SH "VERSION"
 185 .PP
 186 This man page is correct for version 3.0 of the Samba
 187 suite.
 188 .SH "AUTHOR"
 189 .PP
 190 The original Samba software and related utilities
 191 were created by Andrew Tridgell. Samba is now developed
 192 by the Samba Team as an Open Source project similar
 193 to the way the Linux kernel is developed.
 194 .PP
 195 The vfstest man page was written by Jelmer Vernooij.