summaryrefslogtreecommitdiff
path: root/docs/manpages/vfstest.1
blob: c4958e3dd44b1d2073575f736a61e04015e2b369 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "VFSTEST" "1" "05 November 2002" "" ""
.SH NAME
vfstest \- tool for testing samba VFS modules
.SH SYNOPSIS

\fBvfstest\fR [ \fB-d debuglevel\fR ] [ \fB-c command\fR ] [ \fB-l logfile\fR ] [ \fB-h\fR ]

.SH "DESCRIPTION"
.PP
This tool is part of the  Samba suite.
.PP
\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.
.SH "OPTIONS"
.TP
\fB-c|--command=command\fR
Execute the specified (colon-seperated) commands.
See below for the commands that are available.
.TP
\fB-d|--debug=debuglevel\fR
\fIdebuglevel\fR is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.

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.

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.

Note that specifying this parameter here will 
override the log
level file.
.TP
\fB-h|--help\fR
Print a summary of command line options.
.TP
\fB-l|--logfile=logbasename\fR
File name for log/debug files. The extension
\&'.client' will be appended. The log file is never removed
by the client.
.SH "COMMANDS"
.PP
\fBVFS COMMANDS\fR
.TP 0.2i
\(bu
\fBload <module.so>\fR - Load specified VFS module 
.TP 0.2i
\(bu
\fBpopulate <char> <size>\fR - Populate a data buffer with the specified data
.TP 0.2i
\(bu
\fBshowdata [<offset> <len>]\fR - Show data currently in data buffer
.TP 0.2i
\(bu
\fBconnect\fR - VFS connect()
.TP 0.2i
\(bu
\fBdisconnect\fR - VFS disconnect()
.TP 0.2i
\(bu
\fBdisk_free\fR - VFS disk_free()
.TP 0.2i
\(bu
\fBopendir\fR - VFS opendir()
.TP 0.2i
\(bu
\fBreaddir\fR - VFS readdir()
.TP 0.2i
\(bu
\fBmkdir\fR - VFS mkdir()
.TP 0.2i
\(bu
\fBrmdir\fR - VFS rmdir()
.TP 0.2i
\(bu
\fBclosedir\fR - VFS closedir()
.TP 0.2i
\(bu
\fBopen\fR - VFS open()
.TP 0.2i
\(bu
\fBclose\fR - VFS close()
.TP 0.2i
\(bu
\fBread\fR - VFS read()
.TP 0.2i
\(bu
\fBwrite\fR - VFS write()
.TP 0.2i
\(bu
\fBlseek\fR - VFS lseek()
.TP 0.2i
\(bu
\fBrename\fR - VFS rename()
.TP 0.2i
\(bu
\fBfsync\fR - VFS fsync()
.TP 0.2i
\(bu
\fBstat\fR - VFS stat()
.TP 0.2i
\(bu
\fBfstat\fR - VFS fstat()
.TP 0.2i
\(bu
\fBlstat\fR - VFS lstat()
.TP 0.2i
\(bu
\fBunlink\fR - VFS unlink()
.TP 0.2i
\(bu
\fBchmod\fR - VFS chmod()
.TP 0.2i
\(bu
\fBfchmod\fR - VFS fchmod()
.TP 0.2i
\(bu
\fBchown\fR - VFS chown()
.TP 0.2i
\(bu
\fBfchown\fR - VFS fchown()
.TP 0.2i
\(bu
\fBchdir\fR - VFS chdir()
.TP 0.2i
\(bu
\fBgetwd\fR - VFS getwd()
.TP 0.2i
\(bu
\fButime\fR - VFS utime()
.TP 0.2i
\(bu
\fBftruncate\fR - VFS ftruncate()
.TP 0.2i
\(bu
\fBlock\fR - VFS lock()
.TP 0.2i
\(bu
\fBsymlink\fR - VFS symlink()
.TP 0.2i
\(bu
\fBreadlink\fR - VFS readlink()
.TP 0.2i
\(bu
\fBlink\fR - VFS link()
.TP 0.2i
\(bu
\fBmknod\fR - VFS mknod()
.TP 0.2i
\(bu
\fBrealpath\fR - VFS realpath()
.PP
\fBGENERAL COMMANDS\fR
.TP 0.2i
\(bu
\fBconf <smb.conf>\fR - Load a different configuration file
.TP 0.2i
\(bu
\fBhelp [<command>]\fR - Get list of commands or info about specified command
.TP 0.2i
\(bu
\fBdebuglevel <level>\fR - Set debug level
.TP 0.2i
\(bu
\fBfreemem\fR - Free memory currently in use
.TP 0.2i
\(bu
\fBexit\fR - Exit vfstest
.SH "VERSION"
.PP
This man page is correct for version 3.0 of the Samba
suite.
.SH "AUTHOR"
.PP
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.
.PP
The vfstest man page was written by Jelmer Vernooij.