This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.
[kai/samba.git] / docs / manpages / vfstest.1
1 .\" This manpage has been automatically generated by docbook2man 
2 .\" from a DocBook document.  This tool can be found at:
3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "VFSTEST" "1" "26 November 2002" "" ""
7 .SH NAME
8 vfstest \- tool for testing samba VFS modules
9 .SH SYNOPSIS
10
11 \fBvfstest\fR [ \fB-d debuglevel\fR ] [ \fB-c command\fR ] [ \fB-l logfile\fR ] [ \fB-h\fR ]
12
13 .SH "DESCRIPTION"
14 .PP
15 This tool is part of the  Samba suite.
16 .PP
17 \fBvfstest\fR is a small command line
18 utility that has the ability to test dso samba VFS modules. It gives the
19 user the ability to call the various VFS functions manually and
20 supports cascaded VFS modules.
21 .SH "OPTIONS"
22 .TP
23 \fB-c|--command=command\fR
24 Execute the specified (colon-separated) commands.
25 See below for the commands that are available.
26 .TP
27 \fB-l|--logfile=logbasename\fR
28 File name for log/debug files. The extension
29 \&'.client' will be appended. The log file is never removed
30 by the client.
31 .SH "COMMANDS"
32 .PP
33 \fBVFS COMMANDS\fR
34 .TP 0.2i
35 \(bu
36 \fBload <module.so>\fR - Load specified VFS module 
37 .TP 0.2i
38 \(bu
39 \fBpopulate <char> <size>\fR - Populate a data buffer with the specified data
40 .TP 0.2i
41 \(bu
42 \fBshowdata [<offset> <len>]\fR - Show data currently in data buffer
43 .TP 0.2i
44 \(bu
45 \fBconnect\fR - VFS connect()
46 .TP 0.2i
47 \(bu
48 \fBdisconnect\fR - VFS disconnect()
49 .TP 0.2i
50 \(bu
51 \fBdisk_free\fR - VFS disk_free()
52 .TP 0.2i
53 \(bu
54 \fBopendir\fR - VFS opendir()
55 .TP 0.2i
56 \(bu
57 \fBreaddir\fR - VFS readdir()
58 .TP 0.2i
59 \(bu
60 \fBmkdir\fR - VFS mkdir()
61 .TP 0.2i
62 \(bu
63 \fBrmdir\fR - VFS rmdir()
64 .TP 0.2i
65 \(bu
66 \fBclosedir\fR - VFS closedir()
67 .TP 0.2i
68 \(bu
69 \fBopen\fR - VFS open()
70 .TP 0.2i
71 \(bu
72 \fBclose\fR - VFS close()
73 .TP 0.2i
74 \(bu
75 \fBread\fR - VFS read()
76 .TP 0.2i
77 \(bu
78 \fBwrite\fR - VFS write()
79 .TP 0.2i
80 \(bu
81 \fBlseek\fR - VFS lseek()
82 .TP 0.2i
83 \(bu
84 \fBrename\fR - VFS rename()
85 .TP 0.2i
86 \(bu
87 \fBfsync\fR - VFS fsync()
88 .TP 0.2i
89 \(bu
90 \fBstat\fR - VFS stat()
91 .TP 0.2i
92 \(bu
93 \fBfstat\fR - VFS fstat()
94 .TP 0.2i
95 \(bu
96 \fBlstat\fR - VFS lstat()
97 .TP 0.2i
98 \(bu
99 \fBunlink\fR - VFS unlink()
100 .TP 0.2i
101 \(bu
102 \fBchmod\fR - VFS chmod()
103 .TP 0.2i
104 \(bu
105 \fBfchmod\fR - VFS fchmod()
106 .TP 0.2i
107 \(bu
108 \fBchown\fR - VFS chown()
109 .TP 0.2i
110 \(bu
111 \fBfchown\fR - VFS fchown()
112 .TP 0.2i
113 \(bu
114 \fBchdir\fR - VFS chdir()
115 .TP 0.2i
116 \(bu
117 \fBgetwd\fR - VFS getwd()
118 .TP 0.2i
119 \(bu
120 \fButime\fR - VFS utime()
121 .TP 0.2i
122 \(bu
123 \fBftruncate\fR - VFS ftruncate()
124 .TP 0.2i
125 \(bu
126 \fBlock\fR - VFS lock()
127 .TP 0.2i
128 \(bu
129 \fBsymlink\fR - VFS symlink()
130 .TP 0.2i
131 \(bu
132 \fBreadlink\fR - VFS readlink()
133 .TP 0.2i
134 \(bu
135 \fBlink\fR - VFS link()
136 .TP 0.2i
137 \(bu
138 \fBmknod\fR - VFS mknod()
139 .TP 0.2i
140 \(bu
141 \fBrealpath\fR - VFS realpath()
142 .PP
143 \fBGENERAL COMMANDS\fR
144 .TP 0.2i
145 \(bu
146 \fBconf <smb.conf>\fR - Load a different configuration file
147 .TP 0.2i
148 \(bu
149 \fBhelp [<command>]\fR - Get list of commands or info about specified command
150 .TP 0.2i
151 \(bu
152 \fBdebuglevel <level>\fR - Set debug level
153 .TP 0.2i
154 \(bu
155 \fBfreemem\fR - Free memory currently in use
156 .TP 0.2i
157 \(bu
158 \fBexit\fR - Exit vfstest
159 .SH "VERSION"
160 .PP
161 This man page is correct for version 3.0 of the Samba
162 suite.
163 .SH "AUTHOR"
164 .PP
165 The original Samba software and related utilities
166 were created by Andrew Tridgell. Samba is now developed
167 by the Samba Team as an Open Source project similar
168 to the way the Linux kernel is developed.
169 .PP
170 The vfstest man page was written by Jelmer Vernooij.