7aa05e616a1fec6a81db745458d3c34e796e282e
[sfrench/samba-autobuild/.git] / docs-xml / manpages / vfs_cap.8.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="vfs_cap.8">
4
5 <refmeta>
6         <refentrytitle>vfs_cap</refentrytitle>
7         <manvolnum>8</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>vfs_cap</refname>
16         <refpurpose>CAP encode filenames</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = cap</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
24
25 <refsect1>
26         <title>DESCRIPTION</title>
27
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
31
32         <para>CAP (Columbia Appletalk Protocol) encoding is a
33         technique for representing non-ASCII filenames in ASCII. The
34         <command>vfs_cap</command> VFS module translates filenames to and
35         from CAP format, allowing users to name files in their native
36         encoding.  </para>
37
38         <para>CAP encoding is most commonly
39         used in Japanese language environments. </para>
40
41         <para>This module is stackable.</para>
42
43 </refsect1>
44
45
46 <refsect1>
47         <title>EXAMPLES</title>
48
49         <para>On a system using GNU libiconv, use CAP encoding to support
50         users in the Shift_JIS locale:</para>
51
52 <programlisting>
53         <smbconfsection name="[global]"/>
54         <smbconfoption name="dos charset">CP932</smbconfoption>
55         <smbconfoption name="dos charset">CP932</smbconfoption>
56         <smbconfoption name="vfs objects">cap</smbconfoption>
57 </programlisting>
58
59 </refsect1>
60
61 <refsect1>
62         <title>VERSION</title>
63
64         <para>This man page is correct for version &doc.version; of the Samba suite.
65         </para>
66 </refsect1>
67
68 <refsect1>
69         <title>AUTHOR</title>
70
71         <para>The original Samba software and related utilities
72         were created by Andrew Tridgell. Samba is now developed
73         by the Samba Team as an Open Source project similar
74         to the way the Linux kernel is developed.</para>
75
76 </refsect1>
77
78 </refentry>