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