Initial import
[samba] / docs / manpages / vfstest.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "VFSTEST" 1 "" "" ""
21 .SH NAME
22 vfstest \- tool for testing samba VFS modules
23 .SH "SYNOPSIS"
24 .ad l
25 .hy 0
26 .HP 8
27 \fBvfstest\fR [\-d\ debuglevel] [\-c\ command] [\-l\ logdir] [\-h]
28 .ad
29 .hy
30
31 .SH "DESCRIPTION"
32
33 .PP
34 This tool is part of the \fBsamba\fR(7) suite\&.
35
36 .PP
37 \fBvfstest\fR 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\&.
38
39 .SH "OPTIONS"
40
41 .TP
42 \-c|\-\-command=command
43 Execute the specified (colon\-separated) commands\&. See below for the commands that are available\&.
44
45 .TP
46 \-h|\-\-help
47 Print a summary of command line options\&.
48
49 .TP
50 \-l|\-\-logfile=logbasename
51 File name for log/debug files\&. The extension\fB'\&.client'\fR will be appended\&. The log file is never removed by the client\&.
52
53 .TP
54 \-V
55 Prints the program version number\&.
56
57 .TP
58 \-s <configuration file>
59 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 \fIsmb\&.conf\fR for more information\&. The default configuration file name is determined at compile time\&.
60
61 .TP
62 \-d|\-\-debuglevel=level
63 \fIlevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
64
65 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\&.
66
67 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\&.
68
69 Note that specifying this parameter here will override the  parameter in the \fIsmb\&.conf\fR file\&.
70
71 .TP
72 \-l|\-\-logfile=logdirectory
73 Base directory name for log/debug files\&. The extension \fB"\&.progname"\fR will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
74
75 .SH "COMMANDS"
76
77 .PP
78 \fBVFS COMMANDS\fR
79
80 .TP 3
81 \(bu
82 \fBload <module\&.so>\fR \- Load specified VFS module
83 .TP
84 \(bu
85 \fBpopulate <char> <size>\fR \- Populate a data buffer with the specified data
86 .TP
87 \(bu
88 \fBshowdata [<offset> <len>]\fR \- Show data currently in data buffer
89 .TP
90 \(bu
91 \fBconnect\fR \- VFS connect()
92 .TP
93 \(bu
94 \fBdisconnect\fR \- VFS disconnect()
95 .TP
96 \(bu
97 \fBdisk_free\fR \- VFS disk_free()
98 .TP
99 \(bu
100 \fBopendir\fR \- VFS opendir()
101 .TP
102 \(bu
103 \fBreaddir\fR \- VFS readdir()
104 .TP
105 \(bu
106 \fBmkdir\fR \- VFS mkdir()
107 .TP
108 \(bu
109 \fBrmdir\fR \- VFS rmdir()
110 .TP
111 \(bu
112 \fBclosedir\fR \- VFS closedir()
113 .TP
114 \(bu
115 \fBopen\fR \- VFS open()
116 .TP
117 \(bu
118 \fBclose\fR \- VFS close()
119 .TP
120 \(bu
121 \fBread\fR \- VFS read()
122 .TP
123 \(bu
124 \fBwrite\fR \- VFS write()
125 .TP
126 \(bu
127 \fBlseek\fR \- VFS lseek()
128 .TP
129 \(bu
130 \fBrename\fR \- VFS rename()
131 .TP
132 \(bu
133 \fBfsync\fR \- VFS fsync()
134 .TP
135 \(bu
136 \fBstat\fR \- VFS stat()
137 .TP
138 \(bu
139 \fBfstat\fR \- VFS fstat()
140 .TP
141 \(bu
142 \fBlstat\fR \- VFS lstat()
143 .TP
144 \(bu
145 \fBunlink\fR \- VFS unlink()
146 .TP
147 \(bu
148 \fBchmod\fR \- VFS chmod()
149 .TP
150 \(bu
151 \fBfchmod\fR \- VFS fchmod()
152 .TP
153 \(bu
154 \fBchown\fR \- VFS chown()
155 .TP
156 \(bu
157 \fBfchown\fR \- VFS fchown()
158 .TP
159 \(bu
160 \fBchdir\fR \- VFS chdir()
161 .TP
162 \(bu
163 \fBgetwd\fR \- VFS getwd()
164 .TP
165 \(bu
166 \fButime\fR \- VFS utime()
167 .TP
168 \(bu
169 \fBftruncate\fR \- VFS ftruncate()
170 .TP
171 \(bu
172 \fBlock\fR \- VFS lock()
173 .TP
174 \(bu
175 \fBsymlink\fR \- VFS symlink()
176 .TP
177 \(bu
178 \fBreadlink\fR \- VFS readlink()
179 .TP
180 \(bu
181 \fBlink\fR \- VFS link()
182 .TP
183 \(bu
184 \fBmknod\fR \- VFS mknod()
185 .TP
186 \(bu
187 \fBrealpath\fR \- VFS realpath()
188 .LP
189
190 .PP
191 \fBGENERAL COMMANDS\fR
192
193 .TP 3
194 \(bu
195 \fBconf <smb\&.conf>\fR \- Load a different configuration file
196 .TP
197 \(bu
198 \fBhelp [<command>]\fR \- Get list of commands or info about specified command
199 .TP
200 \(bu
201 \fBdebuglevel <level>\fR \- Set debug level
202 .TP
203 \(bu
204 \fBfreemem\fR \- Free memory currently in use
205 .TP
206 \(bu
207 \fBexit\fR \- Exit vfstest
208 .LP
209
210 .SH "VERSION"
211
212 .PP
213 This man page is correct for version 3\&.0 of the Samba suite\&.
214
215 .SH "AUTHOR"
216
217 .PP
218 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\&.
219
220 .PP
221 The vfstest man page was written by Jelmer Vernooij\&.
222