Contents of /code/trunk/maintain/README

The files in the "maintain" 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. There are various file names in the scripts and 
programs; they assume that the pcre directory is current.

132html         A Perl script that converts a .1 or .3 man page into HTML.

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.
                
CleanTxt        A Perl script that cleans up the output of "nroff -man" by
                removing backspaces and other redundant text so as to produce
                a readable .txt file.
                
Detrail         A Perl script that removes trailing spaces from files.

Index.html      A file that is copied as index.html into the doc/html 
                directory. It works like this so that doc/html can be deleted
                and re-created from scratch.
                
MakeRelease     My script for creating a new release. It processes the 
                documentation man pages into .text and HTML formats before 
                creating tarballs.
                
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.
            
ucptestdata     A directory containing two files, testinput1 and testoutput1,
                to use in conjunction with the ucptest program.
            
utf8.c          A short C program for converting a Unicode code point into a 
                sequence of bytes in the UTF-8 encoding, and vice versa.
                
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 "maintain" 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. There are various file names in the scripts and
4	programs; they assume that the pcre directory is current.
5
6	132html A Perl script that converts a .1 or .3 man page into HTML.
7
8	Builducptable A Perl script that creates the contents of the ucptable.h file
9	from two Unicode data files, which themselves are downloaded
10	from the Unicode web site.
11
12	CleanTxt A Perl script that cleans up the output of "nroff -man" by
13	removing backspaces and other redundant text so as to produce
14	a readable .txt file.
15
16	Detrail A Perl script that removes trailing spaces from files.
17
18	Index.html A file that is copied as index.html into the doc/html
19	directory. It works like this so that doc/html can be deleted
20	and re-created from scratch.
21
22	MakeRelease My script for creating a new release. It processes the
23	documentation man pages into .text and HTML formats before
24	creating tarballs.
25
26	Tech.Notes Some notes about the internals of the PCRE code.
27
28	Unicode.tables The files in this directory, Scripts.txt and UnicodeData.txt,
29	were downloaded from the Unicode web site. They contain
30	information about Unicode characters and scripts.
31
32	ucptest.c A short C program for testing the Unicode property functions in
33	pcre_ucp_searchfuncs.c, mainly useful after rebuilding the
34	Unicode property table.
35
36	ucptestdata A directory containing two files, testinput1 and testoutput1,
37	to use in conjunction with the ucptest program.
38
39	utf8.c A short C program for converting a Unicode code point into a
40	sequence of bytes in the UTF-8 encoding, and vice versa.
41
42	When there is a new release of Unicode, the files in Unicode.tables must be
43	refreshed from the web site, and the Buildupctable script can then be run to
44	generate a new version of ucptable.h. The ucptest program can be used to check
45	that the resulting table works properly, using the data files in ucptestdata to
46	check a number of test characters.
47
48	****