xref: /freebsd/tools/tools/locale/README (revision b306c604df541dede4d0f3cc96188bbf5b6719fe)
184fa0ef9SHiroki SatoFiles in this directory are used to generate locale source files
284fa0ef9SHiroki Satofrom files in CLDR (Unicode Common Locale Data Repository).
332810cf3SBaptiste Daroussin
484fa0ef9SHiroki SatoTo generate the files, do the following:
532810cf3SBaptiste Daroussin
684fa0ef9SHiroki Sato	cd /usr/src/tools/tools/locale
784fa0ef9SHiroki Sato	make obj	(mandatory)
8*b306c604SYuri Pankov	make fetch	(download the CLDR source)
9*b306c604SYuri Pankov	make extract	(and extract it)
1084fa0ef9SHiroki Sato	make -j16	(-jN recommended)
1184fa0ef9SHiroki Sato	make diff	(check if the changes are reasonable)
1232810cf3SBaptiste Daroussin	make install
1384fa0ef9SHiroki Sato
1484fa0ef9SHiroki Sato"make" downloads the necessary files, build them, and install the
1584fa0ef9SHiroki Satoresults into /usr/src/share/* as source files for locales.
1684fa0ef9SHiroki Sato
1784fa0ef9SHiroki SatoMore details are as follows:
1884fa0ef9SHiroki Sato
1984fa0ef9SHiroki SatoVariables:
2084fa0ef9SHiroki Sato	LOCALESRCDIR
2184fa0ef9SHiroki Sato		Destination path for the generated locale files.
2291680647SHiroki Sato		Default: ${SRCTOP}/share.
2384fa0ef9SHiroki Sato	TMPDIR
2484fa0ef9SHiroki Sato		Temporary directory.
2584fa0ef9SHiroki Sato		Default: /tmp
2684fa0ef9SHiroki Sato
2784fa0ef9SHiroki SatoTargets:
2884fa0ef9SHiroki Sato	make obj
2984fa0ef9SHiroki Sato		Create a temporary directory for building.
3084fa0ef9SHiroki Sato
3184fa0ef9SHiroki Sato	make clean
3291680647SHiroki Sato		Clean up the obj directories.  Note that this does not
3391680647SHiroki Sato		clean up tools or posix locale source files generated
3491680647SHiroki Sato		from the CLDR files because it takes a long time to generate
3591680647SHiroki Sato		them and they are not changed as long as using the same
3691680647SHiroki Sato		CLDR files.  "make clean && make build" will
3791680647SHiroki Sato		regenerate the locale source files for src/share/*def.
3884fa0ef9SHiroki Sato
3984fa0ef9SHiroki Sato	make cleandir
4084fa0ef9SHiroki Sato		Remove the obj directories completely.
4184fa0ef9SHiroki Sato
4284fa0ef9SHiroki Sato	make tools-test
4384fa0ef9SHiroki Sato		Check if necessary tools are installed or not.
4484fa0ef9SHiroki Sato		If something is missing, install them.
4584fa0ef9SHiroki Sato
4684fa0ef9SHiroki Sato	make fetch
4784fa0ef9SHiroki Sato		Download necessary files from CLDR.
4884fa0ef9SHiroki Sato
4984fa0ef9SHiroki Sato	make build-tools
5084fa0ef9SHiroki Sato		Build a tool to generate locale source files.
5184fa0ef9SHiroki Sato
5284fa0ef9SHiroki Sato	make posix
5384fa0ef9SHiroki Sato		Build POSIX locale source files.
5484fa0ef9SHiroki Sato
5584fa0ef9SHiroki Sato	make build
5684fa0ef9SHiroki Sato		Build locale files.
5784fa0ef9SHiroki Sato
5884fa0ef9SHiroki Sato	make diff
5984fa0ef9SHiroki Sato		Run diff(1) the build results against $LOCALESRCDIR.
6084fa0ef9SHiroki Sato
6184fa0ef9SHiroki Sato	make install
6284fa0ef9SHiroki Sato		Install the build results into $LOCALESRCDIR.
632c8d4444SYuri Pankov
642c8d4444SYuri Pankov	make widths
652c8d4444SYuri Pankov		Generate widths.txt.  Requires pkgconf and utf8proc
662c8d4444SYuri Pankov		packages to be installed.
6784fa0ef9SHiroki Sato[EOF]
68