summaryrefslogtreecommitdiff
path: root/docs/manpages/vfstest.1
blob: 20566ee143dc171de2b3fbdcc7bbaa87a1d16e1d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
.\"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"

.nf
\fBvfstest\fR [-d debuglevel] [-c command] [-l logfile] [-h]
.fi

.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|--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 \fIlog level\fR parameter in the \fIsmb\&.conf\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\&.


.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\&.