[thirdparty/man-pages.git] / man5 / repertoiremap.5

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