93edd9322a38575134501162088831ee7a034c61
[samba.git] / docs / manpages / make_smbcodepage.1
1 .TH "make_smbcodepage" "1" "23 Oct 1998" "Samba" "SAMBA" 
2 .PP 
3 .SH "NAME" 
4 make_codepage \- Construct a codepage file for Samba
5 .PP 
6 .SH "SYNOPSIS" 
7 .PP 
8 \fBmake_smbcodepage\fP [c|d] codepage inputfile outputfile
9 .PP 
10 .SH "DESCRIPTION" 
11 .PP 
12 This program is part of the \fBSamba\fP suite\&.
13 .PP 
14 \fBmake_smbcodepage\fP compiles or de-compiles codepage files for use
15 with the internationalization features of Samba 2\&.0
16 .PP 
17 .SH "OPTIONS" 
18 .PP 
19 .IP 
20 .IP "c|d" 
21 This tells make_smbcodepage if it is compiling (c) a text
22 format code page file to binary, or (d) de-compiling a binary codepage
23 file to text\&.
24 .IP 
25 .IP "codepage" 
26 This is the codepage we are processing (a number, eg\&. 850)\&.
27 .IP 
28 .IP "inputfile" 
29 This is the input file to process\&. In the \'c\' case this
30 will be a text codepage definition file such as the ones found in the
31 Samba \fIsource/codepages\fP directory\&. In the \'d\' case this will be the
32 binary format codepage definition file normally found in the
33 \fIlib/codepages\fP directory in the Samba install directory path\&.
34 .IP 
35 .IP "outputfile" 
36 This is the output file to produce\&.
37 .IP 
38 .PP 
39 .SH "Samba Codepage Files" 
40 .PP 
41 A text Samba codepage definition file is a description that tells
42 Samba how to map from upper to lower case for characters greater than
43 ascii 127 in the specified DOS code page\&.  Note that for certain DOS
44 codepages (437 for example) mapping from lower to upper case may be
45 asynchronous\&. For example, in code page 437 lower case a acute maps to
46 a plain upper case A when going from lower to upper case, but maps
47 from plain upper case A to plain lower case a when lower casing a
48 character\&.
49 .PP 
50 A binary Samba codepage definition file is a binary representation of
51 the same information, including a value that specifies what codepage
52 this file is describing\&.
53 .PP 
54 As Samba does not yet use UNICODE (current for Samba version 2\&.0) you
55 must specify the client code page that your DOS and Windows clients
56 are using if you wish to have case insensitivity done correctly for
57 your particular language\&. The default codepage Samba uses is 850
58 (Western European)\&. Text codepage definition sample files are
59 provided in the Samba distribution for codepages 437 (USA), 737
60 (Greek), 850 (Western European) 852 (MS-DOS Latin 2), 861 (Icelandic),
61 866 (Cyrillic), 932 (Kanji SJIS), 936 (Simplified Chinese), 949
62 (Hangul) and 950 (Traditional Chinese)\&. Users are encouraged to write
63 text codepage definition files for their own code pages and donate
64 them to \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP\&. All codepage files in the
65 Samba \fIsource/codepages\fP directory are compiled and installed when a
66 \fI\'make install\'\fP command is issued there\&.
67 .PP 
68 The client codepage used by the \fBsmbd\fP server is
69 configured using the \fBclient code
70 page\fP parameter in the
71 \fBsmb\&.conf\fP file\&.
72 .PP 
73 .SH "FILES" 
74 .PP 
75 \fBcodepage_def\&.<codepage>\fP
76 .PP 
77 These are the input (text) codepage files provided in the Samba
78 \fIsource/codepages\fP directory\&.
79 .PP 
80 A text codepage definition file consists of multiple lines
81 containing four fields\&. These fields are : 
82 .PP 
83 .IP 
84 .IP o 
85 \fBlower\fP: which is the (hex) lower case character mapped on this
86 line\&.
87 .IP 
88 .IP o 
89 \fBupper\fP: which is the (hex) upper case character that the lower
90 case character will map to\&.
91 .IP 
92 .IP o 
93 \fBmap upper to lower\fP which is a boolean value (put either True
94 or False here) which tells Samba if it is to map the given upper case
95 character to the given lower case character when lower casing a
96 filename\&.
97 .IP 
98 .IP o 
99 \fBmap lower to upper\fP which is a boolean value (put either True
100 or False here) which tells Samba if it is to map the given lower case
101 character to the given upper case character when upper casing a
102 filename\&.
103 .IP 
104 .PP 
105 \fBcodepage\&.<codepage>\fP These are the output (binary) codepage files
106 produced and placed in the Samba destination \fIlib/codepage\fP
107 directory\&.
108 .PP 
109 .SH "INSTALLATION" 
110 .PP 
111 The location of the server and its support files is a matter for
112 individual system administrators\&. The following are thus suggestions
113 only\&.
114 .PP 
115 It is recommended that the \fBmake_smbcodepage\fP program be installed
116 under the \fI/usr/local/samba\fP hierarchy, in a directory readable by
117 all, writeable only by root\&. The program itself should be executable
118 by all\&.  The program should NOT be setuid or setgid!
119 .PP 
120 .SH "VERSION" 
121 .PP 
122 This man page is correct for version 2\&.0 of the Samba suite\&.
123 .PP 
124 .SH "SEE ALSO" 
125 .PP 
126 \fBsmb\&.conf(5)\fP, \fBsmbd (8)\fP
127 .PP 
128 .SH "AUTHOR" 
129 .PP 
130 The original Samba software and related utilities were created by
131 Andrew Tridgell \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP\&. Samba is now developed
132 by the Samba Team as an Open Source project similar to the way the
133 Linux kernel is developed\&.
134 .PP 
135 The original Samba man pages were written by Karl Auer\&. The man page
136 sources were converted to YODL format (another excellent piece of Open
137 Source software) and updated for the Samba2\&.0 release by Jeremy
138 Allison, \fIsamba-bugs@samba\&.anu\&.edu\&.au\fP\&.
139 .PP 
140 See \fBsamba (7)\fP to find out how to get a full
141 list of contributors and details on how to submit bug reports,
142 comments etc\&.