tree: c165d3a9e65cef8c44a11c9b3c9fb1a8f1daf629 [path history] [tgz]
  1. .gitignore
  2. AUTHORS
  3. CHANGELOG.md
  4. COPYING
  5. COPYING.UCD
  6. Makefile.am
  7. README.md
  8. _layouts/
  9. autogen.sh
  10. configure.ac
  11. data/
  12. docs/
  13. m4/
  14. src/
  15. tests/
  16. tools/
src/ucd-tools/README.md

Unicode Character Database Tools


The Unicode Character Database (UCD) Tools is a set of Python tools and a C library with a C++ API binding. The Python tools are designed to support extracting and processing data from the text-based UCD source files, while the C library is designed to provide easy access to this information within a C or C++ program.

The project uses and supports the following sources of Unicode codepoint data:

Build Dependencies

In order to build ucd-tools, you need:

  1. a functional autotools system (make, autoconf, automake and libtool);
  2. a functional C and C++ compiler.

NOTE: The C++ compiler is used to build the test for the C++ API.

To build the documentation, you need:

  1. the doxygen program to build the api documentation;
  2. the dot program from the graphviz library to generate graphs in the api documentation.

Debian

Core Dependencies:

DependencyInstall
autotoolssudo apt-get install make autoconf automake libtool
C++ compilersudo apt-get install gcc g++

Documentation Dependencies:

DependencyInstall
doxygensudo apt-get install doxygen
graphvizsudo apt-get install graphviz

Building

UCD Tools supports the standard GNU autotools build system. The source code does not contain the generated configure files, so to build it you need to run:

./autogen.sh
./configure --prefix=/usr
make

The tests can be run by using:

make check

The program can be installed using:

sudo make install

The documentation can be built using:

make html

Updating the UCD Data

To re-generate the source files from the UCD data when a new version of unicode is released, you need to run:

./configure --prefix=/usr --with-unicode-version=VERSION
make ucd-update

where VERSION is the Unicode version (e.g. 6.3.0).

Additionally, you can use the UCD_FLAGS option to control how the data is generated. The following flags are supported:

FlagDescription
--with-csurAdd ConScript Unicode Registry data.

Bugs

Report bugs to the ucd-tools issues page on GitHub.

License Information

UCD Tools is released under the GPL version 3 or later license.

The UCD data files in data/ucd are downloaded from the UCD website and are licensed under the Unicode Terms of Use. These data files are used in their unmodified form. They have the following Copyright notice:

Copyright © 1991-2014 Unicode, Inc. All rights reserved.

The files in data/csur are based on the information from the ConScript Unicode Registry maintained by John Cowan and Michael Everson.