| blob | 75979242d07e2c2b6d3027b5f4588871cb756ce1 |
1 .\" Title: vfstest
2 .\" Author: [see the "AUTHOR" section]
3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
4 .\" Date: 09/30/2009
5 .\" Manual: User Commands
6 .\" Source: Samba 3.0
7 .\" Language: English
8 .\"
9 .TH "VFSTEST" "1" "09/30/2009" "Samba 3\&.0" "User Commands"
10 .\" -----------------------------------------------------------------
11 .\" * (re)Define some macros
12 .\" -----------------------------------------------------------------
13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 .\" toupper - uppercase a string (locale-aware)
15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16 .de toupper
17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
18 \\$*
19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
20 ..
21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" SH-xref - format a cross-reference to an SH section
23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24 .de SH-xref
25 .ie n \{\
26 .\}
27 .toupper \\$*
28 .el \{\
29 \\$*
30 .\}
31 ..
32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33 .\" SH - level-one heading that works better for non-TTY output
34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35 .de1 SH
36 .\" put an extra blank line of space above the head in non-TTY output
37 .if t \{\
38 .sp 1
39 .\}
40 .sp \\n[PD]u
41 .nr an-level 1
42 .set-an-margin
43 .nr an-prevailing-indent \\n[IN]
44 .fi
45 .in \\n[an-margin]u
46 .ti 0
47 .HTML-TAG ".NH \\n[an-level]"
48 .it 1 an-trap
49 .nr an-no-space-flag 1
50 .nr an-break-flag 1
51 \." make the size of the head bigger
52 .ps +3
53 .ft B
54 .ne (2v + 1u)
55 .ie n \{\
56 .\" if n (TTY output), use uppercase
57 .toupper \\$*
58 .\}
59 .el \{\
60 .nr an-break-flag 0
61 .\" if not n (not TTY), use normal case (not uppercase)
62 \\$1
63 .in \\n[an-margin]u
64 .ti 0
65 .\" if not n (not TTY), put a border/line under subheading
66 .sp -.6
67 \l'\n(.lu'
68 .\}
69 ..
70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71 .\" SS - level-two heading that works better for non-TTY output
72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73 .de1 SS
74 .sp \\n[PD]u
75 .nr an-level 1
76 .set-an-margin
77 .nr an-prevailing-indent \\n[IN]
78 .fi
79 .in \\n[IN]u
80 .ti \\n[SN]u
81 .it 1 an-trap
82 .nr an-no-space-flag 1
83 .nr an-break-flag 1
84 .ps \\n[PS-SS]u
85 \." make the size of the head bigger
86 .ps +2
87 .ft B
88 .ne (2v + 1u)
89 .if \\n[.$] \&\\$*
90 ..
91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92 .\" BB/BE - put background/screen (filled box) around block of text
93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94 .de BB
95 .if t \{\
96 .sp -.5
97 .br
98 .in +2n
99 .ll -2n
100 .gcolor red
101 .di BX
102 .\}
103 ..
104 .de EB
105 .if t \{\
106 .if "\\$2"adjust-for-leading-newline" \{\
107 .sp -1
108 .\}
109 .br
110 .di
111 .in
112 .ll
113 .gcolor
114 .nr BW \\n(.lu-\\n(.i
115 .nr BH \\n(dn+.5v
116 .ne \\n(BHu+.5v
117 .ie "\\$2"adjust-for-leading-newline" \{\
118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
119 .\}
120 .el \{\
121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
122 .\}
123 .in 0
124 .sp -.5v
125 .nf
126 .BX
127 .in
128 .sp .5v
129 .fi
130 .\}
131 ..
132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133 .\" BM/EM - put colored marker in margin next to block of text
134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135 .de BM
136 .if t \{\
137 .br
138 .ll -2n
139 .gcolor red
140 .di BX
141 .\}
142 ..
143 .de EM
144 .if t \{\
145 .br
146 .di
147 .ll
148 .gcolor
149 .nr BH \\n(dn
150 .ne \\n(BHu
151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
152 .in 0
153 .nf
154 .BX
155 .in
156 .fi
157 .\}
158 ..
159 .\" -----------------------------------------------------------------
160 .\" * set default formatting
161 .\" -----------------------------------------------------------------
162 .\" disable hyphenation
163 .nh
164 .\" disable justification (adjust text to left margin only)
165 .ad l
166 .\" -----------------------------------------------------------------
167 .\" * MAIN CONTENT STARTS HERE *
168 .\" -----------------------------------------------------------------
169 .SH "Name"
170 vfstest \- tool for testing samba VFS modules
171 .SH "Synopsis"
172 .fam C
173 .HP \w'\ 'u
174 \FCvfstest\F[] [\-d\ debuglevel] [\-c\ command] [\-l\ logdir] [\-h]
175 .fam
176 .SH "DESCRIPTION"
177 .PP
178 This tool is part of the
179 \fBsamba\fR(7)
180 suite\&.
181 .PP
182 \FCvfstest\F[]
183 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\&.
184 .SH "OPTIONS"
185 .PP
186 \-c|\-\-command=command
187 .RS 4
188 Execute the specified (colon\-separated) commands\&. See below for the commands that are available\&.
189 .RE
190 .PP
191 \-h|\-\-help
192 .RS 4
193 Print a summary of command line options\&.
194 .RE
195 .PP
196 \-l|\-\-logfile=logbasename
197 .RS 4
198 File name for log/debug files\&. The extension
199 \fB\'\&.client\'\fR
200 will be appended\&. The log file is never removed by the client\&.
201 .RE
202 .PP
203 \-d|\-\-debuglevel=level
204 .RS 4
205 \fIlevel\fR
206 is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&.
207 .sp
208 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\&.
209 .sp
210 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\&.
211 .sp
212 Note that specifying this parameter here will override the
213 \m[blue]\fBlog level\fR\m[]
214 parameter in the
215 \FCsmb\&.conf\F[]
216 file\&.
217 .RE
218 .PP
219 \-V
220 .RS 4
221 Prints the program version number\&.
222 .RE
223 .PP
224 \-s <configuration file>
225 .RS 4
226 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
227 \FCsmb\&.conf\F[]
228 for more information\&. The default configuration file name is determined at compile time\&.
229 .RE
230 .PP
231 \-l|\-\-log\-basename=logdirectory
232 .RS 4
233 Base directory name for log/debug files\&. The extension
234 \fB"\&.progname"\fR
235 will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
236 .RE
237 .SH "COMMANDS"
238 .PP
239 \fIVFS COMMANDS\fR
240 .sp
241 .RS 4
242 .ie n \{\
243 \h'-04'\(bu\h'+03'\c
244 .\}
245 .el \{\
246 .sp -1
247 .IP \(bu 2.3
248 .\}
249 \FCload <module\&.so>\F[]
250 \- Load specified VFS module
251 .RE
252 .sp
253 .RS 4
254 .ie n \{\
255 \h'-04'\(bu\h'+03'\c
256 .\}
257 .el \{\
258 .sp -1
259 .IP \(bu 2.3
260 .\}
261 \FCpopulate <char> <size>\F[]
262 \- Populate a data buffer with the specified data
263 .RE
264 .sp
265 .RS 4
266 .ie n \{\
267 \h'-04'\(bu\h'+03'\c
268 .\}
269 .el \{\
270 .sp -1
271 .IP \(bu 2.3
272 .\}
273 \FCshowdata [<offset> <len>]\F[]
274 \- Show data currently in data buffer
275 .RE
276 .sp
277 .RS 4
278 .ie n \{\
279 \h'-04'\(bu\h'+03'\c
280 .\}
281 .el \{\
282 .sp -1
283 .IP \(bu 2.3
284 .\}
285 \FCconnect\F[]
286 \- VFS connect()
287 .RE
288 .sp
289 .RS 4
290 .ie n \{\
291 \h'-04'\(bu\h'+03'\c
292 .\}
293 .el \{\
294 .sp -1
295 .IP \(bu 2.3
296 .\}
297 \FCdisconnect\F[]
298 \- VFS disconnect()
299 .RE
300 .sp
301 .RS 4
302 .ie n \{\
303 \h'-04'\(bu\h'+03'\c
304 .\}
305 .el \{\
306 .sp -1
307 .IP \(bu 2.3
308 .\}
309 \FCdisk_free\F[]
310 \- VFS disk_free()
311 .RE
312 .sp
313 .RS 4
314 .ie n \{\
315 \h'-04'\(bu\h'+03'\c
316 .\}
317 .el \{\
318 .sp -1
319 .IP \(bu 2.3
320 .\}
321 \FCopendir\F[]
322 \- VFS opendir()
323 .RE
324 .sp
325 .RS 4
326 .ie n \{\
327 \h'-04'\(bu\h'+03'\c
328 .\}
329 .el \{\
330 .sp -1
331 .IP \(bu 2.3
332 .\}
333 \FCreaddir\F[]
334 \- VFS readdir()
335 .RE
336 .sp
337 .RS 4
338 .ie n \{\
339 \h'-04'\(bu\h'+03'\c
340 .\}
341 .el \{\
342 .sp -1
343 .IP \(bu 2.3
344 .\}
345 \FCmkdir\F[]
346 \- VFS mkdir()
347 .RE
348 .sp
349 .RS 4
350 .ie n \{\
351 \h'-04'\(bu\h'+03'\c
352 .\}
353 .el \{\
354 .sp -1
355 .IP \(bu 2.3
356 .\}
357 \FCrmdir\F[]
358 \- VFS rmdir()
359 .RE
360 .sp
361 .RS 4
362 .ie n \{\
363 \h'-04'\(bu\h'+03'\c
364 .\}
365 .el \{\
366 .sp -1
367 .IP \(bu 2.3
368 .\}
369 \FCclosedir\F[]
370 \- VFS closedir()
371 .RE
372 .sp
373 .RS 4
374 .ie n \{\
375 \h'-04'\(bu\h'+03'\c
376 .\}
377 .el \{\
378 .sp -1
379 .IP \(bu 2.3
380 .\}
381 \FCopen\F[]
382 \- VFS open()
383 .RE
384 .sp
385 .RS 4
386 .ie n \{\
387 \h'-04'\(bu\h'+03'\c
388 .\}
389 .el \{\
390 .sp -1
391 .IP \(bu 2.3
392 .\}
393 \FCclose\F[]
394 \- VFS close()
395 .RE
396 .sp
397 .RS 4
398 .ie n \{\
399 \h'-04'\(bu\h'+03'\c
400 .\}
401 .el \{\
402 .sp -1
403 .IP \(bu 2.3
404 .\}
405 \FCread\F[]
406 \- VFS read()
407 .RE
408 .sp
409 .RS 4
410 .ie n \{\
411 \h'-04'\(bu\h'+03'\c
412 .\}
413 .el \{\
414 .sp -1
415 .IP \(bu 2.3
416 .\}
417 \FCwrite\F[]
418 \- VFS write()
419 .RE
420 .sp
421 .RS 4
422 .ie n \{\
423 \h'-04'\(bu\h'+03'\c
424 .\}
425 .el \{\
426 .sp -1
427 .IP \(bu 2.3
428 .\}
429 \FClseek\F[]
430 \- VFS lseek()
431 .RE
432 .sp
433 .RS 4
434 .ie n \{\
435 \h'-04'\(bu\h'+03'\c
436 .\}
437 .el \{\
438 .sp -1
439 .IP \(bu 2.3
440 .\}
441 \FCrename\F[]
442 \- VFS rename()
443 .RE
444 .sp
445 .RS 4
446 .ie n \{\
447 \h'-04'\(bu\h'+03'\c
448 .\}
449 .el \{\
450 .sp -1
451 .IP \(bu 2.3
452 .\}
453 \FCfsync\F[]
454 \- VFS fsync()
455 .RE
456 .sp
457 .RS 4
458 .ie n \{\
459 \h'-04'\(bu\h'+03'\c
460 .\}
461 .el \{\
462 .sp -1
463 .IP \(bu 2.3
464 .\}
465 \FCstat\F[]
466 \- VFS stat()
467 .RE
468 .sp
469 .RS 4
470 .ie n \{\
471 \h'-04'\(bu\h'+03'\c
472 .\}
473 .el \{\
474 .sp -1
475 .IP \(bu 2.3
476 .\}
477 \FCfstat\F[]
478 \- VFS fstat()
479 .RE
480 .sp
481 .RS 4
482 .ie n \{\
483 \h'-04'\(bu\h'+03'\c
484 .\}
485 .el \{\
486 .sp -1
487 .IP \(bu 2.3
488 .\}
489 \FClstat\F[]
490 \- VFS lstat()
491 .RE
492 .sp
493 .RS 4
494 .ie n \{\
495 \h'-04'\(bu\h'+03'\c
496 .\}
497 .el \{\
498 .sp -1
499 .IP \(bu 2.3
500 .\}
501 \FCunlink\F[]
502 \- VFS unlink()
503 .RE
504 .sp
505 .RS 4
506 .ie n \{\
507 \h'-04'\(bu\h'+03'\c
508 .\}
509 .el \{\
510 .sp -1
511 .IP \(bu 2.3
512 .\}
513 \FCchmod\F[]
514 \- VFS chmod()
515 .RE
516 .sp
517 .RS 4
518 .ie n \{\
519 \h'-04'\(bu\h'+03'\c
520 .\}
521 .el \{\
522 .sp -1
523 .IP \(bu 2.3
524 .\}
525 \FCfchmod\F[]
526 \- VFS fchmod()
527 .RE
528 .sp
529 .RS 4
530 .ie n \{\
531 \h'-04'\(bu\h'+03'\c
532 .\}
533 .el \{\
534 .sp -1
535 .IP \(bu 2.3
536 .\}
537 \FCchown\F[]
538 \- VFS chown()
539 .RE
540 .sp
541 .RS 4
542 .ie n \{\
543 \h'-04'\(bu\h'+03'\c
544 .\}
545 .el \{\
546 .sp -1
547 .IP \(bu 2.3
548 .\}
549 \FCfchown\F[]
550 \- VFS fchown()
551 .RE
552 .sp
553 .RS 4
554 .ie n \{\
555 \h'-04'\(bu\h'+03'\c
556 .\}
557 .el \{\
558 .sp -1
559 .IP \(bu 2.3
560 .\}
561 \FCchdir\F[]
562 \- VFS chdir()
563 .RE
564 .sp
565 .RS 4
566 .ie n \{\
567 \h'-04'\(bu\h'+03'\c
568 .\}
569 .el \{\
570 .sp -1
571 .IP \(bu 2.3
572 .\}
573 \FCgetwd\F[]
574 \- VFS getwd()
575 .RE
576 .sp
577 .RS 4
578 .ie n \{\
579 \h'-04'\(bu\h'+03'\c
580 .\}
581 .el \{\
582 .sp -1
583 .IP \(bu 2.3
584 .\}
585 \FCutime\F[]
586 \- VFS utime()
587 .RE
588 .sp
589 .RS 4
590 .ie n \{\
591 \h'-04'\(bu\h'+03'\c
592 .\}
593 .el \{\
594 .sp -1
595 .IP \(bu 2.3
596 .\}
597 \FCftruncate\F[]
598 \- VFS ftruncate()
599 .RE
600 .sp
601 .RS 4
602 .ie n \{\
603 \h'-04'\(bu\h'+03'\c
604 .\}
605 .el \{\
606 .sp -1
607 .IP \(bu 2.3
608 .\}
609 \FClock\F[]
610 \- VFS lock()
611 .RE
612 .sp
613 .RS 4
614 .ie n \{\
615 \h'-04'\(bu\h'+03'\c
616 .\}
617 .el \{\
618 .sp -1
619 .IP \(bu 2.3
620 .\}
621 \FCsymlink\F[]
622 \- VFS symlink()
623 .RE
624 .sp
625 .RS 4
626 .ie n \{\
627 \h'-04'\(bu\h'+03'\c
628 .\}
629 .el \{\
630 .sp -1
631 .IP \(bu 2.3
632 .\}
633 \FCreadlink\F[]
634 \- VFS readlink()
635 .RE
636 .sp
637 .RS 4
638 .ie n \{\
639 \h'-04'\(bu\h'+03'\c
640 .\}
641 .el \{\
642 .sp -1
643 .IP \(bu 2.3
644 .\}
645 \FClink\F[]
646 \- VFS link()
647 .RE
648 .sp
649 .RS 4
650 .ie n \{\
651 \h'-04'\(bu\h'+03'\c
652 .\}
653 .el \{\
654 .sp -1
655 .IP \(bu 2.3
656 .\}
657 \FCmknod\F[]
658 \- VFS mknod()
659 .RE
660 .sp
661 .RS 4
662 .ie n \{\
663 \h'-04'\(bu\h'+03'\c
664 .\}
665 .el \{\
666 .sp -1
667 .IP \(bu 2.3
668 .\}
669 \FCrealpath\F[]
670 \- VFS realpath()
671 .sp
672 .RE
673 .PP
674 \fIGENERAL COMMANDS\fR
675 .sp
676 .RS 4
677 .ie n \{\
678 \h'-04'\(bu\h'+03'\c
679 .\}
680 .el \{\
681 .sp -1
682 .IP \(bu 2.3
683 .\}
684 \FCconf <smb\&.conf>\F[]
685 \- Load a different configuration file
686 .RE
687 .sp
688 .RS 4
689 .ie n \{\
690 \h'-04'\(bu\h'+03'\c
691 .\}
692 .el \{\
693 .sp -1
694 .IP \(bu 2.3
695 .\}
696 \FChelp [<command>]\F[]
697 \- Get list of commands or info about specified command
698 .RE
699 .sp
700 .RS 4
701 .ie n \{\
702 \h'-04'\(bu\h'+03'\c
703 .\}
704 .el \{\
705 .sp -1
706 .IP \(bu 2.3
707 .\}
708 \FCdebuglevel <level>\F[]
709 \- Set debug level
710 .RE
711 .sp
712 .RS 4
713 .ie n \{\
714 \h'-04'\(bu\h'+03'\c
715 .\}
716 .el \{\
717 .sp -1
718 .IP \(bu 2.3
719 .\}
720 \FCfreemem\F[]
721 \- Free memory currently in use
722 .RE
723 .sp
724 .RS 4
725 .ie n \{\
726 \h'-04'\(bu\h'+03'\c
727 .\}
728 .el \{\
729 .sp -1
730 .IP \(bu 2.3
731 .\}
732 \FCexit\F[]
733 \- Exit vfstest
734 .SH "VERSION"
735 .PP
736 This man page is correct for version 3\&.0 of the Samba suite\&.
737 .SH "AUTHOR"
738 .PP
739 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\&.
740 .PP
741 The vfstest man page was written by Jelmer Vernooij\&.