docs/manpages-3/smb-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="smb-vfs-cap.8">
   4
   5 <refmeta>
   6         <refentrytitle>smb-vfs-cap</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>cap</refname>
  13         <refpurpose>make a Samba share read only for a specified time period</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>vfs objects = cap</command>
  19         </cmdsynopsis>
  20 </refsynopsisdiv>
  21
  22 <refsect1>
  23         <title>DESCRIPTION</title>
  24
  25         <para>This module is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  26         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  27
  28         <para>CAP (Columbia Appletalk Protocol) encoding is a
  29         technique for representing non-ASCII filenames in ASCII. The
  30         <command>cap</command> VFS module translates filenames to and
  31         from CAP format, allowing users to name files in their native
  32         encoding.  </para>
  33
  34         <para>CAP encoding is most commonly
  35         used in Japanese language environments. </para>
  36
  37         <para>This module is stackable.</para>
  38
  39 </refsect1>
  40
  41
  42 <refsect1>
  43         <title>EXAMPLES</title>
  44
  45         <para>On a system using GNU libiconv, use CAP encoding to support
  46         users in the Shift_JIS locale:</para>
  47
  48 <programlisting>
  49         <smbconfsection name="[global]"/>
  50         <smbconfoption name="dos charset">CP932</smbconfoption>
  51         <smbconfoption name="dos charset">CP932</smbconfoption>
  52         <smbconfoption name="vfs objects">cap</smbconfoption>
  53 </programlisting>
  54
  55 </refsect1>
  56
  57 <refsect1>
  58         <title>VERSION</title>
  59
  60         <para>This man page is correct for version 3.0.25 of the Samba suite.
  61         </para>
  62 </refsect1>
  63
  64 <refsect1>
  65         <title>AUTHOR</title>
  66
  67         <para>The original Samba software and related utilities
  68         were created by Andrew Tridgell. Samba is now developed
  69         by the Samba Team as an Open Source project similar
  70         to the way the Linux kernel is developed.</para>
  71
  72 </refsect1>
  73
  74 </refentry>