source: branches/samba-3.2.x/docs/manpages/vfstest.1@ 225

Last change on this file since 225 was 225, checked in by Herwig Bauernfeind, 16 years ago

Update 3.2 branch to 3.2.6 docs manpages
File size: 8.0 KB
Line 
1.\" Title: vfstest
2.\" Author:
3.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
4.\" Date: 12/10/2008
5.\" Manual: User Commands
6.\" Source: Samba 3.2
7.\"
8.TH "VFSTEST" "1" "12/10/2008" "Samba 3\.2" "User Commands"
9.\" disable hyphenation
10.nh
11.\" disable justification (adjust text to left margin only)
12.ad l
13.SH "NAME"
14vfstest - tool for testing samba VFS modules
15.SH "SYNOPSIS"
16.HP 1
17vfstest [\-d\ debuglevel] [\-c\ command] [\-l\ logdir] [\-h]
18.SH "DESCRIPTION"
19.PP
20This tool is part of the
21\fBsamba\fR(7)
22suite\.
23.PP
24vfstest
25is 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\.
26.SH "OPTIONS"
27.PP
28\-c|\-\-command=command
29.RS 4
30Execute the specified (colon\-separated) commands\. See below for the commands that are available\.
31.RE
32.PP
33\-h|\-\-help
34.RS 4
35Print a summary of command line options\.
36.RE
37.PP
38\-l|\-\-logfile=logbasename
39.RS 4
40File name for log/debug files\. The extension
41\fB\'\.client\'\fR
42will be appended\. The log file is never removed by the client\.
43.RE
44.PP
45\-d|\-\-debuglevel=level
46.RS 4
47\fIlevel\fR
48is an integer from 0 to 10\. The default value if this parameter is not specified is 0\.
49.sp
50The 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\.
51.sp
52Levels 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\.
53.sp
54Note that specifying this parameter here will override the
55\fIlog level\fR
56parameter in the
57\fIsmb\.conf\fR
58file\.
59.RE
60.PP
61\-V
62.RS 4
63Prints the program version number\.
64.RE
65.PP
66\-s <configuration file>
67.RS 4
68The 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
69\fIsmb\.conf\fR
70for more information\. The default configuration file name is determined at compile time\.
71.RE
72.PP
73\-l|\-\-log\-basename=logdirectory
74.RS 4
75Base directory name for log/debug files\. The extension
76\fB"\.progname"\fR
77will be appended (e\.g\. log\.smbclient, log\.smbd, etc\.\.\.)\. The log file is never removed by the client\.
78.RE
79.SH "COMMANDS"
80.PP
81\fIVFS COMMANDS\fR
82.sp
83.RS 4
84.ie n \{\
85\h'-04'\(bu\h'+03'\c
86.\}
87.el \{\
88.sp -1
89.IP \(bu 2.3
90.\}
91load <module\.so>
92\- Load specified VFS module
93.RE
94.sp
95.RS 4
96.ie n \{\
97\h'-04'\(bu\h'+03'\c
98.\}
99.el \{\
100.sp -1
101.IP \(bu 2.3
102.\}
103populate <char> <size>
104\- Populate a data buffer with the specified data
105.RE
106.sp
107.RS 4
108.ie n \{\
109\h'-04'\(bu\h'+03'\c
110.\}
111.el \{\
112.sp -1
113.IP \(bu 2.3
114.\}
115showdata [<offset> <len>]
116\- Show data currently in data buffer
117.RE
118.sp
119.RS 4
120.ie n \{\
121\h'-04'\(bu\h'+03'\c
122.\}
123.el \{\
124.sp -1
125.IP \(bu 2.3
126.\}
127connect
128\- VFS connect()
129.RE
130.sp
131.RS 4
132.ie n \{\
133\h'-04'\(bu\h'+03'\c
134.\}
135.el \{\
136.sp -1
137.IP \(bu 2.3
138.\}
139disconnect
140\- VFS disconnect()
141.RE
142.sp
143.RS 4
144.ie n \{\
145\h'-04'\(bu\h'+03'\c
146.\}
147.el \{\
148.sp -1
149.IP \(bu 2.3
150.\}
151disk_free
152\- VFS disk_free()
153.RE
154.sp
155.RS 4
156.ie n \{\
157\h'-04'\(bu\h'+03'\c
158.\}
159.el \{\
160.sp -1
161.IP \(bu 2.3
162.\}
163opendir
164\- VFS opendir()
165.RE
166.sp
167.RS 4
168.ie n \{\
169\h'-04'\(bu\h'+03'\c
170.\}
171.el \{\
172.sp -1
173.IP \(bu 2.3
174.\}
175readdir
176\- VFS readdir()
177.RE
178.sp
179.RS 4
180.ie n \{\
181\h'-04'\(bu\h'+03'\c
182.\}
183.el \{\
184.sp -1
185.IP \(bu 2.3
186.\}
187mkdir
188\- VFS mkdir()
189.RE
190.sp
191.RS 4
192.ie n \{\
193\h'-04'\(bu\h'+03'\c
194.\}
195.el \{\
196.sp -1
197.IP \(bu 2.3
198.\}
199rmdir
200\- VFS rmdir()
201.RE
202.sp
203.RS 4
204.ie n \{\
205\h'-04'\(bu\h'+03'\c
206.\}
207.el \{\
208.sp -1
209.IP \(bu 2.3
210.\}
211closedir
212\- VFS closedir()
213.RE
214.sp
215.RS 4
216.ie n \{\
217\h'-04'\(bu\h'+03'\c
218.\}
219.el \{\
220.sp -1
221.IP \(bu 2.3
222.\}
223open
224\- VFS open()
225.RE
226.sp
227.RS 4
228.ie n \{\
229\h'-04'\(bu\h'+03'\c
230.\}
231.el \{\
232.sp -1
233.IP \(bu 2.3
234.\}
235close
236\- VFS close()
237.RE
238.sp
239.RS 4
240.ie n \{\
241\h'-04'\(bu\h'+03'\c
242.\}
243.el \{\
244.sp -1
245.IP \(bu 2.3
246.\}
247read
248\- VFS read()
249.RE
250.sp
251.RS 4
252.ie n \{\
253\h'-04'\(bu\h'+03'\c
254.\}
255.el \{\
256.sp -1
257.IP \(bu 2.3
258.\}
259write
260\- VFS write()
261.RE
262.sp
263.RS 4
264.ie n \{\
265\h'-04'\(bu\h'+03'\c
266.\}
267.el \{\
268.sp -1
269.IP \(bu 2.3
270.\}
271lseek
272\- VFS lseek()
273.RE
274.sp
275.RS 4
276.ie n \{\
277\h'-04'\(bu\h'+03'\c
278.\}
279.el \{\
280.sp -1
281.IP \(bu 2.3
282.\}
283rename
284\- VFS rename()
285.RE
286.sp
287.RS 4
288.ie n \{\
289\h'-04'\(bu\h'+03'\c
290.\}
291.el \{\
292.sp -1
293.IP \(bu 2.3
294.\}
295fsync
296\- VFS fsync()
297.RE
298.sp
299.RS 4
300.ie n \{\
301\h'-04'\(bu\h'+03'\c
302.\}
303.el \{\
304.sp -1
305.IP \(bu 2.3
306.\}
307stat
308\- VFS stat()
309.RE
310.sp
311.RS 4
312.ie n \{\
313\h'-04'\(bu\h'+03'\c
314.\}
315.el \{\
316.sp -1
317.IP \(bu 2.3
318.\}
319fstat
320\- VFS fstat()
321.RE
322.sp
323.RS 4
324.ie n \{\
325\h'-04'\(bu\h'+03'\c
326.\}
327.el \{\
328.sp -1
329.IP \(bu 2.3
330.\}
331lstat
332\- VFS lstat()
333.RE
334.sp
335.RS 4
336.ie n \{\
337\h'-04'\(bu\h'+03'\c
338.\}
339.el \{\
340.sp -1
341.IP \(bu 2.3
342.\}
343unlink
344\- VFS unlink()
345.RE
346.sp
347.RS 4
348.ie n \{\
349\h'-04'\(bu\h'+03'\c
350.\}
351.el \{\
352.sp -1
353.IP \(bu 2.3
354.\}
355chmod
356\- VFS chmod()
357.RE
358.sp
359.RS 4
360.ie n \{\
361\h'-04'\(bu\h'+03'\c
362.\}
363.el \{\
364.sp -1
365.IP \(bu 2.3
366.\}
367fchmod
368\- VFS fchmod()
369.RE
370.sp
371.RS 4
372.ie n \{\
373\h'-04'\(bu\h'+03'\c
374.\}
375.el \{\
376.sp -1
377.IP \(bu 2.3
378.\}
379chown
380\- VFS chown()
381.RE
382.sp
383.RS 4
384.ie n \{\
385\h'-04'\(bu\h'+03'\c
386.\}
387.el \{\
388.sp -1
389.IP \(bu 2.3
390.\}
391fchown
392\- VFS fchown()
393.RE
394.sp
395.RS 4
396.ie n \{\
397\h'-04'\(bu\h'+03'\c
398.\}
399.el \{\
400.sp -1
401.IP \(bu 2.3
402.\}
403chdir
404\- VFS chdir()
405.RE
406.sp
407.RS 4
408.ie n \{\
409\h'-04'\(bu\h'+03'\c
410.\}
411.el \{\
412.sp -1
413.IP \(bu 2.3
414.\}
415getwd
416\- VFS getwd()
417.RE
418.sp
419.RS 4
420.ie n \{\
421\h'-04'\(bu\h'+03'\c
422.\}
423.el \{\
424.sp -1
425.IP \(bu 2.3
426.\}
427utime
428\- VFS utime()
429.RE
430.sp
431.RS 4
432.ie n \{\
433\h'-04'\(bu\h'+03'\c
434.\}
435.el \{\
436.sp -1
437.IP \(bu 2.3
438.\}
439ftruncate
440\- VFS ftruncate()
441.RE
442.sp
443.RS 4
444.ie n \{\
445\h'-04'\(bu\h'+03'\c
446.\}
447.el \{\
448.sp -1
449.IP \(bu 2.3
450.\}
451lock
452\- VFS lock()
453.RE
454.sp
455.RS 4
456.ie n \{\
457\h'-04'\(bu\h'+03'\c
458.\}
459.el \{\
460.sp -1
461.IP \(bu 2.3
462.\}
463symlink
464\- VFS symlink()
465.RE
466.sp
467.RS 4
468.ie n \{\
469\h'-04'\(bu\h'+03'\c
470.\}
471.el \{\
472.sp -1
473.IP \(bu 2.3
474.\}
475readlink
476\- VFS readlink()
477.RE
478.sp
479.RS 4
480.ie n \{\
481\h'-04'\(bu\h'+03'\c
482.\}
483.el \{\
484.sp -1
485.IP \(bu 2.3
486.\}
487link
488\- VFS link()
489.RE
490.sp
491.RS 4
492.ie n \{\
493\h'-04'\(bu\h'+03'\c
494.\}
495.el \{\
496.sp -1
497.IP \(bu 2.3
498.\}
499mknod
500\- VFS mknod()
501.RE
502.sp
503.RS 4
504.ie n \{\
505\h'-04'\(bu\h'+03'\c
506.\}
507.el \{\
508.sp -1
509.IP \(bu 2.3
510.\}
511realpath
512\- VFS realpath()
513.sp
514.RE
515.PP
516\fIGENERAL COMMANDS\fR
517.sp
518.RS 4
519.ie n \{\
520\h'-04'\(bu\h'+03'\c
521.\}
522.el \{\
523.sp -1
524.IP \(bu 2.3
525.\}
526conf <smb\.conf>
527\- Load a different configuration file
528.RE
529.sp
530.RS 4
531.ie n \{\
532\h'-04'\(bu\h'+03'\c
533.\}
534.el \{\
535.sp -1
536.IP \(bu 2.3
537.\}
538help [<command>]
539\- Get list of commands or info about specified command
540.RE
541.sp
542.RS 4
543.ie n \{\
544\h'-04'\(bu\h'+03'\c
545.\}
546.el \{\
547.sp -1
548.IP \(bu 2.3
549.\}
550debuglevel <level>
551\- Set debug level
552.RE
553.sp
554.RS 4
555.ie n \{\
556\h'-04'\(bu\h'+03'\c
557.\}
558.el \{\
559.sp -1
560.IP \(bu 2.3
561.\}
562freemem
563\- Free memory currently in use
564.RE
565.sp
566.RS 4
567.ie n \{\
568\h'-04'\(bu\h'+03'\c
569.\}
570.el \{\
571.sp -1
572.IP \(bu 2.3
573.\}
574exit
575\- Exit vfstest
576.SH "VERSION"
577.PP
578This man page is correct for version 3 of the Samba suite\.
579.SH "AUTHOR"
580.PP
581The 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\.
582.PP
583The vfstest man page was written by Jelmer Vernooij\.
Note: See TracBrowser for help on using the repository browser.