xref: /freebsd/tools/tools/locale/README (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
1# $FreeBSD$
2
3Files in this directory are used to generate locale source files
4from files in CLDR (Unicode Common Locale Data Repository).
5
6To generate the files, do the following:
7
8	cd /usr/src/tools/tools/locale
9	make obj	(mandatory)
10	make -j16	(-jN recommended)
11	make diff	(check if the changes are reasonable)
12	make install
13
14"make" downloads the necessary files, build them, and install the
15results into /usr/src/share/* as source files for locales.
16
17More details are as follows:
18
19Variables:
20	LOCALESRCDIR
21		Destination path for the generated locale files.
22		Default: ${SRCTOP}/share.
23	TMPDIR
24		Temporary directory.
25		Default: /tmp
26
27Targets:
28	make obj
29		Create a temporary directory for building.
30
31	make clean
32		Clean up the obj directories.  Note that this does not
33		clean up tools or posix locale source files generated
34		from the CLDR files because it takes a long time to generate
35		them and they are not changed as long as using the same
36		CLDR files.  "make clean && make build" will
37		regenerate the locale source files for src/share/*def.
38
39	make cleandir
40		Remove the obj directories completely.
41
42	make tools-test
43		Check if necessary tools are installed or not.
44		If something is missing, install them.
45
46	make fetch
47		Download necessary files from CLDR.
48
49	make build-tools
50		Build a tool to generate locale source files.
51
52	make posix
53		Build POSIX locale source files.
54
55	make build
56		Build locale files.
57
58	make diff
59		Run diff(1) the build results against $LOCALESRCDIR.
60
61	make install
62		Install the build results into $LOCALESRCDIR.
63
64	make widths
65		Generate widths.txt.  Requires pkgconf and utf8proc
66		packages to be installed.
67[EOF]
68