Contents of /code/trunk/maint/README

The files in the "maint" directory of the PCRE source contain data, scripts, 
and programs that are used for the maintenance of PCRE, but do not form part of
the PCRE distribution tarballs.

Builducptable   A Perl script that creates the contents of the ucptable.h file
                from two Unicode data files, which themselves are downloaded
                from the Unicode web site. Run this script in the "maint" 
                directory.
                
Tech.Notes      Some notes about the internals of the PCRE code.   
               
Unicode.tables  The files in this directory, Scripts.txt and UnicodeData.txt, 
                were downloaded from the Unicode web site. They contain 
                information about Unicode characters and scripts.

ucptest.c       A short C program for testing the Unicode property functions in
                pcre_ucp_searchfuncs.c, mainly useful after rebuilding the
                Unicode property table. Compile and run this in the "main" 
                directory.
            
ucptestdata     A directory containing two files, testinput1 and testoutput1,
                to use in conjunction with the ucptest program.
            
utf8.c          A short, freestanding C program for converting a Unicode code
                point into a sequence of bytes in the UTF-8 encoding, and vice
                versa. If its argument is a hex number such as 0x1234, it 
                outputs a list of the equivalent UTF-8 bytes. If its argument 
                is sequence of concatenated UTF-8 bytes (e.g. e188b4) it treats 
                them as a UTF-8 character and outputs the equivalent code point 
                in hex. 
                
When there is a new release of Unicode, the files in Unicode.tables must be 
refreshed from the web site, and the Buildupctable script can then be run to 
generate a new version of ucptable.h. The ucptest program can be used to check 
that the resulting table works properly, using the data files in ucptestdata to 
check a number of test characters. 
             
**** 
1	The files in the "maint" directory of the PCRE source contain data, scripts,
2	and programs that are used for the maintenance of PCRE, but do not form part of
3	the PCRE distribution tarballs.
4
5	Builducptable A Perl script that creates the contents of the ucptable.h file
6	from two Unicode data files, which themselves are downloaded
7	from the Unicode web site. Run this script in the "maint"
8	directory.
9
10	Tech.Notes Some notes about the internals of the PCRE code.
11
12	Unicode.tables The files in this directory, Scripts.txt and UnicodeData.txt,
13	were downloaded from the Unicode web site. They contain
14	information about Unicode characters and scripts.
15
16	ucptest.c A short C program for testing the Unicode property functions in
17	pcre_ucp_searchfuncs.c, mainly useful after rebuilding the
18	Unicode property table. Compile and run this in the "main"
19	directory.
20
21	ucptestdata A directory containing two files, testinput1 and testoutput1,
22	to use in conjunction with the ucptest program.
23
24	utf8.c A short, freestanding C program for converting a Unicode code
25	point into a sequence of bytes in the UTF-8 encoding, and vice
26	versa. If its argument is a hex number such as 0x1234, it
27	outputs a list of the equivalent UTF-8 bytes. If its argument
28	is sequence of concatenated UTF-8 bytes (e.g. e188b4) it treats
29	them as a UTF-8 character and outputs the equivalent code point
30	in hex.
31
32	When there is a new release of Unicode, the files in Unicode.tables must be
33	refreshed from the web site, and the Buildupctable script can then be run to
34	generate a new version of ucptable.h. The ucptest program can be used to check
35	that the resulting table works properly, using the data files in ucptestdata to
36	check a number of test characters.
37
38	****