]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Hey emacs, this is -*- nroff -*- |
2 | .\" | |
c13182ef | 3 | .\" This file is part of locale(1) which displays the settings of the |
fea681da MK |
4 | .\" current locale. |
5 | .\" Copyright (C) 1994 Jochen Hein (Hein@Student.TU-Clausthal.de) | |
6 | .\" | |
7 | .\" This program is free software; you can redistribute it and/or modify | |
8 | .\" it under the terms of the GNU General Public License as published by | |
9 | .\" the Free Software Foundation; either version 2 of the License, or | |
10 | .\" (at your option) any later version. | |
11 | .\" | |
12 | .\" This program is distributed in the hope that it will be useful, | |
13 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | .\" GNU General Public License for more details. | |
16 | .\" | |
17 | .\" You should have received a copy of the GNU General Public License | |
18 | .\" along with this program; if not, write to the Free Software | |
19 | .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA. | |
20 | .\" | |
21 | .TH CHARMAP 5 1994-11-28 "National Language Support" "Linux User Manual" | |
22 | .SH NAME | |
23 | charmap \- character symbols to define character encodings | |
24 | .SH DESCRIPTION | |
9fdfa163 | 25 | A character set description (charmap) defines a character set of |
c13182ef MK |
26 | available characters and their encodings. |
27 | All supported character | |
28 | sets should have the | |
fea681da MK |
29 | .B portable character set |
30 | as a proper subset. | |
31 | .\" Not true anymore: | |
32 | .\" The portable character set is defined in the file | |
33 | .\" .I /usr/lib/nls/charmap/POSIX | |
34 | .\" .I /usr/share/i18n/charmap/POSIX | |
35 | .\" for reference purposes. | |
36 | .SH SYNTAX | |
37 | The charmap file starts with a header, that may consist of the | |
38 | following keywords: | |
39 | .TP | |
40 | .I <codeset> | |
41 | is followed by the name of the codeset. | |
42 | .TP | |
43 | .I <mb_cur_max> | |
44 | is followed by the max number of bytes for a multibyte-character. | |
c13182ef MK |
45 | Multibyte characters are currently not supported. |
46 | The default value | |
fea681da MK |
47 | is 1. |
48 | .TP | |
49 | .I <mb_cur_min> | |
c13182ef MK |
50 | is followed by the min number of bytes for a character. |
51 | This | |
52 | value must be less or equal than | |
a5e0a0e4 | 53 | .BR mb_cur_max . |
fea681da | 54 | If not specified, it defaults to |
a5e0a0e4 | 55 | .BR mb_cur_max . |
fea681da MK |
56 | .TP |
57 | .I <escape_char> | |
58 | is followed by a character that should be used as the | |
59 | escape-character for the rest of the file to mark characters that | |
c13182ef MK |
60 | should be interpreted in a special way. |
61 | It defaults to | |
fea681da | 62 | the backslash ( |
c13182ef | 63 | .B \\\\ |
fea681da MK |
64 | ). |
65 | .TP | |
66 | .I <comment_char> | |
67 | is followed by a character that will be used as the | |
c13182ef MK |
68 | comment-character for the rest of the file. |
69 | It defaults to the | |
fea681da MK |
70 | number sign ( |
71 | .B # | |
72 | ). | |
fea681da MK |
73 | .PP |
74 | The charmap-definition itself starts with the keyword | |
75 | .B CHARMAP | |
76 | in column 1. | |
77 | ||
78 | The following lines may have one of the two following forms to | |
79 | define the character-encodings: | |
80 | .TP | |
81 | .I <symbolic-name> <encoding> <comments> | |
c13182ef | 82 | This form defines exactly one character and its encoding. |
fea681da MK |
83 | .TP |
84 | .I <symbolic-name>...<symbolic-name> <encoding> <comments> | |
c13182ef MK |
85 | This form defines a couple of characters. |
86 | This is only useful for | |
fea681da | 87 | mutlibyte-characters, which are currently not implemented. |
fea681da MK |
88 | .PP |
89 | The last line in a charmap-definition file must contain | |
90 | .B END CHARMAP. | |
91 | .SH "SYMBOLIC NAMES" | |
c13182ef | 92 | A |
fea681da | 93 | .B symbolic name |
c13182ef | 94 | for a character contains only characters of the |
fea681da MK |
95 | .B portable character set. |
96 | The name itself is enclosed between angle brackets. | |
97 | Characters following an | |
c13182ef | 98 | .B <escape_char> |
fea681da MK |
99 | are interpreted as itself; for example, the sequence |
100 | .B '<\\\\\\\\\\\\>>' | |
101 | represents the symbolic name | |
102 | .B '\\\\>' | |
103 | enclosed in angle brackets. | |
104 | .SH "CHARACTER ENCODING" | |
105 | The | |
106 | encoding may be in each of the following three forms: | |
107 | .TP | |
108 | .I <escape_char>d<number> | |
109 | with a decimal number | |
110 | .TP | |
111 | .I <escape_char>x<number> | |
c13182ef | 112 | with a hexadecimal number |
fea681da MK |
113 | .TP |
114 | .I <escape_char><number> | |
115 | with an octal number. | |
218e46f8 MK |
116 | .\" FIXME comments |
117 | .\" FIXME char ... char | |
fea681da MK |
118 | .SH FILES |
119 | .I /usr/share/i18n/charmaps/* | |
120 | .SH AUTHOR | |
121 | Jochen Hein (jochen.hein@delphi.central.de) | |
122 | .SH "CONFORMING TO" | |
123 | POSIX.2 | |
124 | .SH "SEE ALSO" | |
125 | .BR locale (1), | |
126 | .BR localedef (1), | |
127 | .BR localeconv (3), | |
128 | .BR setlocale (3), | |
129 | .BR locale (5) |