1194a2909b016071c56261a15f788501ae495385
[samba.git] / docs / yodldocs / make_smbcodepage.1.yo
1 mailto(samba-bugs@samba.anu.edu.au) 
2
3 manpage(make_smbcodepage)(1)(23 Oct 1998)(Samba)(SAMBA)
4
5 manpagename(make_codepage)(Construct a codepage file for Samba)
6
7 manpagesynopsis() 
8
9 bf(make_smbcodepage) [c|d] codepage inputfile outputfile
10
11 manpagedescription()
12
13 This program is part of the bf(Samba) suite.
14
15 bf(make_smbcodepage) compiles or de-compiles codepage files for use
16 with the internationalization features of Samba 2.0
17
18 manpageoptions()
19
20 startdit()
21
22 dit(c|d) This tells make_smbcodepage if it is compiling (c) a text
23 format code page file to binary, or (d) de-compiling a binary codepage
24 file to text.
25
26 dit(codepage) This is the codepage we are processing (a number, eg. 850).
27
28 dit(inputfile) This is the input file to process. In the 'c' case this
29 will be a text codepage definition file such as the ones found in the
30 Samba em(source/codepages) directory. In the 'd' case this will be the
31 binary format codepage definition file normally found in the
32 em(lib/codepages) directory in the Samba install directory path.
33
34 dit(outputfile) This is the output file to produce.
35
36 endit()
37
38 manpagesection(Samba Codepage files)
39
40 A text Samba codepage definition file is a description that tells
41 Samba how to map from upper to lower case for characters greater than
42 ascii 127 in the specified DOS code page.  Note that for certain DOS
43 codepages (437 for example) mapping from lower to upper case may be
44 asynchronous. For example, in code page 437 lower case a acute maps to
45 a plain upper case A when going from lower to upper case, but maps
46 from plain upper case A to plain lower case a when lower casing a
47 character.
48
49 A binary Samba codepage definition file is a binary representation of
50 the same information, including a value that specifies what codepage
51 this file is describing.
52
53 As Samba does not yet use UNICODE (current for Samba version 2.0) you
54 must specify the client code page that your DOS and Windows clients
55 are using if you wish to have case insensitivity done correctly for
56 your particular language. The default codepage Samba uses is 850
57 (Western European). Text codepage definition sample files are
58 provided in the Samba distribution for codepages 437 (USA), 737
59 (Greek), 850 (Western European) 852 (MS-DOS Latin 2), 861 (Icelandic),
60 866 (Cyrillic), 932 (Kanji SJIS), 936 (Simplified Chinese), 949
61 (Hangul) and 950 (Traditional Chinese). Users are encouraged to write
62 text codepage definition files for their own code pages and donate
63 them to email(samba-bugs@samba.anu.edu.au). All codepage files in the
64 Samba em(source/codepages) directory are compiled and installed when a
65 em('make install') command is issued there.
66
67 manpagefiles()
68
69 bf(codepage_def.<codepage>)
70
71 These are the input (text) codepage files provided in the Samba
72 em(source/codepages) directory.
73
74 A text codepage definition file consists of multiple lines
75 containing four fields. These fields are : 
76
77 startit()
78
79 it() bf(lower): which is the (hex) lower case character mapped on this
80 line.
81
82 it() bf(upper): which is the (hex) upper case character that the lower
83 case character will map to.
84
85 it() bf(map upper to lower) which is a boolean value (put either True
86 or False here) which tells Samba if it is to map the given upper case
87 character to the given lower case character when lower casing a
88 filename.
89
90 it() bf(map lower to upper) which is a boolean value (put either True
91 or False here) which tells Samba if it is to map the given lower case
92 character to the given upper case character when upper casing a
93 filename.
94
95 endit()
96
97 bf(codepage.<codepage>) These are the output (binary) codepage files
98 produced and placed in the Samba destination em(lib/codepage)
99 directory.
100
101 manpagesection(INSTALLATION)
102
103 The location of the server and its support files is a matter for
104 individual system administrators. The following are thus suggestions
105 only.
106
107 It is recommended that the bf(make_smbcodepage) program be installed
108 under the em(/usr/local/samba) hierarchy, in a directory readable by
109 all, writeable only by root. The program itself should be executable
110 by all.  The program should NOT be setuid or setgid!
111
112 manpagesection(VERSION)
113
114 This man page is correct for version 2.0 of the Samba
115 suite, plus some of the recent patches to it. These notes will
116 necessarily lag behind development of the software, so it is possible
117 that your version of the program has extensions or parameter semantics
118 that differ from or are not covered by this man page. Please notify
119 these to the address below for rectification.
120
121 manpageseealso()
122
123 bf(smb.conf)(5), bf(smbd) (8)
124
125 manpageauthor() 
126
127 The bf(make_smbcodepage) program was written by Jeremy Allison (email
128 email(samba-bugs@samba.anu.edu.au)) as part of the
129 internationalization effort of the Samba software package.
130
131 Please send bug reports to email(samba-bugs@samba.anu.edu.au).