docs/docbook/manpages/make_unicodemap.1.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="make-unicodemap">
   3
   4 <refmeta>
   5         <refentrytitle>make_unicodemap</refentrytitle>
   6         <manvolnum>1</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>make_unicodemap</refname>
  12         <refpurpose>construct a unicode map file for Samba</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>make_unicodemap</command>
  18                 <arg choice="req">codepage</arg>
  19                 <arg choice="req">inputfile</arg>
  20                 <arg choice="req">outputfile</arg>
  21         </cmdsynopsis>
  22 </refsynopsisdiv>
  23
  24
  25
  26 <refsect1>
  27         <title>DESCRIPTION</title>
  28
  29         <para>
  30         This tool is part of the <ulink url="samba.7.html">Samba</ulink>
  31         suite.
  32         </para>
  33
  34         <para>
  35         <command>make_unicodemap</command> compiles text unicode map
  36         files into binary unicodef map files for use with the
  37         internationalization features of Samba 2.2.
  38         </para>
  39 </refsect1>
  40
  41
  42
  43 <refsect1>
  44         <title>OPTIONS</title>
  45
  46         <variablelist>
  47                 <varlistentry>
  48                 <term>codepage</term>
  49                 <listitem><para>This is the codepage or UNIX character
  50                 set we are processing (a number, e.g. 850).
  51                 </para></listitem>
  52                 </varlistentry>
  53
  54                 <varlistentry>
  55                 <term>inputfile</term>
  56                 <listitem><para>This is the input file to process. This is a
  57                 text unicode map file such as the ones found in the Samba
  58                 <filename>source/codepages</filename> directory.
  59                 </para></listitem>
  60                 </varlistentry>
  61
  62                 <varlistentry>
  63                 <term>outputfile</term>
  64                 <listitem><para>This is the binary output file to produce.
  65                 </para></listitem>
  66                 </varlistentry>
  67         </variablelist>
  68 </refsect1>
  69
  70
  71 <refsect1>
  72         <title>Samba Unicode Map Files</title>
  73
  74         <para>
  75         A text Samba unicode map file is a description that tells Samba
  76         how to map characters from a specified DOS code page or UNIX character
  77         set to 16 bit unicode.
  78         </para>
  79
  80         <para>A binary Samba unicode map file is a binary representation
  81         of the same information, including a value that specifies what
  82         codepage or UNIX character set this file is describing.
  83         </para>
  84 </refsect1>
  85
  86 <refsect1>
  87         <title>Files</title>
  88
  89         <para><filename>CP&lt;codepage&gt;.TXT</filename></para>
  90
  91         <para>
  92         These are the input (text) unicode map files provided
  93         in the Samba <filename>source/codepages</filename>
  94         directory.
  95         </para>
  96
  97         <para>
  98         A text unicode map file consists of multiple lines
  99         containing two fields. These fields are :
 100         </para>
 101
 102         <itemizedlist>
 103                 <listitem><para><parameter>character</parameter> - which is
 104                 the (hex) character mapped on this line.
 105                 </para></listitem>
 106
 107                 <listitem><para><parameter>unicode</parameter> - which
 108                 is the (hex) 16 bit unicode character that the character
 109                 will map to.
 110                 </para></listitem>
 111         </itemizedlist>
 112
 113         <para>
 114         <filename>unicode_map.&lt;codepage&gt;</filename>  - These are
 115         the output (binary) unicode map files produced and placed in
 116         the Samba destination <filename>lib/codepage</filename>
 117         directory.
 118         </para>
 119 </refsect1>
 120
 121
 122 <refsect1>
 123         <title>Installation</title>
 124
 125         <para>
 126         The location of the server and its support files is a matter
 127         for individual system administrators. The following are thus
 128         suggestions only.
 129         </para>
 130
 131         <para>
 132         It is recommended that the <command>make_unicodemap</command>
 133         program be installed under the
 134         <filename>$prefix/samba</filename> hierarchy,
 135         in a directory readable by all, writeable only by root. The
 136         program itself should be executable by all.  The program
 137         should NOT be setuid or setgid!
 138         </para>
 139 </refsect1>
 140
 141 <refsect1>
 142         <title>VERSION</title>
 143
 144         <para>This man page is correct for version 2.2 of
 145         the Samba suite.</para>
 146 </refsect1>
 147
 148 <refsect1>
 149         <title>SEE ALSO</title>
 150         <para><ulink url="smbd.8.html"><command>smbd(8)</command></ulink>,
 151         <ulink url="smb.conf.5.html">smb.conf(5)</ulink>
 152         </para>
 153 </refsect1>
 154
 155 <refsect1>
 156         <title>AUTHOR</title>
 157
 158         <para>The original Samba software and related utilities
 159         were created by Andrew Tridgell. Samba is now developed
 160         by the Samba Team as an Open Source project similar
 161         to the way the Linux kernel is developed.</para>
 162
 163         <para>The original Samba man pages were written by Karl Auer.
 164         The man page sources were converted to YODL format (another
 165         excellent piece of Open Source software, available at
 166         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 167         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 168         release by Jeremy Allison.  The conversion to DocBook for
 169         Samba 2.2 was done by Gerald Carter</para>
 170 </refsect1>
 171
 172 </refentry>