diff options
| author | ph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15> | 2007-04-18 09:12:14 +0000 |
|---|---|---|
| committer | ph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15> | 2007-04-18 09:12:14 +0000 |
| commit | efca233fb31b1c0023b23cf6d664138361ea0179 (patch) | |
| tree | 9affc54d2606ea14864ef0c24a88c012227f1149 | |
| parent | 5fd059193d4e67c21e33e6d6c3866078fddf958f (diff) | |
| download | pcre-efca233fb31b1c0023b23cf6d664138361ea0179.tar.gz | |
Added a man page for pcre-config.
git-svn-id: svn://vcs.exim.org/pcre/code/trunk@153 2f5784b3-3f2a-0410-8824-cb99058d5e15
| -rw-r--r-- | ChangeLog | 2 | ||||
| -rw-r--r-- | Makefile.am | 3 | ||||
| -rwxr-xr-x | PrepareRelease | 4 | ||||
| -rw-r--r-- | doc/html/index.html | 3 | ||||
| -rw-r--r-- | doc/html/pcre-config.html | 88 | ||||
| -rw-r--r-- | doc/html/pcre.html | 7 | ||||
| -rw-r--r-- | doc/index.html.src | 3 | ||||
| -rw-r--r-- | doc/pcre-config.1 | 73 | ||||
| -rw-r--r-- | doc/pcre-config.txt | 67 | ||||
| -rw-r--r-- | doc/pcre.3 | 7 | ||||
| -rw-r--r-- | doc/pcre.txt | 7 |
11 files changed, 253 insertions, 11 deletions
@@ -149,6 +149,8 @@ Version 7.1 12-Mar-07 23. Added some casts to kill warnings from HP-UX ia64 compiler. +24. Added a man page for pcre-config. + Version 7.0 19-Dec-06 --------------------- diff --git a/Makefile.am b/Makefile.am index 9906793..b34243b 100644 --- a/Makefile.am +++ b/Makefile.am @@ -2,6 +2,7 @@ dist_doc_DATA = \ doc/pcre.txt \ + doc/pcre-config.txt \ doc/pcregrep.txt \ doc/pcretest.txt \ AUTHORS \ @@ -14,6 +15,7 @@ dist_doc_DATA = \ dist_html_DATA = \ doc/html/index.html \ doc/html/pcre.html \ + doc/html/pcre-config.html \ doc/html/pcre_compile.html \ doc/html/pcre_compile2.html \ doc/html/pcre_config.html \ @@ -301,6 +303,7 @@ endif dist_man_MANS = \ doc/pcre.3 \ + doc/pcre-config.1 \ doc/pcre_compile.3 \ doc/pcre_compile2.3 \ doc/pcre_config.3 \ diff --git a/PrepareRelease b/PrepareRelease index 0d9d183..c4447ca 100755 --- a/PrepareRelease +++ b/PrepareRelease @@ -59,8 +59,8 @@ for file in pcre pcrebuild pcrematching pcreapi pcrecallout pcrecompat \ fi done -# The two commands -for file in pcretest pcregrep ; do +# The three commands +for file in pcretest pcregrep pcre-config ; do echo Making $file.txt nroff -c -man $file.1 >$file.rawtxt ../CleanTxt <$file.rawtxt >$file.txt diff --git a/doc/html/index.html b/doc/html/index.html index acb2692..36ae372 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -18,6 +18,9 @@ The HTML documentation for PCRE comprises the following pages: <tr><td><a href="pcre.html">pcre</a></td> <td> Introductory page</td></tr> +<tr><td><a href="pcre-config.html">pcre-config</a></td> + <td> Information about the installation configuration</td></tr> + <tr><td><a href="pcreapi.html">pcreapi</a></td> <td> PCRE's native API</td></tr> diff --git a/doc/html/pcre-config.html b/doc/html/pcre-config.html new file mode 100644 index 0000000..b227c6f --- /dev/null +++ b/doc/html/pcre-config.html @@ -0,0 +1,88 @@ +<html> +<head> +<title>pcre-config specification</title> +</head> +<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> +<h1>pcre-config man page</h1> +<p> +Return to the <a href="index.html">PCRE index page</a>. +</p> +<p> +This page is part of the PCRE HTML documentation. It was generated automatically +from the original man page. If there is any nonsense in it, please consult the +man page, in case the conversion went wrong. +<br> +<ul> +<li><a name="TOC1" href="#SEC1">SYNOPSIS</a> +<li><a name="TOC2" href="#SEC2">DESCRIPTION</a> +<li><a name="TOC3" href="#SEC3">OPTIONS</a> +<li><a name="TOC4" href="#SEC4">SEE ALSO</a> +<li><a name="TOC5" href="#SEC5">AUTHOR</a> +<li><a name="TOC6" href="#SEC6">REVISION</a> +</ul> +<br><a name="SEC1" href="#TOC1">SYNOPSIS</a><br> +<P> +<b>pcre-config [--prefix] [--exec-prefix] [--version] [--libs] </b> +<b>[--libs-posix] [--cflags] [--cflags-posix]</b> +</P> +<br><a name="SEC2" href="#TOC1">DESCRIPTION</a><br> +<P> +<b>pcre-config</b> returns the configuration of the installed PCRE +libraries and the options required to compile a program to use them. +</P> +<br><a name="SEC3" href="#TOC1">OPTIONS</a><br> +<P> +<b>--prefix</b> +Writes the directory prefix used in the PCRE installation for architecture +independent files (<i>/usr</i> on many systems, <i>/usr/local</i> on some +systems) to the standard output. +</P> +<P> +<b>--exec-prefix</b> +Writes the directory prefix used in the PCRE installation for architecture +dependent files (normally the same as <b>--prefix</b>) to the standard output. +</P> +<P> +<b>--version</b> +Writes the version number of the installed PCRE libraries to the standard +output. +</P> +<P> +<b>--libs</b> +Writes to the standard output the command line options required to link +with PCRE (<b>-lpcre</b> on many systems). +</P> +<P> +<b>--libs-posix</b> +Writes to the standard output the command line options required to link with +the PCRE posix emulation library (<b>-lpcreposix</b> <b>-lpcre</b> on many +systems). +</P> +<P> +<b>--cflags</b> +Writes to the standard output the command line options required to compile +files that use PCRE (this may include some <b>-I</b> options, but is blank on +many systems). +</P> +<P> +<b>--cflags-posix</b> +Writes to the standard output the command line options required to compile +files that use the PCRE posix emulation library (this may include some <b>-I</b> +options, but is blank on many systems). +</P> +<br><a name="SEC4" href="#TOC1">SEE ALSO</a><br> +<P> +<b>pcre(3)</b> +</P> +<br><a name="SEC5" href="#TOC1">AUTHOR</a><br> +<P> +This manual page was originally written by Mark Baker for the Debian GNU/Linux +system. It has been slightly revised as a generic PCRE man page. +</P> +<br><a name="SEC6" href="#TOC1">REVISION</a><br> +<P> +Last updated: 18 April 2007 +<br> +<p> +Return to the <a href="index.html">PCRE index page</a>. +</p> diff --git a/doc/html/pcre.html b/doc/html/pcre.html index b6ff2c7..5859b68 100644 --- a/doc/html/pcre.html +++ b/doc/html/pcre.html @@ -88,6 +88,7 @@ all the sections are concatenated, for ease of searching. The sections are as follows: <pre> pcre this document + pcre-config show PCRE installation configuration information pcreapi details of PCRE's native C API pcrebuild options for building PCRE pcrecallout details of the callout feature @@ -248,12 +249,12 @@ Cambridge CB2 3QH, England. </P> <P> Putting an actual email address here seems to have been a spam magnet, so I've -taken it away. If you want to email me, use my initial and surname, separated -by a dot, at the domain ucs.cam.ac.uk. +taken it away. If you want to email me, use my two initials, followed by the +two digits 10, at the domain cam.ac.uk. </P> <br><a name="SEC6" href="#TOC1">REVISION</a><br> <P> -Last updated: 06 March 2007 +Last updated: 18 April 2007 <br> Copyright © 1997-2007 University of Cambridge. <br> diff --git a/doc/index.html.src b/doc/index.html.src index eda1ad5..b032434 100644 --- a/doc/index.html.src +++ b/doc/index.html.src @@ -18,6 +18,9 @@ The HTML documentation for PCRE comprises the following pages: <tr><td><a href="pcre.html">pcre</a></td> <td> Introductory page</td></tr> +<tr><td><a href="pcre-config.html">pcre-config</a></td> + <td> Information about the installation configuration</td></tr> + <tr><td><a href="pcreapi.html">pcreapi</a></td> <td> PCRE's native API</td></tr> diff --git a/doc/pcre-config.1 b/doc/pcre-config.1 new file mode 100644 index 0000000..afbd3a0 --- /dev/null +++ b/doc/pcre-config.1 @@ -0,0 +1,73 @@ +.TH PCRE-CONFIG 1 +.SH NAME +pcre-config - program to return PCRE configuration +.SH SYNOPSIS +.rs +.sp +.B pcre-config [--prefix] [--exec-prefix] [--version] [--libs] +.ti +5n +.B [--libs-posix] [--cflags] [--cflags-posix] +. +. +.SH DESCRIPTION +.rs +.sp +\fBpcre-config\fP returns the configuration of the installed PCRE +libraries and the options required to compile a program to use them. +. +. +.SH OPTIONS +.rs +.TP 10 +\fB--prefix\fP +Writes the directory prefix used in the PCRE installation for architecture +independent files (\fI/usr\fP on many systems, \fI/usr/local\fP on some +systems) to the standard output. +.TP 10 +\fB--exec-prefix\fP +Writes the directory prefix used in the PCRE installation for architecture +dependent files (normally the same as \fB--prefix\fP) to the standard output. +.TP 10 +\fB--version\fP +Writes the version number of the installed PCRE libraries to the standard +output. +.TP 10 +\fB--libs\fP +Writes to the standard output the command line options required to link +with PCRE (\fB-lpcre\fP on many systems). +.TP 10 +\fB--libs-posix\fP +Writes to the standard output the command line options required to link with +the PCRE posix emulation library (\fB-lpcreposix\fP \fB-lpcre\fP on many +systems). +.TP 10 +\fB--cflags\fP +Writes to the standard output the command line options required to compile +files that use PCRE (this may include some \fB-I\fP options, but is blank on +many systems). +.TP 10 +\fB--cflags-posix\fP +Writes to the standard output the command line options required to compile +files that use the PCRE posix emulation library (this may include some \fB-I\fP +options, but is blank on many systems). +. +. +.SH "SEE ALSO" +.rs +.sp +\fBpcre(3)\fP +. +. +.SH AUTHOR +.rs +.sp +This manual page was originally written by Mark Baker for the Debian GNU/Linux +system. It has been slightly revised as a generic PCRE man page. +. +. +.SH REVISION +.rs +.sp +.nf +Last updated: 18 April 2007 +.fi diff --git a/doc/pcre-config.txt b/doc/pcre-config.txt new file mode 100644 index 0000000..c979d45 --- /dev/null +++ b/doc/pcre-config.txt @@ -0,0 +1,67 @@ +PCRE-CONFIG(1) PCRE-CONFIG(1) + + + +NAME + pcre-config - program to return PCRE configuration + +SYNOPSIS + + pcre-config [--prefix] [--exec-prefix] [--version] [--libs] + [--libs-posix] [--cflags] [--cflags-posix] + + +DESCRIPTION + + pcre-config returns the configuration of the installed PCRE libraries + and the options required to compile a program to use them. + + +OPTIONS + + --prefix Writes the directory prefix used in the PCRE installation for + architecture independent files (/usr on many systems, + /usr/local on some systems) to the standard output. + + --exec-prefix + Writes the directory prefix used in the PCRE installation for + architecture dependent files (normally the same as --prefix) + to the standard output. + + --version Writes the version number of the installed PCRE libraries to + the standard output. + + --libs Writes to the standard output the command line options + required to link with PCRE (-lpcre on many systems). + + --libs-posix + Writes to the standard output the command line options + required to link with the PCRE posix emulation library + (-lpcreposix -lpcre on many systems). + + --cflags Writes to the standard output the command line options + required to compile files that use PCRE (this may include + some -I options, but is blank on many systems). + + --cflags-posix + Writes to the standard output the command line options + required to compile files that use the PCRE posix emulation + library (this may include some -I options, but is blank on + many systems). + + +SEE ALSO + + pcre(3) + + +AUTHOR + + This manual page was originally written by Mark Baker for the Debian + GNU/Linux system. It has been slightly revised as a generic PCRE man + page. + + +REVISION + + Last updated: 18 April 2007 @@ -81,6 +81,7 @@ all the sections are concatenated, for ease of searching. The sections are as follows: .sp pcre this document + pcre-config show PCRE installation configuration information pcreapi details of PCRE's native C API pcrebuild options for building PCRE pcrecallout details of the callout feature @@ -239,14 +240,14 @@ Cambridge CB2 3QH, England. .fi .P Putting an actual email address here seems to have been a spam magnet, so I've -taken it away. If you want to email me, use my initial and surname, separated -by a dot, at the domain ucs.cam.ac.uk. +taken it away. If you want to email me, use my two initials, followed by the +two digits 10, at the domain cam.ac.uk. . . .SH REVISION .rs .sp .nf -Last updated: 06 March 2007 +Last updated: 18 April 2007 Copyright (c) 1997-2007 University of Cambridge. .fi diff --git a/doc/pcre.txt b/doc/pcre.txt index 658f750..c15bef6 100644 --- a/doc/pcre.txt +++ b/doc/pcre.txt @@ -72,6 +72,7 @@ USER DOCUMENTATION of searching. The sections are as follows: pcre this document + pcre-config show PCRE installation configuration information pcreapi details of PCRE's native C API pcrebuild options for building PCRE pcrecallout details of the callout feature @@ -215,13 +216,13 @@ AUTHOR Cambridge CB2 3QH, England. Putting an actual email address here seems to have been a spam magnet, - so I've taken it away. If you want to email me, use my initial and sur- - name, separated by a dot, at the domain ucs.cam.ac.uk. + so I've taken it away. If you want to email me, use my two initials, + followed by the two digits 10, at the domain cam.ac.uk. REVISION - Last updated: 06 March 2007 + Last updated: 18 April 2007 Copyright (c) 1997-2007 University of Cambridge. ------------------------------------------------------------------------------ |