chiark / gitweb /
pcre3 (2:8.35-7.1) unstable; urgency=medium
[pcre3.git] / doc / pcre-config.1
1 .TH PCRE-CONFIG 1 "01 January 2012" "PCRE 8.30"
2 .SH NAME
3 pcre-config - program to return PCRE configuration
4 .SH SYNOPSIS
5 .rs
6 .sp
7 .nf
8 .B pcre-config  [--prefix] [--exec-prefix] [--version] [--libs]
9 .B "            [--libs16] [--libs32] [--libs-cpp] [--libs-posix]"
10 .B "            [--cflags] [--cflags-posix]"
11 .fi
12 .
13 .
14 .SH DESCRIPTION
15 .rs
16 .sp
17 \fBpcre-config\fP returns the configuration of the installed PCRE
18 libraries and the options required to compile a program to use them. Some of
19 the options apply only to the 8-bit, or 16-bit, or 32-bit libraries,
20 respectively, and are
21 not available if only one of those libraries has been built. If an unavailable
22 option is encountered, the "usage" information is output.
23 .
24 .
25 .SH OPTIONS
26 .rs
27 .TP 10
28 \fB--prefix\fP
29 Writes the directory prefix used in the PCRE installation for architecture
30 independent files (\fI/usr\fP on many systems, \fI/usr/local\fP on some
31 systems) to the standard output.
32 .TP 10
33 \fB--exec-prefix\fP
34 Writes the directory prefix used in the PCRE installation for architecture
35 dependent files (normally the same as \fB--prefix\fP) to the standard output.
36 .TP 10
37 \fB--version\fP
38 Writes the version number of the installed PCRE libraries to the standard
39 output.
40 .TP 10
41 \fB--libs\fP
42 Writes to the standard output the command line options required to link
43 with the 8-bit PCRE library (\fB-lpcre\fP on many systems).
44 .TP 10
45 \fB--libs16\fP
46 Writes to the standard output the command line options required to link
47 with the 16-bit PCRE library (\fB-lpcre16\fP on many systems).
48 .TP 10
49 \fB--libs32\fP
50 Writes to the standard output the command line options required to link
51 with the 32-bit PCRE library (\fB-lpcre32\fP on many systems).
52 .TP 10
53 \fB--libs-cpp\fP
54 Writes to the standard output the command line options required to link with
55 PCRE's C++ wrapper library (\fB-lpcrecpp\fP \fB-lpcre\fP on many
56 systems).
57 .TP 10
58 \fB--libs-posix\fP
59 Writes to the standard output the command line options required to link with
60 PCRE's POSIX API wrapper library (\fB-lpcreposix\fP \fB-lpcre\fP on many
61 systems).
62 .TP 10
63 \fB--cflags\fP
64 Writes to the standard output the command line options required to compile
65 files that use PCRE (this may include some \fB-I\fP options, but is blank on
66 many systems).
67 .TP 10
68 \fB--cflags-posix\fP
69 Writes to the standard output the command line options required to compile
70 files that use PCRE's POSIX API wrapper library (this may include some \fB-I\fP
71 options, but is blank on many systems).
72 .
73 .
74 .SH "SEE ALSO"
75 .rs
76 .sp
77 \fBpcre(3)\fP
78 .
79 .
80 .SH AUTHOR
81 .rs
82 .sp
83 This manual page was originally written by Mark Baker for the Debian GNU/Linux
84 system. It has been subsequently revised as a generic PCRE man page.
85 .
86 .
87 .SH REVISION
88 .rs
89 .sp
90 .nf
91 Last updated: 24 June 2012
92 .fi