Merge from Subversion
[samba.git] / docs / htmldocs / vfstest.1.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >vfstest</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.77+"></HEAD
9 ><BODY
10 CLASS="REFENTRY"
11 BGCOLOR="#FFFFFF"
12 TEXT="#000000"
13 LINK="#0000FF"
14 VLINK="#840084"
15 ALINK="#0000FF"
16 ><H1
17 ><A
18 NAME="VFSTEST.1"
19 ></A
20 >vfstest</H1
21 ><DIV
22 CLASS="REFNAMEDIV"
23 ><A
24 NAME="AEN5"
25 ></A
26 ><H2
27 >Name</H2
28 >vfstest&nbsp;--&nbsp;tool for testing samba VFS modules </DIV
29 ><DIV
30 CLASS="REFSYNOPSISDIV"
31 ><A
32 NAME="AEN8"
33 ></A
34 ><H2
35 >Synopsis</H2
36 ><P
37 ><B
38 CLASS="COMMAND"
39 >vfstest</B
40 >  [-d debuglevel] [-c command] [-l logfile] [-h]</P
41 ></DIV
42 ><DIV
43 CLASS="REFSECT1"
44 ><A
45 NAME="AEN15"
46 ></A
47 ><H2
48 >DESCRIPTION</H2
49 ><P
50 >This tool is part of the <SPAN
51 CLASS="CITEREFENTRY"
52 ><SPAN
53 CLASS="REFENTRYTITLE"
54 >Samba</SPAN
55 >(7)</SPAN
56 > suite.</P
57 ><P
58 ><B
59 CLASS="COMMAND"
60 >vfstest</B
61 > is a small command line
62         utility that has the ability to test dso samba VFS modules. It gives the
63         user the ability to call the various VFS functions manually and
64         supports cascaded VFS modules.
65         </P
66 ></DIV
67 ><DIV
68 CLASS="REFSECT1"
69 ><A
70 NAME="AEN23"
71 ></A
72 ><H2
73 >OPTIONS</H2
74 ><P
75 ></P
76 ><DIV
77 CLASS="VARIABLELIST"
78 ><DL
79 ><DT
80 >-c|--command=command</DT
81 ><DD
82 ><P
83 >Execute the specified (colon-separated) commands.
84                 See below for the commands that are available.
85                 </P
86 ></DD
87 ><DT
88 >-d|--debug=debuglevel</DT
89 ><DD
90 ><P
91 ><TT
92 CLASS="REPLACEABLE"
93 ><I
94 >debuglevel</I
95 ></TT
96 > is an integer 
97 from 0 to 10.  The default value if this parameter is 
98 not specified is zero.</P
99 ><P
100 >The higher this value, the more detail will be 
101 logged to the log files about the activities of the 
102 server. At level 0, only critical errors and serious 
103 warnings will be logged. Level 1 is a reasonable level for
104 day to day running - it generates a small amount of 
105 information about operations carried out.</P
106 ><P
107 >Levels above 1 will generate considerable 
108 amounts of log data, and should only be used when 
109 investigating a problem. Levels above 3 are designed for 
110 use only by developers and generate HUGE amounts of log
111 data, most of which is extremely cryptic.</P
112 ><P
113 >Note that specifying this parameter here will 
114 override the <A
115 HREF="smb.conf.5.html#loglevel"
116 TARGET="_top"
117 >log
118 level</A
119 > parameter in the <A
120 HREF="smb.conf.5.html"
121 TARGET="_top"
122 ><TT
123 CLASS="FILENAME"
124 >smb.conf(5)</TT
125 ></A
126 > file.</P
127 ></DD
128 ><DT
129 >-h|--help</DT
130 ><DD
131 ><P
132 >Print a summary of command line options.</P
133 ></DD
134 ><DT
135 >-l|--logfile=logbasename</DT
136 ><DD
137 ><P
138 >File name for log/debug files. The extension
139                 <TT
140 CLASS="CONSTANT"
141 >'.client'</TT
142 > will be appended. The log file is never removed
143                 by the client.
144                 </P
145 ></DD
146 ></DL
147 ></DIV
148 ></DIV
149 ><DIV
150 CLASS="REFSECT1"
151 ><A
152 NAME="AEN50"
153 ></A
154 ><H2
155 >COMMANDS</H2
156 ><P
157 ><SPAN
158 CLASS="emphasis"
159 ><I
160 CLASS="EMPHASIS"
161 >VFS COMMANDS</I
162 ></SPAN
163 ></P
164 ><P
165 ></P
166 ><UL
167 ><LI
168 ><P
169 ><B
170 CLASS="COMMAND"
171 >load &lt;module.so&gt;</B
172 > - Load specified VFS module </P
173 ></LI
174 ><LI
175 ><P
176 ><B
177 CLASS="COMMAND"
178 >populate &lt;char&gt; &lt;size&gt;</B
179 > - Populate a data buffer with the specified data
180                 </P
181 ></LI
182 ><LI
183 ><P
184 ><B
185 CLASS="COMMAND"
186 >showdata [&lt;offset&gt; &lt;len&gt;]</B
187 > - Show data currently in data buffer
188                 </P
189 ></LI
190 ><LI
191 ><P
192 ><B
193 CLASS="COMMAND"
194 >connect</B
195 > - VFS connect()</P
196 ></LI
197 ><LI
198 ><P
199 ><B
200 CLASS="COMMAND"
201 >disconnect</B
202 > - VFS disconnect()</P
203 ></LI
204 ><LI
205 ><P
206 ><B
207 CLASS="COMMAND"
208 >disk_free</B
209 > - VFS disk_free()</P
210 ></LI
211 ><LI
212 ><P
213 ><B
214 CLASS="COMMAND"
215 >opendir</B
216 > - VFS opendir()</P
217 ></LI
218 ><LI
219 ><P
220 ><B
221 CLASS="COMMAND"
222 >readdir</B
223 > - VFS readdir()</P
224 ></LI
225 ><LI
226 ><P
227 ><B
228 CLASS="COMMAND"
229 >mkdir</B
230 > - VFS mkdir()</P
231 ></LI
232 ><LI
233 ><P
234 ><B
235 CLASS="COMMAND"
236 >rmdir</B
237 > - VFS rmdir()</P
238 ></LI
239 ><LI
240 ><P
241 ><B
242 CLASS="COMMAND"
243 >closedir</B
244 > - VFS closedir()</P
245 ></LI
246 ><LI
247 ><P
248 ><B
249 CLASS="COMMAND"
250 >open</B
251 > - VFS open()</P
252 ></LI
253 ><LI
254 ><P
255 ><B
256 CLASS="COMMAND"
257 >close</B
258 > - VFS close()</P
259 ></LI
260 ><LI
261 ><P
262 ><B
263 CLASS="COMMAND"
264 >read</B
265 > - VFS read()</P
266 ></LI
267 ><LI
268 ><P
269 ><B
270 CLASS="COMMAND"
271 >write</B
272 > - VFS write()</P
273 ></LI
274 ><LI
275 ><P
276 ><B
277 CLASS="COMMAND"
278 >lseek</B
279 > - VFS lseek()</P
280 ></LI
281 ><LI
282 ><P
283 ><B
284 CLASS="COMMAND"
285 >rename</B
286 > - VFS rename()</P
287 ></LI
288 ><LI
289 ><P
290 ><B
291 CLASS="COMMAND"
292 >fsync</B
293 > - VFS fsync()</P
294 ></LI
295 ><LI
296 ><P
297 ><B
298 CLASS="COMMAND"
299 >stat</B
300 > - VFS stat()</P
301 ></LI
302 ><LI
303 ><P
304 ><B
305 CLASS="COMMAND"
306 >fstat</B
307 > - VFS fstat()</P
308 ></LI
309 ><LI
310 ><P
311 ><B
312 CLASS="COMMAND"
313 >lstat</B
314 > - VFS lstat()</P
315 ></LI
316 ><LI
317 ><P
318 ><B
319 CLASS="COMMAND"
320 >unlink</B
321 > - VFS unlink()</P
322 ></LI
323 ><LI
324 ><P
325 ><B
326 CLASS="COMMAND"
327 >chmod</B
328 > - VFS chmod()</P
329 ></LI
330 ><LI
331 ><P
332 ><B
333 CLASS="COMMAND"
334 >fchmod</B
335 > - VFS fchmod()</P
336 ></LI
337 ><LI
338 ><P
339 ><B
340 CLASS="COMMAND"
341 >chown</B
342 > - VFS chown()</P
343 ></LI
344 ><LI
345 ><P
346 ><B
347 CLASS="COMMAND"
348 >fchown</B
349 > - VFS fchown()</P
350 ></LI
351 ><LI
352 ><P
353 ><B
354 CLASS="COMMAND"
355 >chdir</B
356 > - VFS chdir()</P
357 ></LI
358 ><LI
359 ><P
360 ><B
361 CLASS="COMMAND"
362 >getwd</B
363 > - VFS getwd()</P
364 ></LI
365 ><LI
366 ><P
367 ><B
368 CLASS="COMMAND"
369 >utime</B
370 > - VFS utime()</P
371 ></LI
372 ><LI
373 ><P
374 ><B
375 CLASS="COMMAND"
376 >ftruncate</B
377 > - VFS ftruncate()</P
378 ></LI
379 ><LI
380 ><P
381 ><B
382 CLASS="COMMAND"
383 >lock</B
384 > - VFS lock()</P
385 ></LI
386 ><LI
387 ><P
388 ><B
389 CLASS="COMMAND"
390 >symlink</B
391 > - VFS symlink()</P
392 ></LI
393 ><LI
394 ><P
395 ><B
396 CLASS="COMMAND"
397 >readlink</B
398 > - VFS readlink()</P
399 ></LI
400 ><LI
401 ><P
402 ><B
403 CLASS="COMMAND"
404 >link</B
405 > - VFS link()</P
406 ></LI
407 ><LI
408 ><P
409 ><B
410 CLASS="COMMAND"
411 >mknod</B
412 > - VFS mknod()</P
413 ></LI
414 ><LI
415 ><P
416 ><B
417 CLASS="COMMAND"
418 >realpath</B
419 > - VFS realpath()</P
420 ></LI
421 ></UL
422 ><P
423 ><SPAN
424 CLASS="emphasis"
425 ><I
426 CLASS="EMPHASIS"
427 >GENERAL COMMANDS</I
428 ></SPAN
429 ></P
430 ><P
431 ></P
432 ><UL
433 ><LI
434 ><P
435 ><B
436 CLASS="COMMAND"
437 >conf &lt;smb.conf&gt;</B
438 > - Load a different configuration file</P
439 ></LI
440 ><LI
441 ><P
442 ><B
443 CLASS="COMMAND"
444 >help [&lt;command&gt;]</B
445 > - Get list of commands or info about specified command</P
446 ></LI
447 ><LI
448 ><P
449 ><B
450 CLASS="COMMAND"
451 >debuglevel &lt;level&gt;</B
452 > - Set debug level</P
453 ></LI
454 ><LI
455 ><P
456 ><B
457 CLASS="COMMAND"
458 >freemem</B
459 > - Free memory currently in use</P
460 ></LI
461 ><LI
462 ><P
463 ><B
464 CLASS="COMMAND"
465 >exit</B
466 > - Exit vfstest</P
467 ></LI
468 ></UL
469 ></DIV
470 ><DIV
471 CLASS="REFSECT1"
472 ><A
473 NAME="AEN181"
474 ></A
475 ><H2
476 >VERSION</H2
477 ><P
478 >This man page is correct for version 3.0 of the Samba
479         suite.</P
480 ></DIV
481 ><DIV
482 CLASS="REFSECT1"
483 ><A
484 NAME="AEN184"
485 ></A
486 ><H2
487 >AUTHOR</H2
488 ><P
489 >The original Samba software and related utilities
490         were created by Andrew Tridgell. Samba is now developed
491         by the Samba Team as an Open Source project similar
492         to the way the Linux kernel is developed.</P
493 ><P
494 >The vfstest man page was written by Jelmer Vernooij.</P
495 ></DIV
496 ></BODY
497 ></HTML
498 >