docs/manpages/make_smbcodepage.1

   1 .\" This manpage has been automatically generated by docbook2man-spec
   2 .\" from a DocBook document.  docbook2man-spec can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "MAKE_SMBCODEPAGE" "1" "19 November 2002" "" ""
   7 .SH NAME
   8 make_smbcodepage \- construct a codepage file for Samba
   9 .SH SYNOPSIS
  10 .sp
  11 \fBmake_smbcodepage\fR \fBc|d\fR \fBcodepage\fR \fBinputfile\fR \fBoutputfile\fR
  12 .SH "DESCRIPTION"
  13 .PP
  14 This tool is part of the  Samba suite.
  15 .PP
  16 \fBmake_smbcodepage\fR compiles or de-compiles
  17 codepage files for use with the internationalization features
  18 of Samba 2.2
  19 .SH "OPTIONS"
  20 .TP
  21 \fBc|d\fR
  22 This tells \fBmake_smbcodepage\fR
  23 if it is compiling (\fIc\fR) a text format code
  24 page file to binary, or (\fId\fR) de-compiling
  25 a binary codepage file to text.
  26 .TP
  27 \fBcodepage\fR
  28 This is the codepage we are processing (a
  29 number, e.g. 850).
  30 .TP
  31 \fBinputfile\fR
  32 This is the input file to process. In
  33 the \fIc\fR case this will be a text
  34 codepage definition file such as the ones found in the Samba
  35 \fIsource/codepages\fR directory. In
  36 the \fId\fR case this will be the
  37 binary format codepage definition file normally found in
  38 the \fIlib/codepages\fR directory in the
  39 Samba install directory path.
  40 .TP
  41 \fBoutputfile\fR
  42 This is the output file to produce.
  43 .SH "SAMBA CODEPAGE FILES"
  44 .PP
  45 A text Samba codepage definition file is a description
  46 that tells Samba how to map from upper to lower case for
  47 characters greater than ascii 127 in the specified DOS code page.
  48 Note that for certain DOS codepages (437 for example) mapping
  49 from lower to upper case may be non-symmetrical. For example, in
  50 code page 437 lower case a acute maps to a plain upper case A
  51 when going from lower to upper case, but plain upper case A maps
  52 to plain lower case a when lower casing a character.
  53 .PP
  54 A binary Samba codepage definition file is a binary
  55 representation of the same information, including a value that
  56 specifies what codepage this file is describing.
  57 .PP
  58 As Samba does not yet use UNICODE (current for Samba version 2.2)
  59 you must specify the client code page that your DOS and Windows
  60 clients are using if you wish to have case insensitivity done
  61 correctly for your particular language. The default codepage Samba
  62 uses is 850 (Western European). Text codepage definition sample files
  63 are provided in the Samba distribution for codepages 437 (USA), 737 (Greek),
  64 850 (Western European) 852 (MS-DOS Latin 2), 861 (Icelandic), 866 (Cyrillic),
  65 932 (Kanji SJIS), 936 (Simplified Chinese), 949 (Hangul) and 950 (Traditional
  66 Chinese). Users are encouraged to write text codepage definition files for
  67 their own code pages and donate them to samba@samba.org. All codepage files
  68 in the Samba \fIsource/codepages\fR directory are
  69 compiled and installed when a \fB'make install'\fR
  70 command is issued there.
  71 .PP
  72 The client codepage used by the \fBsmbd\fR server
  73 is configured using the \fBclient code page\fR parameter
  74 in the \fBsmb.conf\fR file.
  75 .SH "FILES"
  76 .PP
  77 \fBcodepage_def.<codepage>\fR
  78 .PP
  79 These are the input (text) codepage files provided in the
  80 Samba \fIsource/codepages\fR directory.
  81 .PP
  82 A text codepage definition file consists of multiple lines
  83 containing four fields. These fields are:
  84 .TP 0.2i
  85 \(bu
  86 \fBlower\fR: which is the
  87 (hex) lower case character mapped on this line.
  88 .TP 0.2i
  89 \(bu
  90 \fBupper\fR: which is the (hex)
  91 upper case character that the lower case character will map to.
  92 .TP 0.2i
  93 \(bu
  94 \fBmap upper to lower\fR which
  95 is a boolean value (put either True or False here) which tells
  96 Samba if it is to map the given upper case character to the
  97 given lower case character when lower casing a filename.
  98 .TP 0.2i
  99 \(bu
 100 \fBmap lower to upper\fR which
 101 is a boolean value (put either True or False here) which tells
 102 Samba if it is to map the given lower case character to the
 103 given upper case character when upper casing a filename.
 104 .PP
 105 \fBcodepage.<codepage>\fR - These are the
 106 output (binary) codepage files produced and placed in the Samba
 107 destination \fIlib/codepage\fR directory.
 108 .PP
 109 .SH "INSTALLATION"
 110 .PP
 111 The location of the server and its support files is a
 112 matter for individual system administrators. The following are
 113 thus suggestions only.
 114 .PP
 115 It is recommended that the \fBmake_smbcodepage
 116 \fRprogram be installed under the \fI/usr/local/samba
 117 \fRhierarchy, in a directory readable by all, writeable
 118 only by root. The program itself should be executable by all. The
 119 program should NOT be setuid or setgid!
 120 .SH "VERSION"
 121 .PP
 122 This man page is correct for version 2.2 of
 123 the Samba suite.
 124 .SH "SEE ALSO"
 125 .PP
 126 \fBsmbd(8)\fR
 127 smb.conf(5)
 128 .SH "AUTHOR"
 129 .PP
 130 The original Samba software and related utilities
 131 were created by Andrew Tridgell. Samba is now developed
 132 by the Samba Team as an Open Source project similar
 133 to the way the Linux kernel is developed.
 134 .PP
 135 The original Samba man pages were written by Karl Auer.
 136 The man page sources were converted to YODL format (another
 137 excellent piece of Open Source software, available at
 138 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0
 139 release by Jeremy Allison. The conversion to DocBook for
 140 Samba 2.2 was done by Gerald Carter