/[pcre]/code/trunk/maintain/README
ViewVC logotype

Contents of /code/trunk/maintain/README

Parent Directory Parent Directory | Revision Log Revision Log


Revision 99 - (show annotations) (download)
Tue Mar 6 12:27:42 2007 UTC (7 years, 6 months ago) by ph10
File size: 3181 byte(s)
1. Move the comment about version numbers from pcre.h.in to configure.ac 
because that's where they are now set.
2. Update all the man pages to remove the use of .br and .in because this
causes trouble for some HTML converters. Also standardised the final sections 
giving author information and revision date.
3. Update the maintain/132html man page converter to handle .nf/.fi and to barf 
at .br/.in.

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.
4
5 132html A Perl script that converts a .1 or .3 man page into HTML. It
6 is called from MakeRelease. It "knows" the relevant troff
7 constructs that are used in the PCRE man pages.
8
9 Builducptable A Perl script that creates the contents of the ucptable.h file
10 from two Unicode data files, which themselves are downloaded
11 from the Unicode web site. Run this script in the "maintain"
12 directory.
13
14 CleanTxt A Perl script that cleans up the output of "nroff -man" by
15 removing backspaces and other redundant text so as to produce
16 a readable .txt file. It is called from MakeRelease.
17
18 Detrail A Perl script that removes trailing spaces from files. It is
19 called from MakeRelease.
20
21 Index.html A file that is copied as index.html into the doc/html
22 directory when the HTML documentation is being built. It works
23 like this so that doc/html can be deleted and re-created from
24 scratch.
25
26 MakeRelease My script for creating a new release. It processes the
27 documentation man pages into .text and HTML formats before
28 creating tarballs and putting them in the Releases directory.
29
30 Tech.Notes Some notes about the internals of the PCRE code.
31
32 Unicode.tables The files in this directory, Scripts.txt and UnicodeData.txt,
33 were downloaded from the Unicode web site. They contain
34 information about Unicode characters and scripts.
35
36 ucptest.c A short C program for testing the Unicode property functions in
37 pcre_ucp_searchfuncs.c, mainly useful after rebuilding the
38 Unicode property table. Compile and run this in the "maintain"
39 directory.
40
41 ucptestdata A directory containing two files, testinput1 and testoutput1,
42 to use in conjunction with the ucptest program.
43
44 utf8.c A short, freestanding C program for converting a Unicode code
45 point into a sequence of bytes in the UTF-8 encoding, and vice
46 versa. If its argument is a hex number such as 0x1234, it
47 outputs a list of the equivalent UTF-8 bytes. If its argument
48 is sequence of concatenated UTF-8 bytes (e.g. e188b4) it treats
49 them as a UTF-8 character and outputs the equivalent code point
50 in hex.
51
52 When there is a new release of Unicode, the files in Unicode.tables must be
53 refreshed from the web site, and the Buildupctable script can then be run to
54 generate a new version of ucptable.h. The ucptest program can be used to check
55 that the resulting table works properly, using the data files in ucptestdata to
56 check a number of test characters.
57
58 ****

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12