merge from 2.2
[Samba/gbeck.git] / docs / htmldocs / make_smbcodepage.1.html
blob8e792e312211922be1add7e028bb888756f6b42d
1 <HTML
2 ><HEAD
3 ><TITLE
4 >make_smbcodepage</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.57"></HEAD
8 ><BODY
9 CLASS="REFENTRY"
10 BGCOLOR="#FFFFFF"
11 TEXT="#000000"
12 LINK="#0000FF"
13 VLINK="#840084"
14 ALINK="#0000FF"
15 ><H1
16 ><A
17 NAME="MAKE-SMBCODEPAGE"
18 >make_smbcodepage</A
19 ></H1
20 ><DIV
21 CLASS="REFNAMEDIV"
22 ><A
23 NAME="AEN5"
24 ></A
25 ><H2
26 >Name</H2
27 >make_smbcodepage&nbsp;--&nbsp;construct a codepage file for Samba</DIV
28 ><DIV
29 CLASS="REFSYNOPSISDIV"
30 ><A
31 NAME="AEN8"
32 ></A
33 ><H2
34 >Synopsis</H2
35 ><P
36 ><B
37 CLASS="COMMAND"
38 >make_smbcodepage</B
39 > {c|d} {codepage} {inputfile} {outputfile}</P
40 ></DIV
41 ><DIV
42 CLASS="REFSECT1"
43 ><A
44 NAME="AEN15"
45 ></A
46 ><H2
47 >DESCRIPTION</H2
48 ><P
49 >This tool is part of the <A
50 HREF="samba.7.html"
51 TARGET="_top"
52 > Samba</A
53 > suite.</P
54 ><P
55 ><B
56 CLASS="COMMAND"
57 >make_smbcodepage</B
58 > compiles or de-compiles
59 codepage files for use with the internationalization features
60 of Samba 2.2</P
61 ></DIV
62 ><DIV
63 CLASS="REFSECT1"
64 ><A
65 NAME="AEN21"
66 ></A
67 ><H2
68 >OPTIONS</H2
69 ><P
70 ></P
71 ><DIV
72 CLASS="VARIABLELIST"
73 ><DL
74 ><DT
75 >c|d</DT
76 ><DD
77 ><P
78 >This tells <B
79 CLASS="COMMAND"
80 >make_smbcodepage</B
82 if it is compiling (<TT
83 CLASS="PARAMETER"
84 ><I
85 >c</I
86 ></TT
87 >) a text format code
88 page file to binary, or (<TT
89 CLASS="PARAMETER"
90 ><I
91 >d</I
92 ></TT
93 >) de-compiling
94 a binary codepage file to text. </P
95 ></DD
96 ><DT
97 >codepage</DT
98 ><DD
99 ><P
100 >This is the codepage we are processing (a
101 number, e.g. 850). </P
102 ></DD
103 ><DT
104 >inputfile</DT
105 ><DD
107 >This is the input file to process. In
108 the <TT
109 CLASS="PARAMETER"
111 >c</I
112 ></TT
113 > case this will be a text
114 codepage definition file such as the ones found in the Samba
116 CLASS="FILENAME"
117 >source/codepages</TT
118 > directory. In
119 the <TT
120 CLASS="PARAMETER"
122 >d</I
123 ></TT
124 > case this will be the
125 binary format codepage definition file normally found in
126 the <TT
127 CLASS="FILENAME"
128 >lib/codepages</TT
129 > directory in the
130 Samba install directory path.</P
131 ></DD
132 ><DT
133 >outputfile</DT
134 ><DD
136 >This is the output file to produce.</P
137 ></DD
138 ></DL
139 ></DIV
140 ></DIV
141 ><DIV
142 CLASS="REFSECT1"
144 NAME="AEN47"
145 ></A
146 ><H2
147 >Samba Codepage Files</H2
149 >A text Samba codepage definition file is a description
150 that tells Samba how to map from upper to lower case for
151 characters greater than ascii 127 in the specified DOS code page.
152 Note that for certain DOS codepages (437 for example) mapping
153 from lower to upper case may be non-symmetrical. For example, in
154 code page 437 lower case a acute maps to a plain upper case A
155 when going from lower to upper case, but plain upper case A maps
156 to plain lower case a when lower casing a character. </P
158 >A binary Samba codepage definition file is a binary
159 representation of the same information, including a value that
160 specifies what codepage this file is describing. </P
162 >As Samba does not yet use UNICODE (current for Samba version 2.2)
163 you must specify the client code page that your DOS and Windows
164 clients are using if you wish to have case insensitivity done
165 correctly for your particular language. The default codepage Samba
166 uses is 850 (Western European). Text codepage definition sample files
167 are provided in the Samba distribution for codepages 437 (USA), 737 (Greek),
168 850 (Western European) 852 (MS-DOS Latin 2), 861 (Icelandic), 866 (Cyrillic),
169 932 (Kanji SJIS), 936 (Simplified Chinese), 949 (Hangul) and 950 (Traditional
170 Chinese). Users are encouraged to write text codepage definition files for
171 their own code pages and donate them to samba@samba.org. All codepage files
172 in the Samba <TT
173 CLASS="FILENAME"
174 >source/codepages</TT
175 > directory are
176 compiled and installed when a <B
177 CLASS="COMMAND"
178 >'make install'</B
180 command is issued there. </P
182 >The client codepage used by the <B
183 CLASS="COMMAND"
184 >smbd</B
185 > server
186 is configured using the <B
187 CLASS="COMMAND"
188 >client code page</B
189 > parameter
190 in the <B
191 CLASS="COMMAND"
192 >smb.conf</B
193 > file. </P
194 ></DIV
195 ><DIV
196 CLASS="REFSECT1"
198 NAME="AEN58"
199 ></A
200 ><H2
201 >Files</H2
204 CLASS="COMMAND"
205 >codepage_def.&#60;codepage&#62;</B
206 ></P
208 >These are the input (text) codepage files provided in the
209 Samba <TT
210 CLASS="FILENAME"
211 >source/codepages</TT
212 > directory.</P
214 >A text codepage definition file consists of multiple lines
215 containing four fields. These fields are:</P
217 ></P
218 ><UL
219 ><LI
222 CLASS="COMMAND"
223 >lower</B
224 >: which is the
225 (hex) lower case character mapped on this line.</P
226 ></LI
227 ><LI
230 CLASS="COMMAND"
231 >upper</B
232 >: which is the (hex)
233 upper case character that the lower case character will map to.
235 ></LI
236 ><LI
239 CLASS="COMMAND"
240 >map upper to lower</B
241 > which
242 is a boolean value (put either True or False here) which tells
243 Samba if it is to map the given upper case character to the
244 given lower case character when lower casing a filename.
246 ></LI
247 ><LI
250 CLASS="COMMAND"
251 >map lower to upper</B
252 > which
253 is a boolean value (put either True or False here) which tells
254 Samba if it is to map the given lower case character to the
255 given upper case character when upper casing a filename.
257 ></LI
258 ></UL
261 CLASS="COMMAND"
262 >codepage.&#60;codepage&#62;</B
263 > - These are the
264 output (binary) codepage files produced and placed in the Samba
265 destination <TT
266 CLASS="FILENAME"
267 >lib/codepage</TT
268 > directory. </P
269 ></DIV
270 ><DIV
271 CLASS="REFSECT1"
273 NAME="AEN81"
274 ></A
275 ><H2
276 >Installation</H2
278 >The location of the server and its support files is a
279 matter for individual system administrators. The following are
280 thus suggestions only. </P
282 >It is recommended that the <B
283 CLASS="COMMAND"
284 >make_smbcodepage
286 > program be installed under the <TT
287 CLASS="FILENAME"
288 >/usr/local/samba
289 </TT
290 > hierarchy, in a directory readable by all, writeable
291 only by root. The program itself should be executable by all. The
292 program should NOT be setuid or setgid! </P
293 ></DIV
294 ><DIV
295 CLASS="REFSECT1"
297 NAME="AEN87"
298 ></A
299 ><H2
300 >VERSION</H2
302 >This man page is correct for version 2.2 of
303 the Samba suite.</P
304 ></DIV
305 ><DIV
306 CLASS="REFSECT1"
308 NAME="AEN90"
309 ></A
310 ><H2
311 >SEE ALSO</H2
314 HREF="smbd.8.html"
315 TARGET="_top"
317 CLASS="COMMAND"
318 >smbd(8)</B
319 ></A
322 HREF="smb.conf.5.html"
323 TARGET="_top"
324 >smb.conf(5)</A
327 ></DIV
328 ><DIV
329 CLASS="REFSECT1"
331 NAME="AEN96"
332 ></A
333 ><H2
334 >AUTHOR</H2
336 >The original Samba software and related utilities
337 were created by Andrew Tridgell. Samba is now developed
338 by the Samba Team as an Open Source project similar
339 to the way the Linux kernel is developed.</P
341 >The original Samba man pages were written by Karl Auer.
342 The man page sources were converted to YODL format (another
343 excellent piece of Open Source software, available at
345 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
346 TARGET="_top"
347 > ftp://ftp.icce.rug.nl/pub/unix/</A
348 >) and updated for the Samba 2.0
349 release by Jeremy Allison. The conversion to DocBook for
350 Samba 2.2 was done by Gerald Carter</P
351 ></DIV
352 ></BODY
353 ></HTML