source: trunk/server/docs/manpages/vfstest.1@ 759

Last change on this file since 759 was 752, checked in by Silvan Scherrer, 13 years ago

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