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

Diff of /code/trunk/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 109 by ph10, Wed Mar 7 15:35:57 2007 UTC revision 111 by ph10, Thu Mar 8 16:53:09 2007 UTC
# Line 4  README file for PCRE (Perl-compatible re Line 4  README file for PCRE (Perl-compatible re
4  The latest release of PCRE is always available from  The latest release of PCRE is always available from
5    
6    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz    ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/pcre-xxx.tar.gz
7    
8    There is a mailing list for discussion about the development of PCRE at
9    
10      pcre-dev@exim.org
11    
12  Please read the NEWS file if you are upgrading from a previous release.  Please read the NEWS file if you are upgrading from a previous release.
13  The contents of this README file are:  The contents of this README file are:
# Line 17  The contents of this README file are: Line 21  The contents of this README file are:
21    Shared libraries on Unix-like systems    Shared libraries on Unix-like systems
22    Cross-compiling on a Unix-like system    Cross-compiling on a Unix-like system
23    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
24      Making new tarballs
25    Testing PCRE    Testing PCRE
26    Character tables    Character tables
27    File manifest    File manifest
# Line 69  supplied in two other forms: Line 74  supplied in two other forms:
74       those that summarize individual functions. The other two are the text       those that summarize individual functions. The other two are the text
75       forms of the section 1 man pages for the pcregrep and pcretest commands.       forms of the section 1 man pages for the pcregrep and pcretest commands.
76       These text forms are provided for ease of scanning with text editors or       These text forms are provided for ease of scanning with text editors or
77       similar tools.       similar tools. They are installed in <prefix>/share/doc/pcre, where
78         <prefix> is the installation prefix (defaulting to /usr/local).
79    
80    2. A set of files containing all the documentation in HTML form, hyperlinked    2. A set of files containing all the documentation in HTML form, hyperlinked
81       in various ways, and rooted in a file called index.html, is installed in       in various ways, and rooted in a file called index.html, is installed in
82       the directory <prefix>/share/doc/pcre/html, where <prefix> is the       the directory <prefix>/share/doc/pcre/html.
      installation prefix (defaulting to /usr/local).  
83    
84    
85  Contributions by users of PCRE  Contributions by users of PCRE
# Line 262  system. The following are installed (fil Line 267  system. The following are installed (fil
267    Commands (bin):    Commands (bin):
268      pcretest      pcretest
269      pcregrep      pcregrep
270      pcre-config      pcre-config
271    
272    Libraries (lib):    Libraries (lib):
273      libpcre      libpcre
# Line 295  system. The following are installed (fil Line 300  system. The following are installed (fil
300      AUTHORS      AUTHORS
301      COPYING      COPYING
302      ChangeLog      ChangeLog
     INSTALL  
303      LICENCE      LICENCE
     NON-UNIX-USE  
304      NEWS      NEWS
305      README      README
306      pcre.txt       (a concatenation of the man(3) pages)      pcre.txt       (a concatenation of the man(3) pages)
307      pcretest.txt   the pcretest man page      pcretest.txt   the pcretest man page
308      pcregrep.txt   the pcregrep man page      pcregrep.txt   the pcregrep man page
     perltest.txt   some information about the perltest.pl script  
