original/man5/charmap.5

   1 .\" This file is part of locale(1) which displays the settings of the
   2 .\" current locale.
   3 .\" Copyright (C) 1994  Jochen Hein (Hein@Student.TU-Clausthal.de)
   4 .\"
   5 .\" %%%LICENSE_START(GPLv2+_SW_3_PARA)
   6 .\" This program is free software; you can redistribute it and/or modify
   7 .\" it under the terms of the GNU General Public License as published by
   8 .\" the Free Software Foundation; either version 2 of the License, or
   9 .\" (at your option) any later version.
  10 .\"
  11 .\" This program is distributed in the hope that it will be useful,
  12 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 .\" GNU General Public License for more details.
  15 .\"
  16 .\" You should have received a copy of the GNU General Public
  17 .\" License along with this manual; if not, see
  18 .\" <http://www.gnu.org/licenses/>.
  19 .\" %%%LICENSE_END
  20 .\"
  21 .TH CHARMAP 5 1994-11-28 "" "Linux User Manual"
  22 .SH NAME
  23 charmap \- character symbols to define character encodings
  24 .SH DESCRIPTION
  25 A character set description (charmap) defines a character set of
  26 available characters and their encodings.
  27 All supported character
  28 sets should have the
  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 .SS 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.
  45 Multibyte characters are currently not supported.
  46 The default value
  47 is 1.
  48 .TP
  49 .I <mb_cur_min>
  50 is followed by the min number of bytes for a character.
  51 This
  52 value must be less than or equal than
  53 .BR mb_cur_max .
  54 If not specified, it defaults to
  55 .BR mb_cur_max .
  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
  60 should be interpreted in a special way.
  61 It defaults to
  62 the backslash (
  63 .B \\\\
  64 ).
  65 .TP
  66 .I <comment_char>
  67 is followed by a character that will be used as the
  68 comment-character for the rest of the file.
  69 It defaults to the
  70 number sign (
  71 .B #
  72 ).
  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>
  82 This form defines exactly one character and its encoding.
  83 .TP
  84 .I <symbolic-name>...<symbolic-name> <encoding> <comments>
  85 This form defines a couple of characters.
  86 This is useful only for
  87 multibyte-characters, which are currently not implemented.
  88 .PP
  89 The last line in a charmap-definition file must contain
  90 .B END CHARMAP.
  91 .SS Symbolic names
  92 A
  93 .B symbolic name
  94 for a character contains only characters of the
  95 .B portable character set.
  96 The name itself is enclosed between angle brackets.
  97 Characters following an
  98 .B <escape_char>
  99 are interpreted as itself; for example, the sequence
 100 .B "<\\\\\\\\\\\\>>"
 101 represents the symbolic name
 102 .B "\\\\>"
 103 enclosed in angle brackets.
 104 .SS 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>
 112 with a hexadecimal number
 113 .TP
 114 .I <escape_char><number>
 115 with an octal number.
 116 .\" FIXME comments
 117 .\" FIXME char ... char
 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)
 130 .SH COLOPHON
 131 This page is part of release 3.67 of the Linux
 132 .I man-pages
 133 project.
 134 A description of the project,
 135 information about reporting bugs,
 136 and the latest version of this page,
 137 can be found at
 138 \%http://www.kernel.org/doc/man\-pages/.