diff options
| -rw-r--r-- | docs/docbook/Makefile.in | 12 | ||||
| -rw-r--r-- | docs/docbook/configure.in | 2 | ||||
| -rw-r--r-- | docs/docbook/manpages/vfstest.1.sgml | 160 |
3 files changed, 171 insertions, 3 deletions
diff --git a/docs/docbook/Makefile.in b/docs/docbook/Makefile.in index 0320081876..5056f82a98 100644 --- a/docs/docbook/Makefile.in +++ b/docs/docbook/Makefile.in @@ -37,7 +37,7 @@ MANPAGES=$(MANDIR)/findsmb.1 $(MANDIR)/smbclient.1 \ $(MANDIR)/smb.conf.5 $(MANDIR)/wbinfo.1 $(MANDIR)/pdbedit.8 \ $(MANDIR)/smbcacls.1 $(MANDIR)/smbsh.1 $(MANDIR)/winbindd.8 \ $(MANDIR)/make_unicodemap.1 $(MANDIR)/net.8 \ - $(MANDIR)/smbgroupedit.8 + $(MANDIR)/smbgroupedit.8 $(MANDIR)/vfstest.1 SGMLMANSRC=manpages/findsmb.1.sgml manpages/smbclient.1.sgml \ manpages/smbspool.8.sgml manpages/lmhosts.5.sgml \ @@ -53,7 +53,7 @@ SGMLMANSRC=manpages/findsmb.1.sgml manpages/smbclient.1.sgml \ manpages/wbinfo.1.sgml manpages/smbcacls.1.sgml \ manpages/smbsh.1.sgml manpages/winbindd.8.sgml \ manpages/make_unicodemap.1.sgml manpages/smbgroupedit.8.sgml \ - manpages/net.8.sgml + manpages/net.8.sgml manpages/vfstest.1.sgml HOWTOSRC=projdoc/DOMAIN_MEMBER.sgml projdoc/NT_Security.sgml \ projdoc/msdfs_setup.sgml projdoc/printer_driver2.sgml \ @@ -328,6 +328,14 @@ $(MANDIR)/testprns.1: manpages/testprns.1.sgml @echo "Making HTML version of $@" @$(JADE) -t sgml -i html -V nochunks -d ./stylesheets/ldp.dsl\#html $< > $(HTMLDIR)/`echo $< | sed 's,.*/,,'| sed "s/\.sgml/\.html/g"` +$(MANDIR)/vfstest.1: manpages/vfstest.1.sgml + @echo "Making $@" + @$(NSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl + @cat `echo $@ | sed 's,.*/,,'` | $(PERL) scripts/strip-links.pl > $@ + @/bin/rm -f `echo $@ | sed 's,.*/,,'` + @echo "Making HTML version of $@" + @$(JADE) -t sgml -i html -V nochunks -d ./stylesheets/ldp.dsl\#html $< > $(HTMLDIR)/`echo $< | sed 's,.*/,,'| sed "s/\.sgml/\.html/g"` + $(MANDIR)/smb.conf.5: manpages/smb.conf.5.sgml @echo "Making $@" @$(NSGMLS) $< | $(SGMLSPL) $(SGML_SHARE)/docbook2X/docbook2man-spec.pl diff --git a/docs/docbook/configure.in b/docs/docbook/configure.in index ad0613f2be..f8b4a1618a 100644 --- a/docs/docbook/configure.in +++ b/docs/docbook/configure.in @@ -38,7 +38,7 @@ esac # The Makefile requires docbook2X in the share/sgml directory if [ ! test -f $SGML_SHARE/docbook2X/docbook2man-spec.pl ]; then - AC_MSG_ERROR("Unable to find dockbook2X. Make sure it is installed and that the sgml-share path is correct.") + AC_MSG_ERROR("Unable to find docbook2X. Make sure it is installed and that the sgml-share path is correct.") fi AC_SUBST(SGML_SHARE)dnl diff --git a/docs/docbook/manpages/vfstest.1.sgml b/docs/docbook/manpages/vfstest.1.sgml new file mode 100644 index 0000000000..daa52d5d4b --- /dev/null +++ b/docs/docbook/manpages/vfstest.1.sgml @@ -0,0 +1,160 @@ +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> +<refentry id="rpcclient"> + +<refmeta> + <refentrytitle>vfstest</refentrytitle> + <manvolnum>1</manvolnum> +</refmeta> + + +<refnamediv> + <refname>vfstest</refname> + <refpurpose>tool for testing samba VFS modules </refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>vfstest</command> + <arg choice="opt">-d debuglevel</arg> + <arg choice="opt">-c "command"</arg> + <arg choice="opt">-l "logfile"</arg> + <arg choice="opt">-h</arg> + </cmdsynopsis> +</refsynopsisdiv> + +<refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <ulink url="samba.7.html"> + Samba</ulink> suite.</para> + + <para><command>vfstest</command> 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. + </para> +</refsect1> + + +<refsect1> + <title>OPTIONS</title> + + <variablelist> + + <varlistentry> + <term>-c|--command=command</term> + <listitem><para>Execute the specified (colon-seperated) commands. + See below for the commands that are available. + </para> + + </varlistentry> + + <varlistentry> + <term>-d|--debug=debuglevel</term> + <listitem><para>set the debuglevel. Debug level 0 is the lowest + and 100 being the highest. This should be set to 100 if you are + planning on submitting a bug report to the Samba team (see <filename>BUGS.txt</filename>). + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-h|--help</term> + <listitem><para>Print a summary of command line options. + </para></listitem> + </varlistentry> + + <varlistentry> + <term>-l|--logfile=logbasename</term> + <listitem><para>File name for log/debug files. The extension + <constant>'.client'</constant> will be appended. The log file is never removed + by the client. + </para></listitem> + </varlistentry> + + </variablelist> +</refsect1> + + +<refsect1> + <title>COMMANDS</title> + + <para><emphasis>VFS COMMANDS</emphasis></para> + <itemizedlist> + <listitem><para><command>load <module.so></command> - Load specified VFS module </para></listitem> + + <listitem><para><command>populate <char> <size></command> - Populate a data buffer with the specified data + </para></listitem> + + <listitem><para><command>showdata [<offset> <len>]</command> - Show data currently in data buffer + </para></listitem> + + <listitem><para><command>connect</command> - VFS connect()</para></listitem> + <listitem><para><command>disconnect</command> - VFS disconnect()</para></listitem> + <listitem><para><command>disk_free</command> - VFS disk_free()</para></listitem> + <listitem><para><command>opendir</command> - VFS opendir()</para></listitem> + <listitem><para><command>readdir</command> - VFS readdir()</para></listitem> + <listitem><para><command>mkdir</command> - VFS mkdir()</para></listitem> + <listitem><para><command>rmdir</command> - VFS rmdir()</para></listitem> + <listitem><para><command>closedir</command> - VFS closedir()</para></listitem> + <listitem><para><command>open</command> - VFS open()</para></listitem> + <listitem><para><command>close</command> - VFS close()</para></listitem> + <listitem><para><command>read</command> - VFS read()</para></listitem> + <listitem><para><command>write</command> - VFS write()</para></listitem> + <listitem><para><command>lseek</command> - VFS lseek()</para></listitem> + <listitem><para><command>rename</command> - VFS rename()</para></listitem> + <listitem><para><command>fsync</command> - VFS fsync()</para></listitem> + <listitem><para><command>stat</command> - VFS stat()</para></listitem> + <listitem><para><command>fstat</command> - VFS fstat()</para></listitem> + <listitem><para><command>lstat</command> - VFS lstat()</para></listitem> + <listitem><para><command>unlink</command> - VFS unlink()</para></listitem> + <listitem><para><command>chmod</command> - VFS chmod()</para></listitem> + <listitem><para><command>fchmod</command> - VFS fchmod()</para></listitem> + <listitem><para><command>chown</command> - VFS chown()</para></listitem> + <listitem><para><command>fchown</command> - VFS fchown()</para></listitem> + <listitem><para><command>chdir</command> - VFS chdir()</para></listitem> + <listitem><para><command>getwd</command> - VFS getwd()</para></listitem> + <listitem><para><command>utime</command> - VFS utime()</para></listitem> + <listitem><para><command>ftruncate</command> - VFS ftruncate()</para></listitem> + <listitem><para><command>lock</command> - VFS lock()</para></listitem> + <listitem><para><command>symlink</command> - VFS symlink()</para></listitem> + <listitem><para><command>readlink</command> - VFS readlink()</para></listitem> + <listitem><para><command>link</command> - VFS link()</para></listitem> + <listitem><para><command>mknod</command> - VFS mknod()</para></listitem> + <listitem><para><command>realpath</command> - VFS realpath()</para></listitem> + </itemizedlist> + + <para><emphasis>GENERAL COMMANDS</emphasis></para> + <itemizedlist> + <listitem><para><command>conf <smb.conf></command> - Load a different configuration file</para></listitem> + + <listitem><para><command>help [<command>]</command> - Get list of commands or info about specified command</para></listitem> + + <listitem><para><command>debuglevel <level></command> - Set debug level</para></listitem> + + <listitem><para><command>freemem</command> - Free memory currently in use</para></listitem> + + <listitem><para><command>exit</command> - Exit vfstest</para></listitem> + </itemizedlist> + +</refsect1> +</refsect1> + +<refsect1> + <title>VERSION</title> + + <para>This man page is correct for version 3.0 of the Samba + suite.</para> +</refsect1> + +<refsect1> + <title>AUTHOR</title> + + <para>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.</para> + + <para>The vfstest man page was written by Jelmer Vernooij.</para> +</refsect1> + +</refentry> |