(test-input): Add en_US.ISO-8859-1.
[kopensolaris-gnu/glibc.git] / localedata / README
1                        POSIX locale descriptions
2                                   and
3                     POSIX character set descriptions
4
5 Ulrich Drepper                  Time-stamp: <1997/06/04 01:36:26 drepper>
6 drepper@cygnus.com
7
8
9 This add-on package contains the data needed to build the locale data
10 files to use the internationalization features of the GNU libc.
11
12 POSIX.2 describes the `localedef' utility which is part of the GNU libc.
13 You need this program to "compile" the locale description in a form
14 suitable for fast access by the GNU libc functions.  Any compilation is
15 based on a given character set.
16
17 To use these data files you should add the name of this add-on
18 (localedata) to the list of add-on you specify while compiling the GNU
19 libc:
20
21         configure --enable-add-ons=...,localedata ...
22
23 where ... are the options you normally choose. Once you run `make
24 install' for the GNU libc the data files are automatically installed in
25 the right place, ready for use by the `localedef' program.
26
27
28 To compile the locale data files you simply have to decide which locale
29 (based on the location and the language) and which character set you
30 use.  E.g., French speaking Canadians would use the locale `fr_CA' and
31 the character set `ISO_8859-1,1987'.  Calling `localedef' to get the
32 desired data should happen like this:
33
34         localedef -i fr_CA -f ISO-8859-1 fr_CA
35
36 This will place the 6 output files in the appropriate directory where
37 the GNU libc functions can find them.  Please note that you need
38 permission to write to this directory ($(prefix)/share/locale, where
39 $(prefix) is the value you specified while configuring GNU libc).  If
40 you do not have the necessary permissions, you can write the files into an
41 arbitrary directory by giving a path including a '/' character instead
42 of `fr_CA'.  E.g., to put the new files in a subdirectory of the
43 current directory simply use
44
45         localedef -i fr_CA -f ISO-8859-1 ./fr_CA
46
47 How to use these data files is described in the GNU libc manual,
48 especially in the section describing the `setlocale' function.
49
50
51 The files contained here were originally from
52
53         ftp://dkuug.dk/i18n/WG15-collection
54
55 Keld Jörn Simonsen from the Danish Unix User Group maintains this
56 archive on behalf of the POSIX working groups.  When you find some wrong
57 data or want to add something please contact
58
59         Keld Jörn Simonsen <keld@dkuug.dk>
60 and
61         Ulrich Drepper <drepper@cygnus.com>
62
63 Please make sure your corrections are relative to the originally
64 distributed files.  Consult the CHECKSUMS file which contains the MD5
65 sums for all data files.
66
67
68 One more note: the `POSIX' locale definition is not meant to be used
69 as an input file for `localedef'.  It is rather there to show the
70 values with are built in the libc binaries as default values when no
71 legal locale is found or the "C" or "POSIX" locale is selected.
72
73
74                        The collation test suite
75                        ########################
76
77 This package also contains a (beginning of a) test suite for the
78 collation functions in the GNU libc.  The files are provided sorted.
79 The test program shuffles the lines and sort them afterwards.
80
81 Some of the files are provided in 8bit form, i.e., not only ASCII
82 characters.  So the tools you use to process the files should be 8bit
83 clean.
84
85 To run the test program the appropriate locale information must be
86 installed.  Therefore the localedef program is used to generate this
87 data used the locale and charmap description files contained here.
88 Since we cannot run the localedef program in case of cross-compilation
89 no tests at all are performed.
90
91
92 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
93 Local Variables:
94  mode:text
95  eval:(load-library "time-stamp")
96  eval:(make-local-variable 'write-file-hooks)
97  eval:(add-hook 'write-file-hooks 'time-stamp)
98  eval:(setq time-stamp-format '(time-stamp-yyyy/mm/dd time-stamp-hh:mm:ss user-login-name))
99 End: