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