man5/repertoiremap.5

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