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

Last change on this file was 862, checked in by Silvan Scherrer, 11 years ago

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