]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright (C) 1994 Jochen Hein (Hein@Student.TU-Clausthal.de) |
2 | .\" | |
f0008367 | 3 | .\" %%%LICENSE_START(GPLv2+_SW_3_PARA) |
fea681da MK |
4 | .\" This program is free software; you can redistribute it and/or modify |
5 | .\" it under the terms of the GNU General Public License as published by | |
6 | .\" the Free Software Foundation; either version 2 of the License, or | |
7 | .\" (at your option) any later version. | |
8 | .\" | |
9 | .\" This program is distributed in the hope that it will be useful, | |
10 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | .\" GNU General Public License for more details. | |
13 | .\" | |
c715f741 MK |
14 | .\" You should have received a copy of the GNU General Public |
15 | .\" License along with this manual; if not, see | |
16 | .\" <http://www.gnu.org/licenses/>. | |
8ff7380d | 17 | .\" %%%LICENSE_END |
fea681da | 18 | .\" |
3df541c0 | 19 | .TH CHARMAP 5 2016-07-17 "GNU" "Linux Programmer's Manual" |
fea681da | 20 | .SH NAME |
66676c91 | 21 | charmap \- character set description file |
fea681da | 22 | .SH DESCRIPTION |
83d1d0dd MM |
23 | A character set description (charmap) defines all available characters |
24 | and their encodings in a character set. | |
66676c91 MM |
25 | .BR localedef (1) |
26 | can use charmaps to create locale variants for different character sets. | |
1ce284ec | 27 | .SS Syntax |
83d1d0dd | 28 | The charmap file starts with a header that may consist of the |
fea681da MK |
29 | following keywords: |
30 | .TP | |
2c0cac3e | 31 | .RI < code_set_name > |
83d1d0dd MM |
32 | is followed by the name of the character map. |
33 | .TP | |
2c0cac3e | 34 | .RI < comment_char > |
83d1d0dd MM |
35 | is followed by a character that will be used as the comment character |
36 | for the rest of the file. | |
37 | It defaults to the number sign (#). | |
38 | .TP | |
2c0cac3e | 39 | .RI < escape_char > |
83d1d0dd MM |
40 | is followed by a character that should be used as the escape character |
41 | for the rest of the file to mark characters that should be interpreted | |
42 | in a special way. | |
43 | It defaults to the backslash (\\). | |
fea681da | 44 | .TP |
2c0cac3e | 45 | .RI < mb_cur_max > |
83d1d0dd MM |
46 | is followed by the maximum number of bytes for a character. |
47 | The default value is 1. | |
fea681da | 48 | .TP |
2c0cac3e | 49 | .RI < mb_cur_min > |
83d1d0dd MM |
50 | is followed by the minimum number of bytes for a character. |
51 | This value must be less than or equal than | |
2c0cac3e | 52 | .RI < mb_cur_max >. |
fea681da | 53 | If not specified, it defaults to |
2c0cac3e | 54 | .RI < mb_cur_max >. |
fea681da | 55 | .PP |
83d1d0dd | 56 | The character set definition section starts with the keyword |
89fca342 | 57 | .I CHARMAP |
83d1d0dd | 58 | in the first column. |
2dad4c59 | 59 | .PP |
fea681da | 60 | The following lines may have one of the two following forms to |
83d1d0dd | 61 | define the character set: |
fea681da | 62 | .TP |
2c0cac3e | 63 | .RI < character >\ byte-sequence\ comment |
83d1d0dd | 64 | This form defines exactly one character and its byte sequence, |
28ad474d | 65 | .I comment |
83d1d0dd | 66 | being optional. |
fea681da | 67 | .TP |
2c0cac3e | 68 | .RI < character >..< character >\ byte-sequence\ comment |
83d1d0dd | 69 | This form defines a character range and its byte sequence, |
28ad474d | 70 | .I comment |
83d1d0dd | 71 | being optional. |
fea681da | 72 | .PP |
83d1d0dd MM |
73 | The character set definition section ends with the string |
74 | .IR "END CHARMAP" . | |
75 | .PP | |
76 | The character set definition section may optionally be followed by a | |
77 | section to define widths of characters. | |
78 | .PP | |
66676c91 | 79 | The |
28ad474d | 80 | .I WIDTH_DEFAULT |
66676c91 MM |
81 | keyword can be used to define the default width for all characters |
82 | not explicitly listed. | |
83 | The default character width is 1. | |
84 | .PP | |
85 | The width section for individual characters starts with the keyword | |
89fca342 | 86 | .I WIDTH |
83d1d0dd | 87 | in the first column. |
2dad4c59 | 88 | .PP |
83d1d0dd MM |
89 | The following lines may have one of the two following forms to |
90 | define the widths of the characters: | |
fea681da | 91 | .TP |
2c0cac3e | 92 | .RI < character >\ width |
83d1d0dd | 93 | This form defines the width of exactly one character. |
fea681da | 94 | .TP |
2c0cac3e | 95 | .RI < character >...< character >\ width |
83d1d0dd MM |
96 | This form defines the width for all the characters in the range. |
97 | .PP | |
98 | The width definition section ends with the string | |
99 | .IR "END WIDTH" . | |
fea681da | 100 | .SH FILES |
83d1d0dd MM |
101 | .TP |
102 | .I /usr/share/i18n/charmaps | |
103 | Usual default character map path. | |
47297adb | 104 | .SH CONFORMING TO |
44a2c328 | 105 | POSIX.2. |
83d1d0dd MM |
106 | .SH EXAMPLE |
107 | The Euro sign is defined as follows in the | |
108 | .I UTF\-8 | |
109 | charmap: | |
110 | .PP | |
111 | .nf | |
28ad474d | 112 | <U20AC> /xe2/x82/xac EURO SIGN |
83d1d0dd | 113 | .fi |
47297adb | 114 | .SH SEE ALSO |
83d1d0dd | 115 | .BR iconv (1), |
fea681da MK |
116 | .BR locale (1), |
117 | .BR localedef (1), | |
83d1d0dd MM |
118 | .BR locale (5), |
119 | .BR charsets (7) |