docs: Add manpage for cifsdd
authorAndreas Schneider <asn@samba.org>
Thu, 11 Feb 2016 09:49:39 +0000 (10:49 +0100)
committerGünther Deschner <gd@samba.org>
Thu, 18 Feb 2016 17:05:55 +0000 (18:05 +0100)
BUG: https://bugzilla.samba.org/show_bug.cgi?id=11730

Signed-off-by: Andreas Schneider <asn@samba.org>
Reviewed-by: Guenther Deschner <gd@samba.org>
Autobuild-User(master): Günther Deschner <gd@samba.org>
Autobuild-Date(master): Thu Feb 18 18:05:55 CET 2016 on sn-devel-144

docs-xml/manpages/cifsdd.8.xml [new file with mode: 0644]
docs-xml/wscript_build

diff --git a/docs-xml/manpages/cifsdd.8.xml b/docs-xml/manpages/cifsdd.8.xml
new file mode 100644 (file)
index 0000000..572ed7b
--- /dev/null
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="smbspool.8">
+
+<refmeta>
+       <refentrytitle>cifsdd</refentrytitle>
+       <manvolnum>8</manvolnum>
+       <refmiscinfo class="source">Samba</refmiscinfo>
+       <refmiscinfo class="manual">System Administration tools</refmiscinfo>
+       <refmiscinfo class="version">4.4</refmiscinfo>
+</refmeta>
+
+
+<refnamediv>
+       <refname>cifsdd</refname>
+       <refpurpose>convert and copy a file over SMB</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+       <cmdsynopsis>
+               <command>cifsdd</command>
+               <arg choice="opt">OPERAND</arg>...
+       </cmdsynopsis>
+       <cmdsynopsis>
+               <command>cifsdd</command>
+               <arg choice="plain">OPTION</arg>
+       </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+       <title>DESCRIPTION</title>
+
+       <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+       <manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+       <para>Copy a file, converting and formatting according to the operands.</para>
+
+       <variablelist>
+               <varlistentry>
+                       <term>bs=BYTES</term>
+                       <listitem><para>read and write up to BYTES bytes at a time (default: 4096)</para></listitem>
+               </varlistentry>
+               <varlistentry>
+                       <term>ibs=BYTES</term>
+                       <listitem><para>read up to BYTES bytes at a time (default: 4096)</para></listitem>
+               </varlistentry>
+               <varlistentry>
+                       <term>obs=BYTES</term>
+                       <listitem><para>write BYTES bytes at a time (default: 4096)</para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+                       <term>if=FILE</term>
+                       <listitem><para>read from FILE instead of stdin</para></listitem>
+               </varlistentry>
+               <varlistentry>
+                       <term>of=FILE</term>
+                       <listitem><para>write to FILE instead of stdout</para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+                       <term>count=N</term>
+                       <listitem><para>copy only N input blocks</para></listitem>
+               </varlistentry>
+               <varlistentry>
+                       <term>seek=N</term>
+                       <listitem><para>skip N obs-sized blocks at start of output</para></listitem>
+               </varlistentry>
+               <varlistentry>
+                       <term>skip=N</term>
+                       <listitem><para>skip N ibs-sized blocks at start of input</para></listitem>
+               </varlistentry>
+
+               <varlistentry>
+                       <term>direct</term>
+                       <listitem><para>use direct I/O for data</para></listitem>
+               </varlistentry>
+               <varlistentry>
+                       <term>sync</term>
+                       <listitem><para>use synchronous writes</para></listitem>
+               </varlistentry>
+               <varlistentry>
+                       <term>oplock</term>
+                       <listitem><para>take oplocks on the input and output files</para></listitem>
+               </varlistentry>
+       </variablelist>
+</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 cifsdd manpage was written by Andreas
+               Schneider.</para>
+</refsect1>
+
+</refentry>
index 3a87ad115da4fd853f783775125141b74e35e0f4..11b826bea9ebf624fcc9b88e1d6fab64af90e7c5 100644 (file)
@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 from samba_utils import save_file
 manpages='''
+         manpages/cifsdd.8
          manpages/dbwrap_tool.1
          manpages/eventlogadm.8
          manpages/findsmb.1