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

Diff of /code/trunk/README

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

revision 975 by ph10, Sat Jun 2 11:03:06 2012 UTC revision 981 by ph10, Mon Jun 18 18:22:51 2012 UTC
# Line 18  The contents of this README file are: Line 18  The contents of this README file are:
18    The PCRE APIs    The PCRE APIs
19    Documentation for PCRE    Documentation for PCRE
20    Contributions by users of PCRE    Contributions by users of PCRE
21    Building PCRE on non-Unix systems    Building PCRE on non-Unix-like systems
22    Building PCRE on Unix-like systems    Building PCRE without using autotools
23    Retrieving configuration information on Unix-like systems    Building PCRE using autotools
24    Shared libraries on Unix-like systems    Retrieving configuration information
25    Cross-compiling on Unix-like systems    Shared libraries
26      Cross-compiling using autotools
27    Using HP's ANSI C++ compiler (aCC)    Using HP's ANSI C++ compiler (aCC)
28    Using PCRE from MySQL    Using PCRE from MySQL
29    Making new tarballs    Making new tarballs
# Line 109  Windows (I myself do not use Windows). N Line 110  Windows (I myself do not use Windows). N
110  in the standard distribution, so these contibutions have been archived.  in the standard distribution, so these contibutions have been archived.
111    
112    
113  Building PCRE on non-Unix systems  Building PCRE on non-Unix-like systems
114  ---------------------------------  --------------------------------------
115    
116  For a non-Unix system, please read the comments in the file NON-UNIX-USE,  For a non-Unix-like system, please read the comments in the file
117  though if your system supports the use of "configure" and "make" you may be  NON-AUTOTOOLS-BUILD, though if your system supports the use of "configure" and
118  able to build PCRE in the same way as for Unix-like systems. PCRE can also be  "make" you may be able to build PCRE using autotools in the same way as for
119  configured in many platform environments using the GUI facility provided by  many Unix-like systems.
120  CMake's cmake-gui command. This creates Makefiles, solution files, etc.  
121    PCRE can also be configured using the GUI facility provided by CMake's
122    cmake-gui command. This creates Makefiles, solution files, etc. The file
123    NON-AUTOTOOLS-BUILD has information about CMake.
124    
125  PCRE has been compiled on many different operating systems. It should be  PCRE has been compiled on many different operating systems. It should be
126  straightforward to build PCRE on any system that has a Standard C compiler and  straightforward to build PCRE on any system that has a Standard C compiler and
127  library, because it uses only Standard C functions.  library, because it uses only Standard C functions.
128    
129    
130  Building PCRE on Unix-like systems  Building PCRE without using autotools
131  ----------------------------------  -------------------------------------
132    
133    The use of autotools (in particular, libtool) is problematic in some
134    environments, even some that are Unix or Unix-like. See the NON-AUTOTOOLS-BUILD
135    file for ways of building PCRE without using autotools.
136    
137    
138    Building PCRE using autotools
139    -----------------------------
140    
141  If you are using HP's ANSI C++ compiler (aCC), please see the special note  If you are using HP's ANSI C++ compiler (aCC), please see the special note
142  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.  in the section entitled "Using HP's ANSI C++ compiler (aCC)" below.
143    
144  The following instructions assume the use of the widely used "configure, make,  The following instructions assume the use of the widely used "configure; make;
145  make install" process. There is also support for CMake in the PCRE  make install" (autotools) process.
146  distribution; there are some comments about using CMake in the NON-UNIX-USE  
147  file, though it can also be used in Unix-like systems.  To build PCRE on system that supports autotools, first run the "configure"
148    command from the PCRE distribution directory, with your current directory set
149  To build PCRE on a Unix-like system, first run the "configure" command from the  to the directory where you want the files to be created. This command is a
150  PCRE distribution directory, with your current directory set to the directory  standard GNU "autoconf" configuration script, for which generic instructions
151  where you want the files to be created. This command is a standard GNU  are supplied in the file INSTALL.
 "autoconf" configuration script, for which generic instructions are supplied in  
 the file INSTALL.  
152    
153  Most commonly, people build PCRE within its own distribution directory, and in  Most commonly, people build PCRE within its own distribution directory, and in
154  this case, on many systems, just running "./configure" is sufficient. However,  this case, on many systems, just running "./configure" is sufficient. However,
# Line 358  The "configure" script builds the follow Line 368  The "configure" script builds the follow
368  . libpcre16.pc       )  . libpcre16.pc       )
369  . libpcreposix.pc    )  . libpcreposix.pc    )
370  . libtool              script that builds shared and/or static libraries  . libtool              script that builds shared and/or static libraries
 . RunTest              script for running tests on the basic C library  
 . RunGrepTest          script for running tests on the pcregrep command  
