man5/repertoiremap.5

   1 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   2 .\" This is free documentation; you can redistribute it and/or
   3 .\" modify it under the terms of the GNU General Public License as
   4 .\" published by the Free Software Foundation; either version 2 of
   5 .\" the License, or (at your option) any later version.
   6 .\"
   7 .\" The GNU General Public License's references to "object code"
   8 .\" and "executables" are to be interpreted as the output of any
   9 .\" document formatting or typesetting system, including
  10 .\" intermediate and printed output.
  11 .\"
  12 .\" This manual 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
  18 .\" License along with this manual; if not, see
  19 .\" <http://www.gnu.org/licenses/>.
  20 .\" %%%LICENSE_END
  21 .\"
  22 .TH REPERTOIREMAP 5 2020-06-09 "GNU" "Linux User Manual"
  23 .SH NAME
  24 repertoiremap \- map symbolic character names to Unicode code points
  25 .SH DESCRIPTION
  26 A repertoire map defines mappings between symbolic character names
  27 (mnemonics) and Unicode code points when compiling a locale with
  28 .BR localedef (1).
  29 Using a repertoire map is optional, it is needed only when symbolic
  30 names are used instead of now preferred Unicode code points.
  31 .SS Syntax
  32 The repertoiremap file starts with a header that may consist of the
  33 following keywords:
  34 .TP
  35 .I comment_char
  36 is followed by a character that will be used as the
  37 comment character for the rest of the file.
  38 It defaults to the number sign (#).
  39 .TP
  40 .I escape_char
  41 is followed by a character that should be used as the escape character
  42 for the rest of the file to mark characters that should be interpreted
  43 in a special way.
  44 It defaults to the backslash (\e).
  45 .PP
  46 The mapping section starts with the keyword
  47 .I CHARIDS
  48 in the first column.
  49 .PP
  50 The mapping lines have the following form:
  51 .TP
  52 .I <symbolic-name> <code-point> comment
  53 This defines exactly one mapping,
  54 .I comment
  55 being optional.
  56 .PP
  57 The mapping section ends with the string
  58 .IR "END CHARIDS" .
  59 .SH FILES
  60 .TP
  61 .I /usr/share/i18n/repertoiremaps
  62 Usual default repertoire map path.
  63 .SH CONFORMING TO
  64 POSIX.2.
  65 .SH NOTES
  66 Repertoire maps are deprecated in favor of Unicode code points.
  67 .SH EXAMPLES
  68 A mnemonic for the Euro sign can be defined as follows:
  69 .PP
  70 .nf
  71 <Eu> <U20AC> EURO SIGN
  72 .fi
  73 .SH SEE ALSO
  74 .BR locale (1),
  75 .BR localedef (1),
  76 .BR charmap (5),
  77 .BR locale (5)