Ignore:
Timestamp:
May 23, 2008, 6:56:41 AM (17 years ago)
Author:
Paul Smedley
Message:

Update source to 3.0.29

File:
1 edited

Legend:

Unmodified
Added
Removed

  • branches/samba-3.0/docs/manpages/vfstest.1

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