371    
372  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the  Versions of config.h and pcre.h are distributed in the PCRE tarballs under the
373  names config.h.generic and pcre.h.generic. These are provided for those who  names config.h.generic and pcre.h.generic. These are provided for those who
# Line 448  This removes all the files that "make in Line 456  This removes all the files that "make in
456  remove any directories, because these are often shared with other programs.  remove any directories, because these are often shared with other programs.
457    
458    
459  Retrieving configuration information on Unix-like systems  Retrieving configuration information
460  ---------------------------------------------------------  ------------------------------------
461    
462  Running "make install" installs the command pcre-config, which can be used to  Running "make install" installs the command pcre-config, which can be used to
463  recall information about the PCRE configuration and installation. For example:  recall information about the PCRE configuration and installation. For example:
# Line 474  The data is held in *.pc files that are Line 482  The data is held in *.pc files that are
482  <prefix>/lib/pkgconfig.  <prefix>/lib/pkgconfig.
483    
484    
485  Shared libraries on Unix-like systems  Shared libraries
486  -------------------------------------  ----------------
487    
488  The default distribution builds PCRE as shared libraries and static libraries,  The default distribution builds PCRE as shared libraries and static libraries,
489  as long as the operating system supports shared libraries. Shared library  as long as the operating system supports shared libraries. Shared library
# Line 500  Then run "make" in the usual way. Simila Line 508  Then run "make" in the usual way. Simila
508  build only shared libraries.  build only shared libraries.
509    
510    
511  Cross-compiling on Unix-like systems  Cross-compiling using autotools
512  ------------------------------------  -------------------------------
513    
514  You can specify CC and CFLAGS in the normal way to the "configure" command, in  You can specify CC and CFLAGS in the normal way to the "configure" command, in
515  order to cross-compile PCRE for some other host. However, you should NOT  order to cross-compile PCRE for some other host. However, you should NOT
# Line 573  script creates the .txt and HTML forms o Line 581  script creates the .txt and HTML forms o
581  Testing PCRE  Testing PCRE
582  ------------  ------------
583    
584  To test the basic PCRE library on a Unix system, run the RunTest script that is  To test the basic PCRE library on a Unix-like system, run the RunTest script.
585  created by the configuring process. There is also a script called RunGrepTest  There is another script called RunGrepTest that tests the options of the
586  that tests the options of the pcregrep command. If the C++ wrapper library is  pcregrep command. If the C++ wrapper library is built, three test programs
587  built, three test programs called pcrecpp_unittest, pcre_scanner_unittest, and  called pcrecpp_unittest, pcre_scanner_unittest, and pcre_stringpiece_unittest
588  pcre_stringpiece_unittest are also built. When JIT support is enabled, another  are also built. When JIT support is enabled, another test program called
589  test program called pcre_jit_test is built.  pcre_jit_test is built.
590    
591  Both the scripts and all the program tests are run if you obey "make check" or  Both the scripts and all the program tests are run if you obey "make check" or
592  "make test". For other systems, see the instructions in NON-UNIX-USE.  "make test". For other environments, see the instructions in
593    NON-AUTOTOOLS-BUILD.
594    
595  The RunTest script runs the pcretest test program (which is documented in its  The RunTest script runs the pcretest test program (which is documented in its
596  own man page) on each of the relevant testinput files in the testdata  own man page) on each of the relevant testinput files in the testdata
# Line 606  tests. To run pcretest on just one or mo Line 615  tests. To run pcretest on just one or mo
615  numbers as arguments to RunTest, for example:  numbers as arguments to RunTest, for example:
616    
617    RunTest 2 7 11    RunTest 2 7 11
618    
619    You can also call RunTest with the single argument "list" to cause it to output
620    a list of tests.
621    
622  The first test file can be fed directly into the perltest.pl script to check  The first test file can be fed directly into the perltest.pl script to check
623  that Perl gives the same results. The only difference you should see is in the  that Perl gives the same results. The only difference you should see is in the
# Line 812  pcre_xxx and the other with the name pcr Line 824  pcre_xxx and the other with the name pcr
824    Makefile.am             ) the automake input that was used to create    Makefile.am             ) the automake input that was used to create
825                            )   Makefile.in                            )   Makefile.in
826    NEWS                    important changes in this release    NEWS                    important changes in this release
827    NON-UNIX-USE            notes on building PCRE on non-Unix systems    NON-UNIX-USE            the previous name for NON-AUTOTOOLS-BUILD
828      NON-AUTOTOOLS-BUILD     notes on building PCRE without using autotools
829    PrepareRelease          script to make preparations for "make dist"    PrepareRelease          script to make preparations for "make dist"
830    README                  this file    README                  this file
831    RunTest                 a Unix shell script for running tests    RunTest                 a Unix shell script for running tests
# Line 882  pcre_xxx and the other with the name pcr Line 895  pcre_xxx and the other with the name pcr
895  Philip Hazel  Philip Hazel
896  Email local part: ph10  Email local part: ph10
897  Email domain: cam.ac.uk  Email domain: cam.ac.uk
898  Last updated: 26 February 2012  Last updated: 18 June 2012

Legend:
Removed from v.975  
changed lines
  Added in v.981

  ViewVC Help
Powered by ViewVC 1.1.5