-.\" Hey emacs, this is -*- nroff -*-
-.\"
-.\" This file is part of locale(1) which displays the settings of the
-.\" current locale.
.\" Copyright (C) 1994 Jochen Hein (Hein@Student.TU-Clausthal.de)
.\"
+.\" %%%LICENSE_START(GPLv2+_SW_3_PARA)
.\" This program is free software; 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
.\" 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 program; if not, write to the Free Software
-.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
+.\" 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 CHARMAP 5 1994-11-28 "" "Linux User Manual"
+.TH CHARMAP 5 2016-07-17 "GNU" "Linux Programmer's Manual"
.SH NAME
-charmap \- character symbols to define character encodings
+charmap \- character set description file
.SH DESCRIPTION
-A character set description (charmap) defines a character set of
-available characters and their encodings.
-All supported character
-sets should have the
-.B portable character set
-as a proper subset.
-.\" Not true anymore:
-.\" The portable character set is defined in the file
-.\" .I /usr/lib/nls/charmap/POSIX
-.\" .I /usr/share/i18n/charmap/POSIX
-.\" for reference purposes.
-.SH SYNTAX
-The charmap file starts with a header, that may consist of the
+A character set description (charmap) defines all available characters
+and their encodings in a character set.
+.BR localedef (1)
+can use charmaps to create locale variants for different character sets.
+.SS Syntax
+The charmap file starts with a header that may consist of the
following keywords:
.TP
-.I <codeset>
-is followed by the name of the codeset.
+.RI < code_set_name >
+is followed by the name of the character map.
.TP
-.I <mb_cur_max>
-is followed by the max number of bytes for a multibyte-character.
-Multibyte characters are currently not supported.
-The default value
-is 1.
+.RI < 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 <mb_cur_min>
-is followed by the min number of bytes for a character.
-This
-value must be less or equal than
-.BR mb_cur_max .
-If not specified, it defaults to
-.BR mb_cur_max .
+.RI < 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 (\\).
.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 (
-.B \\\\
-).
+.RI < mb_cur_max >
+is followed by the maximum number of bytes for a character.
+The default value is 1.
.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 (
-.B #
-).
+.RI < mb_cur_min >
+is followed by the minimum number of bytes for a character.
+This value must be less than or equal than
+.RI < mb_cur_max >.
+If not specified, it defaults to
+.RI < mb_cur_max >.
.PP
-The charmap-definition itself starts with the keyword
-.B CHARMAP
-in column 1.
+The character set definition section starts with the keyword
+.I CHARMAP
+in the first column.
The following lines may have one of the two following forms to
-define the character-encodings:
+define the character set:
.TP
-.I <symbolic-name> <encoding> <comments>
-This form defines exactly one character and its encoding.
+.RI < character >\ byte-sequence\ comment
+This form defines exactly one character and its byte sequence,
+.I comment
+being optional.
.TP
-.I <symbolic-name>...<symbolic-name> <encoding> <comments>
-This form defines a couple of characters.
-This is only useful for
-multibyte-characters, which are currently not implemented.
+.RI < character >..< character >\ byte-sequence\ comment
+This form defines a character range and its byte sequence,
+.I comment
+being optional.
+.PP
+The character set definition section ends with the string
+.IR "END CHARMAP" .
+.PP
+The character set definition section may optionally be followed by a
+section to define widths of characters.
.PP
-The last line in a charmap-definition file must contain
-.B END CHARMAP.
-.SH "SYMBOLIC NAMES"
-A
-.B symbolic name
-for a character contains only characters of the
-.B portable character set.
-The name itself is enclosed between angle brackets.
-Characters following an
-.B <escape_char>
-are interpreted as itself; for example, the sequence
-.B '<\\\\\\\\\\\\>>'
-represents the symbolic name
-.B '\\\\>'
-enclosed in angle brackets.
-.SH "CHARACTER ENCODING"
The
-encoding may be in each of the following three forms:
-.TP
-.I <escape_char>d<number>
-with a decimal number
+.I WIDTH_DEFAULT
+keyword can be used to define the default width for all characters
+not explicitly listed.
+The default character width is 1.
+.PP
+The width section for individual characters starts with the keyword
+.I WIDTH
+in the first column.
+
+The following lines may have one of the two following forms to
+define the widths of the characters:
.TP
-.I <escape_char>x<number>
-with a hexadecimal number
+.RI < character >\ width
+This form defines the width of exactly one character.
.TP
-.I <escape_char><number>
-with an octal number.
-.\" FIXME comments
-.\" FIXME char ... char
+.RI < character >...< character >\ width
+This form defines the width for all the characters in the range.
+.PP
+The width definition section ends with the string
+.IR "END WIDTH" .
.SH FILES
-.I /usr/share/i18n/charmaps/*
-.\" .SH AUTHOR
-.\" Jochen Hein (jochen.hein@delphi.central.de)
-.SH "CONFORMING TO"
-POSIX.2
-.SH "SEE ALSO"
+.TP
+.I /usr/share/i18n/charmaps
+Usual default character map path.
+.SH CONFORMING TO
+POSIX.2.
+.SH EXAMPLE
+The Euro sign is defined as follows in the
+.I UTF\-8
+charmap:
+.PP
+.nf
+<U20AC> /xe2/x82/xac EURO SIGN
+.fi
+.SH SEE ALSO
+.BR iconv (1),
.BR locale (1),
.BR localedef (1),
-.BR localeconv (3),
-.BR setlocale (3),
-.BR locale (5)
+.BR locale (5),
+.BR charsets (7)
projects / thirdparty / man-pages.git / blobdiff