docs/manpages/vfstest.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "VFSTEST" 1 "" "" ""
  21 .SH NAME
  22 vfstest \- tool for testing samba VFS modules
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 \fBvfstest\fR [-d debuglevel] [-c command] [-l logfile] [-h]
  27 .fi
  28
  29 .SH "DESCRIPTION"
  30
  31 .PP
  32 This tool is part of the \fBSamba\fR(7) suite\&.
  33
  34 .PP
  35 \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\&.
  36
  37 .SH "OPTIONS"
  38
  39 .TP
  40 -c|--command=command
  41 Execute the specified (colon-separated) commands\&. See below for the commands that are available\&.
  42
  43
  44 .TP
  45 -h|--help
  46 Print a summary of command line options\&.
  47
  48
  49 .TP
  50 -l|--logfile=logbasename
  51 File name for log/debug files\&. The extension \fB'\&.client'\fR will be appended\&. The log file is never removed by the client\&.
  52
  53
  54 .TP
  55 -V
  56 Prints the program version number\&.
  57
  58
  59 .TP
  60 -s <configuration file>
  61 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\&.
  62
  63
  64 .TP
  65 -d|--debug=debuglevel
  66 \fIdebuglevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
  67
  68
  69 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\&.
  70
  71
  72 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\&.
  73
  74
  75 Note that specifying this parameter here will override the \fIlog level\fR parameter in the \fIsmb\&.conf\fR file\&.
  76
  77
  78 .TP
  79 -l|--logfile=logbasename
  80 File name for log/debug files\&. The extension \fB"\&.client"\fR will be appended\&. The log file is never removed by the client\&.
  81
  82
  83 .SH "COMMANDS"
  84
  85 .PP
  86 \fBVFS COMMANDS\fR
  87
  88 .TP 3
  89 \(bu
  90 \fBload <module.so>\fR - Load specified VFS module
  91
  92 .TP
  93 \(bu
  94 \fBpopulate <char> <size>\fR - Populate a data buffer with the specified data
  95
  96 .TP
  97 \(bu
  98 \fBshowdata [<offset> <len>]\fR - Show data currently in data buffer
  99
 100 .TP
 101 \(bu
 102 \fBconnect\fR - VFS connect()
 103
 104 .TP
 105 \(bu
 106 \fBdisconnect\fR - VFS disconnect()
 107
 108 .TP
 109 \(bu
 110 \fBdisk_free\fR - VFS disk_free()
 111
 112 .TP
 113 \(bu
 114 \fBopendir\fR - VFS opendir()
 115
 116 .TP
 117 \(bu
 118 \fBreaddir\fR - VFS readdir()
 119
 120 .TP
 121 \(bu
 122 \fBmkdir\fR - VFS mkdir()
 123
 124 .TP
 125 \(bu
 126 \fBrmdir\fR - VFS rmdir()
 127
 128 .TP
 129 \(bu
 130 \fBclosedir\fR - VFS closedir()
 131
 132 .TP
 133 \(bu
 134 \fBopen\fR - VFS open()
 135
 136 .TP
 137 \(bu
 138 \fBclose\fR - VFS close()
 139
 140 .TP
 141 \(bu
 142 \fBread\fR - VFS read()
 143
 144 .TP
 145 \(bu
 146 \fBwrite\fR - VFS write()
 147
 148 .TP
 149 \(bu
 150 \fBlseek\fR - VFS lseek()
 151
 152 .TP
 153 \(bu
 154 \fBrename\fR - VFS rename()
 155
 156 .TP
 157 \(bu
 158 \fBfsync\fR - VFS fsync()
 159
 160 .TP
 161 \(bu
 162 \fBstat\fR - VFS stat()
 163
 164 .TP
 165 \(bu
 166 \fBfstat\fR - VFS fstat()
 167
 168 .TP
 169 \(bu
 170 \fBlstat\fR - VFS lstat()
 171
 172 .TP
 173 \(bu
 174 \fBunlink\fR - VFS unlink()
 175
 176 .TP
 177 \(bu
 178 \fBchmod\fR - VFS chmod()
 179
 180 .TP
 181 \(bu
 182 \fBfchmod\fR - VFS fchmod()
 183
 184 .TP
 185 \(bu
 186 \fBchown\fR - VFS chown()
 187
 188 .TP
 189 \(bu
 190 \fBfchown\fR - VFS fchown()
 191
 192 .TP
 193 \(bu
 194 \fBchdir\fR - VFS chdir()
 195
 196 .TP
 197 \(bu
 198 \fBgetwd\fR - VFS getwd()
 199
 200 .TP
 201 \(bu
 202 \fButime\fR - VFS utime()
 203
 204 .TP
 205 \(bu
 206 \fBftruncate\fR - VFS ftruncate()
 207
 208 .TP
 209 \(bu
 210 \fBlock\fR - VFS lock()
 211
 212 .TP
 213 \(bu
 214 \fBsymlink\fR - VFS symlink()
 215
 216 .TP
 217 \(bu
 218 \fBreadlink\fR - VFS readlink()
 219
 220 .TP
 221 \(bu
 222 \fBlink\fR - VFS link()
 223
 224 .TP
 225 \(bu
 226 \fBmknod\fR - VFS mknod()
 227
 228 .TP
 229 \(bu
 230 \fBrealpath\fR - VFS realpath()
 231
 232 .LP
 233
 234 .PP
 235 \fBGENERAL COMMANDS\fR
 236
 237 .TP 3
 238 \(bu
 239 \fBconf <smb.conf>\fR - Load a different configuration file
 240
 241 .TP
 242 \(bu
 243 \fBhelp [<command>]\fR - Get list of commands or info about specified command
 244
 245 .TP
 246 \(bu
 247 \fBdebuglevel <level>\fR - Set debug level
 248
 249 .TP
 250 \(bu
 251 \fBfreemem\fR - Free memory currently in use
 252
 253 .TP
 254 \(bu
 255 \fBexit\fR - Exit vfstest
 256
 257 .LP
 258
 259 .SH "VERSION"
 260
 261 .PP
 262 This man page is correct for version 3\&.0 of the Samba suite\&.
 263
 264 .SH "AUTHOR"
 265
 266 .PP
 267 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\&.
 268
 269 .PP
 270 The vfstest man page was written by Jelmer Vernooij\&.
 271