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