preparing for release of 2.2.0-alpha2
[Samba/ekacnet.git] / docs / manpages / make_unicodemap.1
bloba842691a641721e25a0e747b3654738abea9cb37
1 .TH MAKE_UNICODEMAP 1 "30 Jan 2001" "make_unicodemap 2.2.0-alpha2"
2 .PP 
3 .SH "NAME" 
4 make_unicodemap \- Construct a unicode map file for Samba
5 .PP 
6 .SH "SYNOPSIS" 
7 .PP 
8 \fBmake_unicodemap\fP codepage inputfile outputfile
9 .PP 
10 .SH "DESCRIPTION" 
11 .PP 
12 This program is part of the \fBSamba\fP suite\&.
13 .PP 
14 \fBmake_unicodemap\fP compiles text unicode map files into binary unicode
15 map files for use with the internationalization features of Samba 2\&.0
16 .PP 
17 .SH "OPTIONS" 
18 .PP 
19 .IP 
20 .IP "codepage" 
21 This is the codepage or UNIX character set we are processing (a number, e\&.g\&. 850)\&.
22 .IP 
23 .IP "inputfile" 
24 This is the input file to process\&. This is a text unicode map file
25 such as the ones found in the Samba \fIsource/codepages\fP directory\&.
26 .IP 
27 .IP "outputfile" 
28 This is the binary output file to produce\&.
29 .IP 
30 .PP 
31 .SH "Samba Unicode Map Files" 
32 .PP 
33 A text Samba unicode map file is a description that tells
34 Samba how to map characters from a specified DOS code page or UNIX character
35 set to 16 bit unicode\&.
36 .PP 
37 A binary Samba unicode map file is a binary representation of
38 the same information, including a value that specifies what codepage
39 or UNIX character set this file is describing\&.
40 .PP 
41 .SH "FILES" 
42 .PP 
43 \fBCP<codepage>\&.TXT\fP
44 .PP 
45 These are the input (text) unicode map files provided in the Samba
46 \fIsource/codepages\fP directory\&.
47 .PP 
48 A text unicode map file consists of multiple lines
49 containing two fields\&. These fields are : 
50 .PP 
51 .IP 
52 .IP o 
53 \fBcharacter\fP: which is the (hex) character mapped on this
54 line\&.
55 .IP 
56 .IP o 
57 \fBunicode\fP: which is the (hex) 16 bit unicode character that the
58 character will map to\&.
59 .IP 
60 .PP 
61 \fBunicode_map\&.<codepage>\fP These are the output (binary) unicode map files
62 produced and placed in the Samba destination \fIlib/codepage\fP
63 directory\&.
64 .PP 
65 .SH "INSTALLATION" 
66 .PP 
67 The location of the server and its support files is a matter for
68 individual system administrators\&. The following are thus suggestions
69 only\&.
70 .PP 
71 It is recommended that the \fBmake_unicodemap\fP program be installed
72 under the \fI/usr/local/samba\fP hierarchy, in a directory readable by
73 all, writeable only by root\&. The program itself should be executable
74 by all\&.  The program should NOT be setuid or setgid!
75 .PP 
76 .SH "VERSION" 
77 .PP 
78 This man page is correct for version 2\&.0 of the Samba suite\&.
79 .PP 
80 .SH "SEE ALSO" 
81 .PP 
82 \fBsmb\&.conf(5)\fP, \fBsmbd (8)\fP
83 .PP 
84 .SH "AUTHOR" 
85 .PP 
86 The original Samba software and related utilities were created by
87 Andrew Tridgell samba@samba\&.org\&. Samba is now developed
88 by the Samba Team as an Open Source project similar to the way the
89 Linux kernel is developed\&.
90 .PP 
91 The original Samba man pages were written by Karl Auer\&. The man page
92 sources were converted to YODL format (another excellent piece of Open
93 Source software, available at
94 \fBftp://ftp\&.icce\&.rug\&.nl/pub/unix/\fP)
95 and updated for the Samba2\&.0 release by Jeremy Allison\&.
96 samba@samba\&.org\&.
97 .PP 
98 See \fBsamba (7)\fP to find out how to get a full
99 list of contributors and details on how to submit bug reports,
100 comments etc\&.