original/man7/utf-8.7

   1 .\" Hey Emacs! This file is -*- nroff -*- source.
   2 .\"
   3 .\" Copyright (C) Markus Kuhn, 1996, 2001
   4 .\"
   5 .\" This is free documentation; you can redistribute it and/or
   6 .\" modify it under the terms of the GNU General Public License as
   7 .\" published by the Free Software Foundation; either version 2 of
   8 .\" the License, or (at your option) any later version.
   9 .\"
  10 .\" The GNU General Public License's references to "object code"
  11 .\" and "executables" are to be interpreted as the output of any
  12 .\" document formatting or typesetting system, including
  13 .\" intermediate and printed output.
  14 .\"
  15 .\" This manual is distributed in the hope that it will be useful,
  16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 .\" GNU General Public License for more details.
  19 .\"
  20 .\" You should have received a copy of the GNU General Public
  21 .\" License along with this manual; if not, write to the Free
  22 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  23 .\" USA.
  24 .\"
  25 .\" 1995-11-26  Markus Kuhn <mskuhn@cip.informatik.uni-erlangen.de>
  26 .\"      First version written
  27 .\" 2001-05-11  Markus Kuhn <mgk25@cl.cam.ac.uk>
  28 .\"      Update
  29 .\"
  30 .TH UTF-8 7 2001-05-11 "GNU" "Linux Programmer's Manual"
  31 .SH NAME
  32 UTF-8 \- an ASCII compatible multibyte Unicode encoding
  33 .SH DESCRIPTION
  34 The
  35 .B Unicode 3.0
  36 character set occupies a 16-bit code space.
  37 The most obvious
  38 Unicode encoding (known as
  39 .BR UCS-2 )
  40 consists of a sequence of 16-bit words.
  41 Such strings can contain as
  42 parts of many 16-bit characters bytes
  43 like \(aq\\0\(aq or \(aq/\(aq which have a
  44 special meaning in filenames and other C library function arguments.
  45 In addition, the majority of Unix tools expects ASCII files and can't
  46 read 16-bit words as characters without major modifications.
  47 For these reasons,
  48 .B UCS-2
  49 is not a suitable external encoding of
  50 .B Unicode
  51 in filenames, text files, environment variables, etc.
  52 The
  53 .BR "ISO 10646 Universal Character Set (UCS)" ,
  54 a superset of Unicode, occupies even a 31-bit code space and the obvious
  55 .B UCS-4
  56 encoding for it (a sequence of 32-bit words) has the same problems.
  57
  58 The
  59 .B UTF-8
  60 encoding of
  61 .B Unicode
  62 and
  63 .B UCS
  64 does not have these problems and is the common way in which
  65 .B Unicode
  66 is used on Unix-style operating systems.
  67 .SS Properties
  68 The
  69 .B UTF-8
  70 encoding has the following nice properties:
  71 .TP 0.2i
  72 *
  73 .B UCS
  74 characters 0x00000000 to 0x0000007f (the classic
  75 .B US-ASCII
  76 characters) are encoded simply as bytes 0x00 to 0x7f (ASCII
  77 compatibility).
  78 This means that files and strings which contain only
  79 7-bit ASCII characters have the same encoding under both
  80 .B ASCII
  81 and
  82 .BR UTF-8 .
  83 .TP
  84 *
  85 All
  86 .B UCS
  87 characters greater than 0x7f are encoded as a multibyte sequence
  88 consisting only of bytes in the range 0x80 to 0xfd, so no ASCII
  89 byte can appear as part of another character and there are no
  90 problems with, for example,  \(aq\\0\(aq or \(aq/\(aq.
  91 .TP
  92 *
  93 The lexicographic sorting order of
  94 .B UCS-4
  95 strings is preserved.
  96 .TP
  97 *
  98 All possible 2^31 UCS codes can be encoded using
  99 .BR UTF-8 .
 100 .TP
 101 *
 102 The bytes 0xfe and 0xff are never used in the
 103 .B UTF-8
 104 encoding.
 105 .TP
 106 *
 107 The first byte of a multibyte sequence which represents a single non-ASCII
 108 .B UCS
 109 character is always in the range 0xc0 to 0xfd and indicates how long
 110 this multibyte sequence is.
 111 All further bytes in a multibyte sequence
 112 are in the range 0x80 to 0xbf.
 113 This allows easy resynchronization and
 114 makes the encoding stateless and robust against missing bytes.
 115 .TP
 116 *
 117 .B UTF-8
 118 encoded
 119 .B UCS
 120 characters may be up to six bytes long, however the
 121 .B Unicode
 122 standard specifies no characters above 0x10ffff, so Unicode characters
 123 can only be up to four bytes long in
 124 .BR UTF-8 .
 125 .SS Encoding
 126 The following byte sequences are used to represent a character.
 127 The sequence to be used depends on the UCS code number of the character:
 128 .TP 0.4i
 129 0x00000000 \- 0x0000007F:
 130 .RI 0 xxxxxxx
 131 .TP
 132 0x00000080 \- 0x000007FF:
 133 .RI 110 xxxxx
 134 .RI 10 xxxxxx
 135 .TP
 136 0x00000800 \- 0x0000FFFF:
 137 .RI 1110 xxxx
 138 .RI 10 xxxxxx
 139 .RI 10 xxxxxx
 140 .TP
 141 0x00010000 \- 0x001FFFFF:
 142 .RI 11110 xxx
 143 .RI 10 xxxxxx
 144 .RI 10 xxxxxx
 145 .RI 10 xxxxxx
 146 .TP
 147 0x00200000 \- 0x03FFFFFF:
 148 .RI 111110 xx
 149 .RI 10 xxxxxx
 150 .RI 10 xxxxxx
 151 .RI 10 xxxxxx
 152 .RI 10 xxxxxx
 153 .TP
 154 0x04000000 \- 0x7FFFFFFF:
 155 .RI 1111110 x
 156 .RI 10 xxxxxx
 157 .RI 10 xxxxxx
 158 .RI 10 xxxxxx
 159 .RI 10 xxxxxx
 160 .RI 10 xxxxxx
 161 .PP
 162 The
 163 .I xxx
 164 bit positions are filled with the bits of the character code number in
 165 binary representation.
 166 Only the shortest possible multibyte sequence
 167 which can represent the code number of the character can be used.
 168 .PP
 169 The
 170 .B UCS
 171 code values 0xd800\(en0xdfff (UTF-16 surrogates) as well as 0xfffe and
 172 0xffff (UCS noncharacters) should not appear in conforming
 173 .B UTF-8
 174 streams.
 175 .SS Example
 176 The
 177 .B Unicode
 178 character 0xa9 = 1010 1001 (the copyright sign) is encoded
 179 in UTF-8 as
 180 .PP
 181 .RS
 182 11000010 10101001 = 0xc2 0xa9
 183 .RE
 184 .PP
 185 and character 0x2260 = 0010 0010 0110 0000 (the "not equal" symbol) is
 186 encoded as:
 187 .PP
 188 .RS
 189 11100010 10001001 10100000 = 0xe2 0x89 0xa0
 190 .RE
 191 .SS "Application Notes"
 192 Users have to select a
 193 .B UTF-8
 194 locale, for example with
 195 .PP
 196 .RS
 197 export LANG=en_GB.UTF-8
 198 .RE
 199 .PP
 200 in order to activate the
 201 .B UTF-8
 202 support in applications.
 203 .PP
 204 Application software that has to be aware of the used character
 205 encoding should always set the locale with for example
 206 .PP
 207 .RS
 208 setlocale(LC_CTYPE, "")
 209 .RE
 210 .PP
 211 and programmers can then test the expression
 212 .PP
 213 .RS
 214 strcmp(nl_langinfo(CODESET), "UTF-8") == 0
 215 .RE
 216 .PP
 217 to determine whether a
 218 .B UTF-8
 219 locale has been selected and whether
 220 therefore all plaintext standard input and output, terminal
 221 communication, plaintext file content, filenames and environment
 222 variables are encoded in
 223 .BR UTF-8 .
 224 .PP
 225 Programmers accustomed to single-byte encodings such as
 226 .B US-ASCII
 227 or
 228 .B ISO 8859
 229 have to be aware that two assumptions made so far are no longer valid
 230 in
 231 .B UTF-8
 232 locales.
 233 Firstly, a single byte does not necessarily correspond any
 234 more to a single character.
 235 Secondly, since modern terminal emulators
 236 in
 237 .B UTF-8
 238 mode also support Chinese, Japanese, and Korean
 239 .B double-width characters
 240 as well as nonspacing
 241 .BR "combining characters"  ,
 242 outputting a single character does not necessarily advance the cursor
 243 by one position as it did in
 244 .BR ASCII .
 245 Library functions such as
 246 .BR mbsrtowcs (3)
 247 and
 248 .BR wcswidth (3)
 249 should be used today to count characters and cursor positions.
 250 .PP
 251 The official ESC sequence to switch from an
 252 .B ISO 2022
 253 encoding scheme (as used for instance by VT100 terminals) to
 254 .B UTF-8
 255 is ESC % G
 256 ("\\x1b%G").
 257 The corresponding return sequence from
 258 .B UTF-8
 259 to ISO 2022 is ESC % @ ("\\x1b%@").
 260 Other ISO 2022 sequences (such as
 261 for switching the G0 and G1 sets) are not applicable in UTF-8 mode.
 262 .PP
 263 It can be hoped that in the foreseeable future,
 264 .B UTF-8
 265 will replace
 266 .B ASCII
 267 and
 268 .B ISO 8859
 269 at all levels as the common character encoding on POSIX systems,
 270 leading to a significantly richer environment for handling plain text.
 271 .SS Security
 272 The
 273 .BR Unicode " and " UCS
 274 standards require that producers of
 275 .B UTF-8
 276 shall use the shortest form possible, for example, producing a two-byte
 277 sequence with first byte 0xc0 is nonconforming.
 278 .B Unicode 3.1
 279 has added the requirement that conforming programs must not accept
 280 non-shortest forms in their input.
 281 This is for security reasons: if
 282 user input is checked for possible security violations, a program
 283 might check only for the
 284 .B ASCII
 285 version of "/../" or ";" or NUL and overlook that there are many
 286 .RB non- ASCII
 287 ways to represent these things in a non-shortest
 288 .B UTF-8
 289 encoding.
 290 .SS Standards
 291 ISO/IEC 10646-1:2000, Unicode 3.1, RFC\ 2279, Plan 9.
 292 .\" .SH AUTHOR
 293 .\" Markus Kuhn <mgk25@cl.cam.ac.uk>
 294 .SH "SEE ALSO"
 295 .BR nl_langinfo (3),
 296 .BR setlocale (3),
 297 .BR charsets (7),
 298 .BR unicode (7)