1a9d9aacae64096bc4b8e74d2d8b1faba0e40f67
[dragonfly.git] / share / man / man5 / utf2.5
1 .\" Copyright (c) 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Paul Borman at Krystal Technologies.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. Neither the name of the University nor the names of its contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"    without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .\"     @(#)utf2.4      8.1 (Berkeley) 6/4/93
32 .\" $FreeBSD: src/lib/libc/locale/utf2.4,v 1.8.2.2 2002/10/24 11:00:52 tjr Exp $
33 .\"
34 .Dd October 11, 2002
35 .Dt UTF2 5
36 .Os
37 .Sh NAME
38 .Nm utf2
39 .Nd "Universal character set Transformation Format encoding of runes"
40 .Sh SYNOPSIS
41 .Nm ENCODING
42 .Qq UTF2
43 .Sh DESCRIPTION
44 .Bf Em
45 The UTF2 encoding has been deprecated in favour of UTF-8.
46 .Ef
47 New applications should not use UTF2.
48 .Pp
49 The
50 .Nm UTF2
51 encoding is based on a proposed X-Open multibyte
52 \s-1FSS-UCS-TF\s+1 (File System Safe Universal Character Set Transformation Format) encoding as used in
53 .Sy "Plan 9 from Bell Labs" .
54 Although it is capable of representing more than 16 bits,
55 the current implementation is limited to 16 bits as defined by the
56 Unicode Standard.
57 .Pp
58 .Nm UTF2
59 representation is backwards compatible with ASCII, so 0x00-0x7f refer to the
60 ASCII character set.  The multibyte encoding of runes between 0x0080 and 0xffff
61 consist entirely of bytes whose high order bit is set.  The actual
62 encoding is represented by the following table:
63 .Bd -literal
64 [0x0000 - 0x007f] [00000000.0bbbbbbb] -> 0bbbbbbb
65 [0x0080 - 0x07ff] [00000bbb.bbbbbbbb] -> 110bbbbb, 10bbbbbb
66 [0x0800 - 0xffff] [bbbbbbbb.bbbbbbbb] -> 1110bbbb, 10bbbbbb, 10bbbbbb
67 .Ed
68 .Pp
69 If more than a single representation of a value exists (for example,
70 0x00; 0xC0 0x80; 0xE0 0x80 0x80) the shortest representation is always
71 used (but the longer ones will be correctly decoded).
72 .Pp
73 The final three encodings provided by X-Open:
74 .Bd -literal
75 [00000000.000bbbbb.bbbbbbbb.bbbbbbbb] ->
76         11110bbb, 10bbbbbb, 10bbbbbb, 10bbbbbb
77
78 [000000bb.bbbbbbbb.bbbbbbbb.bbbbbbbb] ->
79         111110bb, 10bbbbbb, 10bbbbbb, 10bbbbbb, 10bbbbbb
80
81 [0bbbbbbb.bbbbbbbb.bbbbbbbb.bbbbbbbb] ->
82         1111110b, 10bbbbbb, 10bbbbbb, 10bbbbbb, 10bbbbbb, 10bbbbbb
83 .Ed
84 .Pp
85 which provides for the entire proposed ISO-10646 31 bit standard are currently
86 not implemented.
87 .Sh SEE ALSO
88 .Xr mklocale 1 ,
89 .Xr setlocale 3 ,
90 .Xr utf8 5