Learned about the label() and link() commands and how to use url()
[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(Samba Codepage files)
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 label(FILES)
73 manpagefiles()
74
75 bf(codepage_def.<codepage>)
76
77 These are the input (text) codepage files provided in the Samba
78 em(source/codepages) directory.
79
80 A text codepage definition file consists of multiple lines
81 containing four fields. These fields are : 
82
83 startit()
84
85 it() bf(lower): which is the (hex) lower case character mapped on this
86 line.
87
88 it() bf(upper): which is the (hex) upper case character that the lower
89 case character will map to.
90
91 it() bf(map upper to lower) which is a boolean value (put either True
92 or False here) which tells Samba if it is to map the given upper case
93 character to the given lower case character when lower casing a
94 filename.
95
96 it() bf(map lower to upper) which is a boolean value (put either True
97 or False here) which tells Samba if it is to map the given lower case
98 character to the given upper case character when upper casing a
99 filename.
100
101 endit()
102
103 bf(codepage.<codepage>) These are the output (binary) codepage files
104 produced and placed in the Samba destination em(lib/codepage)
105 directory.
106
107 label(INSTALLATION)
108 manpagesection(INSTALLATION)
109
110 The location of the server and its support files is a matter for
111 individual system administrators. The following are thus suggestions
112 only.
113
114 It is recommended that the bf(make_smbcodepage) program be installed
115 under the em(/usr/local/samba) hierarchy, in a directory readable by
116 all, writeable only by root. The program itself should be executable
117 by all.  The program should NOT be setuid or setgid!
118
119 label(VERSION)
120 manpagesection(VERSION)
121
122 This man page is correct for version 2.0 of the Samba
123 suite, plus some of the recent patches to it. These notes will
124 necessarily lag behind development of the software, so it is possible
125 that your version of the program has extensions or parameter semantics
126 that differ from or are not covered by this man page. Please notify
127 these to the address below for rectification.
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 bf(make_smbcodepage) program was written by Jeremy Allison (email
138 email(samba-bugs@samba.anu.edu.au)) as part of the
139 internationalization effort of the Samba software package.
140
141 Please send bug reports to email(samba-bugs@samba.anu.edu.au).