309    
310  Note that the pcredemo program that is built by "configure" is *not* installed  Note that the pcredemo program that is built by "configure" is *not* installed
311  anywhere. It is a demonstration for programmers wanting to use PCRE.  anywhere. It is a demonstration for programmers wanting to use PCRE.
312    
313  If you want to remove PCRE from your system, you can run "make uninstall".  If you want to remove PCRE from your system, you can run "make uninstall".
# Line 393  use the workaround of specifying the fol Line 395  use the workaround of specifying the fol
395  running the "configure" script:  running the "configure" script:
396    
397    CXXLDFLAGS="-lstd_v2 -lCsup_v2"    CXXLDFLAGS="-lstd_v2 -lCsup_v2"
398    
399    
400    Making new tarballs
401    -------------------
402    
403    The command "make dist" creates three PCRE tarballs, in tar.gz, tar.bz2, and
404    zip formats. However, if you have modified any of the man page sources in the
405    doc directory, you should first run the PrepareRelease script. This re-creates
406    the .txt and HTML forms of the documentation from the man pages.
407    
408    
409  Testing PCRE  Testing PCRE
# Line 492  re-generated. Line 503  re-generated.
503  The first two 256-byte tables provide lower casing and case flipping functions,  The first two 256-byte tables provide lower casing and case flipping functions,
504  respectively. The next table consists of three 32-byte bit maps which identify  respectively. The next table consists of three 32-byte bit maps which identify
505  digits, "word" characters, and white space, respectively. These are used when  digits, "word" characters, and white space, respectively. These are used when
506  building 32-byte bit maps that represent character classes for code points less  building 32-byte bit maps that represent character classes for code points less
507  than 256.  than 256.
508    
509  The final 256-byte table has bits indicating various character types, as  The final 256-byte table has bits indicating various character types, as
# Line 517  The distribution should contain the foll Line 528  The distribution should contain the foll
528  (A) Source files of the PCRE library functions and their headers:  (A) Source files of the PCRE library functions and their headers:
529    
530    dftables.c             auxiliary program for building chartables.c    dftables.c             auxiliary program for building chartables.c
531    
532    pcreposix.c            )    pcreposix.c            )
533    pcre_compile.c         )    pcre_compile.c         )
534    pcre_config.c          )    pcre_config.c          )
# Line 540  The distribution should contain the foll Line 551  The distribution should contain the foll
551    pcre_xclass.c          )    pcre_xclass.c          )
552    pcre_printint.src      ) debugging function that is #included in pcretest,    pcre_printint.src      ) debugging function that is #included in pcretest,
553                           )   and can also be #included in pcre_compile()                           )   and can also be #included in pcre_compile()
   pcre.h                 ) a version of the public PCRE header file  
                          )   for use in non-"configure" environments  
554    pcre.h.in              template for pcre.h when built by "configure"    pcre.h.in              template for pcre.h when built by "configure"
555    pcreposix.h            header for the external POSIX wrapper API    pcreposix.h            header for the external POSIX wrapper API
556    pcre_internal.h        header for internal use    pcre_internal.h        header for internal use
557    ucp.h                  ) headers concerned with    ucp.h                  ) headers concerned with
558    ucpinternal.h          )   Unicode property handling    ucpinternal.h          )   Unicode property handling
559    ucptable.h             ) (this one is the data table)    ucptable.h             ) (this one is the data table)
560    
561    config.h               ) a version of config.h for use in non-"configure"    config.h.in            template for config.h, which is built by "configure"
562                           )   environments  
   config.h.in            template for config.h when built by "configure"  
   
