strerror.3: Document the string produced by 'strerrorname_np(0);'
[man-pages.git] / man7 / utf-8.7
blob015d4b746b0aff5ae9439473fa492aa0349bb06b
1 .\" Copyright (C) Markus Kuhn, 1996, 2001
2 .\"
3 .\" SPDX-License-Identifier: GPL-2.0-or-later
4 .\"
5 .\" 1995-11-26  Markus Kuhn <mskuhn@cip.informatik.uni-erlangen.de>
6 .\"      First version written
7 .\" 2001-05-11  Markus Kuhn <mgk25@cl.cam.ac.uk>
8 .\"      Update
9 .\"
10 .TH UTF-8 7 (date) "Linux man-pages (unreleased)"
11 .SH NAME
12 UTF-8 \- an ASCII compatible multibyte Unicode encoding
13 .SH DESCRIPTION
14 The Unicode 3.0 character set occupies a 16-bit code space.
15 The most obvious
16 Unicode encoding (known as UCS-2)
17 consists of a sequence of 16-bit words.
18 Such strings can contain\[em]as part of many 16-bit characters\[em]bytes
19 such as \[aq]\e0\[aq] or \[aq]/\[aq], which have a
20 special meaning in filenames and other C library function arguments.
21 In addition, the majority of UNIX tools expect ASCII files and can't
22 read 16-bit words as characters without major modifications.
23 For these reasons,
24 UCS-2 is not a suitable external encoding of Unicode
25 in filenames, text files, environment variables, and so on.
26 The ISO/IEC 10646 Universal Character Set (UCS),
27 a superset of Unicode, occupies an even larger code
28 space\[em]31\ bits\[em]and the obvious
29 UCS-4 encoding for it (a sequence of 32-bit words) has the same problems.
30 .PP
31 The UTF-8 encoding of Unicode and UCS
32 does not have these problems and is the common way in which
33 Unicode is used on UNIX-style operating systems.
34 .SS Properties
35 The UTF-8 encoding has the following nice properties:
36 .TP 0.2i
38 UCS
39 characters 0x00000000 to 0x0000007f (the classic US-ASCII
40 characters) are encoded simply as bytes 0x00 to 0x7f (ASCII
41 compatibility).
42 This means that files and strings which contain only
43 7-bit ASCII characters have the same encoding under both
44 ASCII
45 and
46 UTF-8 .
47 .TP
49 All UCS characters greater than 0x7f are encoded as a multibyte sequence
50 consisting only of bytes in the range 0x80 to 0xfd, so no ASCII
51 byte can appear as part of another character and there are no
52 problems with, for example,  \[aq]\e0\[aq] or \[aq]/\[aq].
53 .TP
55 The lexicographic sorting order of UCS-4 strings is preserved.
56 .TP
58 All possible 2\[ha]31 UCS codes can be encoded using UTF-8.
59 .TP
61 The bytes 0xc0, 0xc1, 0xfe, and 0xff are never used in the UTF-8 encoding.
62 .TP
64 The first byte of a multibyte sequence which represents a single non-ASCII
65 UCS character is always in the range 0xc2 to 0xfd and indicates how long
66 this multibyte sequence is.
67 All further bytes in a multibyte sequence
68 are in the range 0x80 to 0xbf.
69 This allows easy resynchronization and
70 makes the encoding stateless and robust against missing bytes.
71 .TP
73 UTF-8 encoded UCS characters may be up to six bytes long, however the
74 Unicode standard specifies no characters above 0x10ffff, so Unicode characters
75 can be only up to four bytes long in
76 UTF-8.
77 .SS Encoding
78 The following byte sequences are used to represent a character.
79 The sequence to be used depends on the UCS code number of the character:
80 .TP 0.4i
81 0x00000000 \- 0x0000007F:
82 .RI 0 xxxxxxx
83 .TP
84 0x00000080 \- 0x000007FF:
85 .RI 110 xxxxx
86 .RI 10 xxxxxx
87 .TP
88 0x00000800 \- 0x0000FFFF:
89 .RI 1110 xxxx
90 .RI 10 xxxxxx
91 .RI 10 xxxxxx
92 .TP
93 0x00010000 \- 0x001FFFFF:
94 .RI 11110 xxx
95 .RI 10 xxxxxx
96 .RI 10 xxxxxx
97 .RI 10 xxxxxx
98 .TP
99 0x00200000 \- 0x03FFFFFF:
100 .RI 111110 xx
101 .RI 10 xxxxxx
102 .RI 10 xxxxxx
103 .RI 10 xxxxxx
104 .RI 10 xxxxxx
106 0x04000000 \- 0x7FFFFFFF:
107 .RI 1111110 x
108 .RI 10 xxxxxx
109 .RI 10 xxxxxx
110 .RI 10 xxxxxx
111 .RI 10 xxxxxx
112 .RI 10 xxxxxx
115 .I xxx
116 bit positions are filled with the bits of the character code number in
117 binary representation, most significant bit first (big-endian).
118 Only the shortest possible multibyte sequence
119 which can represent the code number of the character can be used.
121 The UCS code values 0xd800\[en]0xdfff (UTF-16 surrogates) as well as 0xfffe and
122 0xffff (UCS noncharacters) should not appear in conforming UTF-8 streams.
123 According to RFC 3629 no point above U+10FFFF should be used,
124 which limits characters to four bytes.
125 .SS Example
126 The Unicode character 0xa9 = 1010 1001 (the copyright sign) is encoded
127 in UTF-8 as
130 11000010 10101001 = 0xc2 0xa9
133 and character 0x2260 = 0010 0010 0110 0000 (the "not equal" symbol) is
134 encoded as:
137 11100010 10001001 10100000 = 0xe2 0x89 0xa0
139 .SS Application notes
140 Users have to select a UTF-8 locale, for example with
143 export LANG=en_GB.UTF-8
146 in order to activate the UTF-8 support in applications.
148 Application software that has to be aware of the used character
149 encoding should always set the locale with for example
152 setlocale(LC_CTYPE, "")
155 and programmers can then test the expression
158 strcmp(nl_langinfo(CODESET), "UTF-8") == 0
161 to determine whether a UTF-8 locale has been selected and whether
162 therefore all plaintext standard input and output, terminal
163 communication, plaintext file content, filenames, and environment
164 variables are encoded in UTF-8.
166 Programmers accustomed to single-byte encodings such as US-ASCII or ISO 8859
167 have to be aware that two assumptions made so far are no longer valid
168 in UTF-8 locales.
169 Firstly, a single byte does not necessarily correspond any
170 more to a single character.
171 Secondly, since modern terminal emulators in UTF-8
172 mode also support Chinese, Japanese, and Korean
173 double-width characters as well as nonspacing combining characters,
174 outputting a single character does not necessarily advance the cursor
175 by one position as it did in ASCII.
176 Library functions such as
177 .BR mbsrtowcs (3)
179 .BR wcswidth (3)
180 should be used today to count characters and cursor positions.
182 The official ESC sequence to switch from an ISO 2022
183 encoding scheme (as used for instance by VT100 terminals) to
184 UTF-8 is ESC % G
185 ("\ex1b%G").
186 The corresponding return sequence from
187 UTF-8 to ISO 2022 is ESC % @ ("\ex1b%@").
188 Other ISO 2022 sequences (such as
189 for switching the G0 and G1 sets) are not applicable in UTF-8 mode.
190 .SS Security
191 The Unicode and UCS standards require that producers of UTF-8
192 shall use the shortest form possible, for example, producing a two-byte
193 sequence with first byte 0xc0 is nonconforming.
194 Unicode 3.1 has added the requirement that conforming programs must not accept
195 non-shortest forms in their input.
196 This is for security reasons: if
197 user input is checked for possible security violations, a program
198 might check only for the ASCII
199 version of "/../" or ";" or NUL and overlook that there are many
200 non-ASCII ways to represent these things in a non-shortest UTF-8
201 encoding.
202 .SS Standards
203 ISO/IEC 10646-1:2000, Unicode 3.1, RFC\ 3629, Plan 9.
204 .\" .SH AUTHOR
205 .\" Markus Kuhn <mgk25@cl.cam.ac.uk>
206 .SH SEE ALSO
207 .BR locale (1),
208 .BR nl_langinfo (3),
209 .BR setlocale (3),
210 .BR charsets (7),
211 .BR unicode (7)