original/man5/charmap.5

   1 .\" Copyright (C) 1994  Jochen Hein (Hein@Student.TU-Clausthal.de)
   2 .\"
   3 .\" %%%LICENSE_START(GPLv2+_SW_3_PARA)
   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 .\"
  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/>.
  17 .\" %%%LICENSE_END
  18 .\"
  19 .TH CHARMAP 5 2014-07-08 "GNU" "Linux Programmer's Manual"
  20 .SH NAME
  21 charmap \- character set description file
  22 .SH DESCRIPTION
  23 A character set description (charmap) defines all available characters
  24 and their encodings in a character set.
  25 .BR localedef (1)
  26 can use charmaps to create locale variants for different character sets.
  27 .SS Syntax
  28 The charmap file starts with a header that may consist of the
  29 following keywords:
  30 .TP
  31 .I <code_set_name>
  32 is followed by the name of the character map.
  33 .TP
  34 .I <comment_char>
  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
  39 .I <escape_char>
  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 (\\).
  44 .TP
  45 .I <mb_cur_max>
  46 is followed by the maximum number of bytes for a character.
  47 The default value is 1.
  48 .TP
  49 .I <mb_cur_min>
  50 is followed by the minimum number of bytes for a character.
  51 This value must be less than or equal than
  52 .IR mb_cur_max .
  53 If not specified, it defaults to
  54 .IR mb_cur_max .
  55 .PP
  56 The character set definition section starts with the keyword
  57 .B CHARMAP
  58 in the first column.
  59
  60 The following lines may have one of the two following forms to
  61 define the character set:
  62 .TP
  63 .I <character> <byte-sequence> <comment>
  64 This form defines exactly one character and its byte sequence,
  65 .I <comment>
  66 being optional.
  67 .TP
  68 .I <character>..<character> <byte-sequence> <comment>
  69 This form defines a character range and its byte sequence,
  70 .I <comment>
  71 being optional.
  72 .PP
  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
  79 The
  80 .B WIDTH_DEFAULT
  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
  86 .B WIDTH
  87 in the first column.
  88
  89 The following lines may have one of the two following forms to
  90 define the widths of the characters:
  91 .TP
  92 .I <character> <width>
  93 This form defines the width of exactly one character.
  94 .TP
  95 .I <character>...<character> <width>
  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" .
 100 .SH FILES
 101 .TP
 102 .I /usr/share/i18n/charmaps
 103 Usual default character map path.
 104 .SH CONFORMING TO
 105 POSIX.2.
 106 .SH EXAMPLE
 107 The Euro sign is defined as follows in the
 108 .I UTF\-8
 109 charmap:
 110 .PP
 111 .nf
 112 <U20AC>     /xe2/x82/xac
 113 .fi
 114 .SH SEE ALSO
 115 .BR iconv (1),
 116 .BR locale (1),
 117 .BR localedef (1),
 118 .BR locale (5),
 119 .BR charsets (7)
 120 .SH COLOPHON
 121 This page is part of release 3.79 of the Linux
 122 .I man-pages
 123 project.
 124 A description of the project,
 125 information about reporting bugs,
 126 and the latest version of this page,
 127 can be found at
 128 \%http://www.kernel.org/doc/man\-pages/.