preparing for release of 1.9.18alpha14
[Samba/ekacnet.git] / docs / manpages / make_smbcodepage.1
blob3f60fb115838c72312eb615800ca7e7823498c97
1 .TH MAKE_SMBCODEPAGE 1 "24 Dec 1997" "make_smbcodepage 1.9.18alpha14"
2 .SH NAME
3 make_smbcodepage \- create a binary codepage definition file from an ascii codepage definition source file, or reverse the process.
4 .SH SYNOPSIS
5 .B make_smbcodepage
6 .I c|d
7 .I codepage
8 .I inputfile
9 .I outputfile
10 .SH DESCRIPTION
11 This program is part of the Samba suite.
13 .B make_smbcodepage
14 compiles or de-compiles codepage files for use with the internationalization
15 features of Samba 1.9.18.
17 An ascii Samba codepage definition file is a description that tells Samba
18 how to map from upper to lower case for characters greater than ascii 127
19 in the specified DOS code page.  Note that for certain DOS codepages 
20 (437 for example) mapping from lower to upper case may be asynchronous. 
21 For example, in code page 437 lower case a acute maps to a plain upper 
22 case A when going from lower to upper case, but maps from plain upper 
23 case A to plain lower case a when lower casing a character.
25 A binary Samba codepage definition file is a binary representation
26 of the same information, including a value that specifies what codepage
27 this file is describing.
29 As Samba does not yet use UNICODE (current for Samba version 1.9.18)
30 you must specify the client code page that your DOS and Windows clients
31 are using if you wish to have case insensitivity done correctly for
32 your particular language. The default codepage Samba uses is 850
33 (Western European). Ascii codepage definition sample files are provided
34 in the Samba distribution for codepages 437 (USA), 850 (Western European)
35 852 (MS-DOS Latin 2) and 932 (Kanji SJIS). Users are encouraged to
36 write ascii codepage definition files for their own code pages and
37 donate them to samba-bugs@samba.anu.edu.au. All codepage files in the
38 Samba source directory are compiled and installed when a 'make install'
39 command is issued there.
41 An ascii codepage definition file consists of multiple lines containing
42 four fields. These fields are :
43 .B lower
44 which is the (hex) lower case character mapped on this line.
45 .B upper
46 which is the (hex) upper case character that the lower case character
47 will map to.
48 .B map upper to lower
49 which is a boolean value (put either True or False here) which tells
50 Samba if it is to map the given upper case character to the given
51 lower case character when lower casing a filename.
52 .B map lower to upper
53 which is a boolean value (put either True or False here) which tells
54 Samba if it is to map the given lower case character to the given
55 upper case character when upper casing a filename.
57 .SH OPTIONS
58 .I c|d
60 .RS 3
61 This tells make_smbcodepage if it is compiling (c) an ascii code page file
62 to binary, or de-compiling a binary codepage file to ascii.
63 .RE
65 .I codepage
67 .RS 3
68 This is the codepage we are processing (a number, eg. 850)
69 .RE
71 .I inputfile
73 .RS 3
74 This is the input file to process.
75 .RE
77 .I outputfile
79 .RS 3
80 This is the output file to produce.
81 .RE
83 .SH FILES
84 .B codepage_def.<codepage>
85 .RS 3
86 These are the input (ascii) codepage files provided in the Samba
87 source/ directory.
88 .RE
89 .SH FILES
90 .B codepage.<codepage>
91 .RS 3
92 These are the output (binary) codepage files produced and placed in the Samba
93 destination lib/codepage/ directory.
94 .RE 
96 .SH ENVIRONMENT VARIABLES
97 Not applicable.
98 .SH INSTALLATION
99 The location of the server and its support files is a matter for individual
100 system administrators. The following are thus suggestions only.
102 It is recommended that the
103 .B make_smbcodepage
104 program be installed under the /usr/local/samba hierarchy, in a directory readable
105 by all, writeable only by root. The program itself should be executable by all.
106 The program should NOT be setuid or setgid!
107 .SH VERSION
108 This man page is (mostly) correct for version 1.9.18 of the Samba suite, plus some
109 of the recent patches to it. These notes will necessarily lag behind 
110 development of the software, so it is possible that your version of 
111 the program has extensions or parameter semantics that differ from or are not 
112 covered by this man page. Please notify these to the address below for 
113 rectification.
114 .SH SEE ALSO
115 .BR smb.conf (5),
116 .BR smbd (8)
118 .SH BUGS
119 None known.
120 .SH CREDITS
122 .B make_smbcodepage
123 program was written by Jeremy Allison (jallison@whistle.com) as part of the 
124 Internationalization effort of the Samba software.
126 Please send bug reports to samba-bugs@samba.anu.edu.au.
129 .BR samba (7)
130 for a full list of contributors and details on how to 
131 submit bug reports, comments etc.