fixed bad link noticed by Martin Schwenke
[Samba.git] / docs / manpages / make_unicodemap.1
blobac9e5f89edc7e8ae3d59a7fb702da8571d3d4d33
1 .\" This manpage has been automatically generated by docbook2man-spec
2 .\" from a DocBook document.  docbook2man-spec can be found at:
3 .\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> 
4 .\" Please send any bug reports, improvements, comments, patches, 
5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
6 .TH "MAKE_UNICODEMAP" "1" "09 July 2001" "" ""
7 .SH NAME
8 make_unicodemap \- construct a unicode map file for Samba
9 .SH SYNOPSIS
10 .sp
11 \fBmake_unicodemap\fR \fBcodepage\fR \fBinputfile\fR \fBoutputfile\fR
12 .SH "DESCRIPTION"
13 .PP
14 This tool is part of the Samba
15 suite.
16 .PP
17 \fBmake_unicodemap\fR compiles text unicode map 
18 files into binary unicode map files for use with the 
19 internationalization features of Samba 2.2.
20 .SH "OPTIONS"
21 .TP
22 \fBcodepage\fR
23 This is the codepage or UNIX character 
24 set we are processing (a number, e.g. 850).
25 .TP
26 \fBinputfile\fR
27 This is the input file to process. This is a 
28 text unicode map file such as the ones found in the Samba
29 \fIsource/codepages\fR directory. 
30 .TP
31 \fBoutputfile\fR
32 This is the binary output file to produce. 
33 .SH "SAMBA UNICODE MAP FILES"
34 .PP
35 A text Samba unicode map file is a description that tells Samba 
36 how to map characters from a specified DOS code page or UNIX character 
37 set to 16 bit unicode.
38 .PP
39 A binary Samba unicode map file is a binary representation 
40 of the same information, including a value that specifies what 
41 codepage or UNIX character set this file is describing. 
42 .SH "FILES"
43 .PP
44 \fICP<codepage>.TXT\fR
45 .PP
46 These are the input (text) unicode map files provided 
47 in the Samba \fIsource/codepages\fR 
48 directory. 
49 .PP
50 A text unicode map file consists of multiple lines 
51 containing two fields. These fields are : 
52 .TP 0.2i
53 \(bu
54 \fIcharacter\fR - which is 
55 the (hex) character mapped on this line.
56 .TP 0.2i
57 \(bu
58 \fIunicode\fR - which 
59 is the (hex) 16 bit unicode character that the character
60 will map to. 
61 .PP
62 \fIunicode_map.<codepage>\fR - These are 
63 the output (binary) unicode map files produced and placed in 
64 the Samba destination \fIlib/codepage\fR 
65 directory.
66 .PP
67 .SH "INSTALLATION"
68 .PP
69 The location of the server and its support files is a matter
70 for individual system administrators. The following are thus 
71 suggestions only. 
72 .PP
73 It is recommended that the \fBmake_unicodemap\fR 
74 program be installed under the 
75 \fI$prefix/samba\fR hierarchy, 
76 in a directory readable by all, writeable only by root. The 
77 program itself should be executable by all. The program
78 should NOT be setuid or setgid! 
79 .SH "VERSION"
80 .PP
81 This man page is correct for version 2.2 of 
82 the Samba suite.
83 .SH "SEE ALSO"
84 .PP
85 \fBsmbd(8)\fR, 
86 smb.conf(5)
87 .SH "AUTHOR"
88 .PP
89 The original Samba software and related utilities 
90 were created by Andrew Tridgell. Samba is now developed
91 by the Samba Team as an Open Source project similar 
92 to the way the Linux kernel is developed.
93 .PP
94 The original Samba man pages were written by Karl Auer. 
95 The man page sources were converted to YODL format (another 
96 excellent piece of Open Source software, available at
97 ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://ftp.icce.rug.nl/pub/unix/>) and updated for the Samba 2.0 
98 release by Jeremy Allison. The conversion to DocBook for 
99 Samba 2.2 was done by Gerald Carter