Document the cap VFS module.
authorJames Peach <jpeach@samba.org>
Wed, 28 Feb 2007 20:40:46 +0000 (20:40 +0000)
committerGerald W. Carter <jerry@samba.org>
Wed, 23 Apr 2008 13:47:27 +0000 (08:47 -0500)
(This used to be commit c595aa3353b1fe4b19b077058cf0d6370edeebc8)

docs/manpages-3/smb-vfs-cap.8.xml [new file with mode: 0644]

diff --git a/docs/manpages-3/smb-vfs-cap.8.xml b/docs/manpages-3/smb-vfs-cap.8.xml
new file mode 100644 (file)
index 0000000..7ce0152
--- /dev/null
@@ -0,0 +1,74 @@
+<?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="smb-vfs-cap.8">
+
+<refmeta>
+       <refentrytitle>smb-vfs-cap</refentrytitle>
+       <manvolnum>8</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+       <refname>cap</refname>
+       <refpurpose>make a Samba share read only for a specified time period</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+       <cmdsynopsis>
+               <command>vfs objects = cap</command>
+       </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+       <title>DESCRIPTION</title>
+
+       <para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
+       <manvolnum>7</manvolnum></citerefentry> suite.</para>
+
+       <para>CAP (Columbia Appletalk Protocol) encoding is a
+       technique for representing non-ASCII filenames in ASCII. The
+       <command>cap</command> VFS module translates filenames to and
+       from CAP format, allowing users to name files in their native
+       encoding.  </para>
+
+       <para>CAP encoding is most commonly
+       used in Japanese language environments. </para>
+
+       <para>This module is stackable.</para>
+
+</refsect1>
+
+
+<refsect1>
+       <title>EXAMPLES</title>
+
+       <para>On a system using GNU libiconv, use CAP encoding to support
+       users in the Shift_JIS locale:</para>
+
+<programlisting>
+        <smbconfsection name="[global]"/>
+       <smbconfoption name="dos charset">CP932</smbconfoption>
+       <smbconfoption name="dos charset">CP932</smbconfoption>
+       <smbconfoption name="vfs objects">cap</smbconfoption>
+</programlisting>
+
+</refsect1>
+
+<refsect1>
+       <title>VERSION</title>
+
+       <para>This man page is correct for version 3.0.25 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>
+
+</refsect1>
+
+</refentry>