docs/docbook/manpages/make_smbcodepage.1.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="make-smbcodepage">
   3
   4 <refmeta>
   5         <refentrytitle>make_smbcodepage</refentrytitle>
   6         <manvolnum>1</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>make_smbcodepage</refname>
  12         <refpurpose>construct a codepage file for Samba</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>make_smbcodepage</command>
  18                 <arg choice="req">c|d</arg>
  19                 <arg choice="req">codepage</arg>
  20                 <arg choice="req">inputfile</arg>
  21                 <arg choice="req">outputfile</arg>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This tool is part of the <ulink url="samba.7.html">
  29         Samba</ulink> suite.</para>
  30
  31         <para><command>make_smbcodepage</command> compiles or de-compiles
  32         codepage files for use with the internationalization features
  33         of Samba 2.2</para>
  34 </refsect1>
  35
  36
  37
  38 <refsect1>
  39         <title>OPTIONS</title>
  40
  41         <variablelist>
  42                 <varlistentry>
  43                 <term>c|d</term>
  44                 <listitem><para>This tells <command>make_smbcodepage</command>
  45                 if it is compiling (<parameter>c</parameter>) a text format code
  46                 page file to binary, or (<parameter>d</parameter>) de-compiling
  47                 a binary codepage file to text. </para></listitem>
  48                 </varlistentry>
  49
  50                 <varlistentry>
  51                 <term>codepage</term>
  52                 <listitem><para>This is the codepage we are processing (a
  53                 number, e.g. 850). </para></listitem>
  54                 </varlistentry>
  55
  56
  57                 <varlistentry>
  58                 <term>inputfile</term>
  59                 <listitem><para>This is the input file to process. In
  60                 the <parameter>c</parameter> case this will be a text
  61                 codepage definition file such as the ones found in the Samba
  62                 <filename>source/codepages</filename> directory. In
  63                 the <parameter>d</parameter> case this will be the
  64                 binary format codepage definition file normally found in
  65                 the <filename>lib/codepages</filename> directory in the
  66                 Samba install directory path.</para></listitem>
  67                 </varlistentry>
  68
  69
  70                 <varlistentry>
  71                 <term>outputfile</term>
  72                 <listitem><para>This is the output file to produce.</para></listitem>
  73                 </varlistentry>
  74         </variablelist>
  75 </refsect1>
  76
  77 <refsect1>
  78         <title>Samba Codepage Files</title>
  79
  80         <para>A text Samba codepage definition file is a description
  81         that tells  Samba how to map from upper to lower case for
  82         characters greater than ascii 127 in the specified DOS code page.
  83         Note that for certain DOS codepages (437 for example) mapping
  84         from lower to upper case may be non-symmetrical. For example, in
  85         code page 437 lower case a acute maps to a plain upper case A
  86         when going from lower to upper case, but plain upper case A maps
  87         to plain lower case a when lower casing a character. </para>
  88
  89         <para>A binary Samba codepage definition file is a binary
  90         representation of the same information, including a value that
  91         specifies what codepage this file is describing. </para>
  92
  93         <para>As Samba does not yet use UNICODE (current for Samba version 2.2)
  94         you must specify the client code page that your DOS and Windows
  95         clients are using if you wish to have case insensitivity done
  96         correctly for your particular language. The default codepage Samba
  97         uses is 850 (Western European). Text codepage definition sample files
  98         are provided in the Samba distribution for codepages 437 (USA), 737 (Greek),
  99         850 (Western European) 852 (MS-DOS Latin 2), 861 (Icelandic), 866 (Cyrillic),
 100         932 (Kanji SJIS), 936 (Simplified Chinese), 949 (Hangul) and 950 (Traditional
 101         Chinese). Users are encouraged to write text codepage definition files for
 102         their own code pages and donate them to samba@samba.org. All codepage files
 103         in the Samba <filename>source/codepages</filename> directory are
 104         compiled and installed when a <command>'make install'</command>
 105         command is issued there. </para>
 106
 107         <para>The client codepage used by the <command>smbd</command> server
 108         is configured using the <command>client code page</command> parameter
 109         in the <command>smb.conf</command> file. </para>
 110 </refsect1>
 111
 112
 113 <refsect1>
 114         <title>Files</title>
 115
 116         <para><command>codepage_def.&lt;codepage&gt;</command></para>
 117
 118         <para>These are the input (text) codepage files provided in the
 119         Samba <filename>source/codepages</filename> directory.</para>
 120
 121         <para>A text codepage definition file consists of multiple lines
 122         containing four fields. These fields are:</para>
 123
 124         <itemizedlist>
 125                 <listitem><para><command>lower</command>: which is the
 126                 (hex) lower case character mapped on this line.</para>
 127                 </listitem>
 128
 129                 <listitem><para><command>upper</command>: which is the (hex)
 130                 upper case character that the lower case character will map to.
 131                 </para></listitem>
 132
 133                 <listitem><para><command>map upper to lower</command> which
 134                 is a boolean value (put either True or False here) which tells
 135                 Samba if it is to map the given upper case character to the
 136                 given lower case character when lower casing a filename.
 137                 </para></listitem>
 138
 139                 <listitem><para><command>map lower to upper</command> which
 140                 is a boolean value (put either True or False here) which tells
 141                 Samba if it is to map the given lower case character to the
 142                 given upper case character when upper casing a filename.
 143                 </para></listitem>
 144         </itemizedlist>
 145
 146
 147         <para><command>codepage.&lt;codepage&gt;</command> - These are the
 148         output (binary) codepage files produced  and placed in the Samba
 149         destination <filename>lib/codepage</filename> directory. </para>
 150 </refsect1>
 151
 152 <refsect1>
 153         <title>Installation</title>
 154
 155         <para>The location of the server and its support files is a
 156         matter for individual system administrators. The following are
 157         thus suggestions only. </para>
 158
 159         <para>It is recommended that the <command>make_smbcodepage
 160         </command> program be installed under the <filename>/usr/local/samba
 161         </filename> hierarchy, in a directory readable by all, writeable
 162         only by root. The program itself should be executable by all.  The
 163         program should NOT be setuid or setgid! </para>
 164 </refsect1>
 165
 166 <refsect1>
 167         <title>VERSION</title>
 168
 169         <para>This man page is correct for version 2.2 of
 170         the Samba suite.</para>
 171 </refsect1>
 172
 173 <refsect1>
 174         <title>SEE ALSO</title>
 175         <para><ulink url="smbd.8.html"><command>smbd(8)</command></ulink>,
 176         <ulink url="smb.conf.5.html">smb.conf(5)</ulink>
 177         </para>
 178 </refsect1>
 179
 180 <refsect1>
 181         <title>AUTHOR</title>
 182
 183         <para>The original Samba software and related utilities
 184         were created by Andrew Tridgell. Samba is now developed
 185         by the Samba Team as an Open Source project similar
 186         to the way the Linux kernel is developed.</para>
 187
 188         <para>The original Samba man pages were written by Karl Auer.
 189         The man page sources were converted to YODL format (another
 190         excellent piece of Open Source software, available at
 191         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 192         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 193         release by Jeremy Allison.  The conversion to DocBook for
 194         Samba 2.2 was done by Gerald Carter</para>
 195 </refsect1>
 196
 197 </refentry>