563    pcrecpp.h              public header file for the C++ wrapper    pcrecpp.h              public header file for the C++ wrapper
564    pcrecpparg.h.in        template for another C++ header file    pcrecpparg.h.in        template for another C++ header file
565    pcre_scanner.h         public header file for C++ scanner functions    pcre_scanner.h         public header file for C++ scanner functions
566    pcrecpp.cc             )    pcrecpp.cc             )
567    pcre_scanner.cc        ) source for the C++ wrapper library    pcre_scanner.cc        ) source for the C++ wrapper library
568    
569    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the    pcre_stringpiece.h.in  template for pcre_stringpiece.h, the header for the
570                             C++ stringpiece functions                             C++ stringpiece functions
571    pcre_stringpiece.cc    source for the C++ stringpiece functions    pcre_stringpiece.cc    source for the C++ stringpiece functions
572    
573  (B) Source files for programs that use PCRE:  (B) Source files for programs that use PCRE:
574    
575    pcredemo.c             simple demonstration of coding calls to PCRE    pcredemo.c             simple demonstration of coding calls to PCRE
576    pcregrep.c             source of a grep utility that uses PCRE    pcregrep.c             source of a grep utility that uses PCRE
577    pcretest.c             comprehensive test program    pcretest.c             comprehensive test program
578    
579  (C) Auxiliary files:  (C) Auxiliary files:
580    
581      132html                script to turn "man" pages into HTML
582    AUTHORS                information about the author of PCRE    AUTHORS                information about the author of PCRE
583    ChangeLog              log of changes to the code    ChangeLog              log of changes to the code
584      CleanTxt               script to clean nroff output for txt man pages
585      Detrail                script to remove trailing spaces
586      Index.html             the base HTML page
587    INSTALL                generic installation instructions    INSTALL                generic installation instructions
588    LICENCE                conditions for the use of PCRE    LICENCE                conditions for the use of PCRE
589    COPYING                the same, using GNU's standard name    COPYING                the same, using GNU's standard name
590    Makefile.in            ) template for Unix Makefile, which is built by    Makefile.in            ) template for Unix Makefile, which is built by
591                           )   "configure"                           )   "configure"
592    Makefile.am            ) the automake input that was used to create    Makefile.am            ) the automake input that was used to create
593                           )   Makefile.in                           )   Makefile.in
594    NEWS                   important changes in this release    NEWS                   important changes in this release
595    NON-UNIX-USE           notes on building PCRE on non-Unix systems    NON-UNIX-USE           notes on building PCRE on non-Unix systems
596      PrepareRelease         script to make preparations for "make dist"
597    README                 this file    README                 this file
598    RunTest.in             template for a Unix shell script for running tests    RunTest.in             template for a Unix shell script for running tests
599    RunGrepTest.in         template for a Unix shell script for pcregrep tests    RunGrepTest.in         template for a Unix shell script for pcregrep tests
# Line 589  The distribution should contain the foll Line 601  The distribution should contain the foll
601    config.guess           ) files used by libtool,    config.guess           ) files used by libtool,
602    config.sub             )   used only when building a shared library    config.sub             )   used only when building a shared library
603    configure              a configuring shell script (built by autoconf)    configure              a configuring shell script (built by autoconf)
604    configure.ac           ) the autoconf input that was used to build    configure.ac           ) the autoconf input that was used to build
605                           )   "configure" and config.h                           )   "configure" and config.h
606    depcomp                ) script to find program dependencies, generated by    depcomp                ) script to find program dependencies, generated by
607                           )   automake                           )   automake
608    doc/*.3                man page sources for the PCRE functions    doc/*.3                man page sources for the PCRE functions
609    doc/*.1                man page sources for pcregrep and pcretest    doc/*.1                man page sources for pcregrep and pcretest
610    doc/html/*             HTML documentation    doc/html/*             HTML documentation
# Line 601  The distribution should contain the foll Line 613  The distribution should contain the foll
613    doc/perltest.txt       plain text documentation of Perl test program    doc/perltest.txt       plain text documentation of Perl test program
614    install-sh             a shell script for installing files    install-sh             a shell script for installing files
615    libpcre.pc.in          template for libpcre.pc for pkg-config    libpcre.pc.in          template for libpcre.pc for pkg-config
616    libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config    libpcrecpp.pc.in       template for libpcrecpp.pc for pkg-config
617    ltmain.sh              file used to build a libtool script    ltmain.sh              file used to build a libtool script
618    missing                ) common stub for a few missing GNU programs while    missing                ) common stub for a few missing GNU programs while
619                           )   installing, generated by automake                           )   installing, generated by automake
620    mkinstalldirs          script for making install directories    mkinstalldirs          script for making install directories
621    perltest.pl            Perl test program    perltest.pl            Perl test program
622    pcre-config.in         source of script which retains PCRE information    pcre-config.in         source of script which retains PCRE information
623    pcrecpp_unittest.c           )    pcrecpp_unittest.cc          )
624    pcre_scanner_unittest.c      ) test programs for the C++ wrapper    pcre_scanner_unittest.cc     ) test programs for the C++ wrapper
625    pcre_stringpiece_unittest.c  )    pcre_stringpiece_unittest.cc )
626    testdata/testinput*    test data for main library tests    testdata/testinput*    test data for main library tests
627    testdata/testoutput*   expected test results    testdata/testoutput*   expected test results
628    testdata/grep*         input and output for pcregrep tests    testdata/grep*         input and output for pcregrep tests
629    
630  (D) Auxiliary files for cmake support  (D) Auxiliary files for cmake support
631    
632    CMakeLists.txt    CMakeLists.txt
633    config-cmake.h.in    config-cmake.h.in
634    
635  (E) Auxiliary files for VPASCAL  (E) Auxiliary files for VPASCAL
636    
637    makevp.bat    makevp.bat
638    !compile.txt    !compile.txt
639    !linklib.txt    !linklib.txt
640    pcregexp.pas    pcregexp.pas
641    
642    (F) Auxiliary files for building PCRE "by hand"
643    
644      pcre.h.generic         ) a version of the public PCRE header file
645                             )   for use in non-"configure" environments
646      config.h.generic       ) a version of config.h for use in non-"configure"
647                             )   environments
648    
649  (F) Miscellaneous  (F) Miscellaneous
650    
651    RunTest.bat            a script for running tests under Windows    RunTest.bat            a script for running tests under Windows
Legend:
Removed from v.109  
changed lines
  Added in v.111
  ViewVC Help
Powered by ViewVC 1.1.5