summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man1/pg_config.1
blob: 206112afe34ccfd1925029a7ef82c90832f32f73 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
'\" t
.\"     Title: pg_config
.\"    Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2022
.\"    Manual: PostgreSQL 14.5 Documentation
.\"    Source: PostgreSQL 14.5
.\"  Language: English
.\"
.TH "PG_CONFIG" "1" "2022" "PostgreSQL 14.5" "PostgreSQL 14.5 Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
pg_config \- retrieve information about the installed version of PostgreSQL
.SH "SYNOPSIS"
.HP \w'\fBpg_config\fR\ 'u
\fBpg_config\fR [\fIoption\fR...]
.SH "DESCRIPTION"
.PP
The
pg_config
utility prints configuration parameters of the currently installed version of
PostgreSQL\&. It is intended, for example, to be used by software packages that want to interface to
PostgreSQL
to facilitate finding the required header files and libraries\&.
.SH "OPTIONS"
.PP
To use
pg_config, supply one or more of the following options:
.PP
\fB\-\-bindir\fR
.RS 4
Print the location of user executables\&. Use this, for example, to find the
\fBpsql\fR
program\&. This is normally also the location where the
pg_config
program resides\&.
.RE
.PP
\fB\-\-docdir\fR
.RS 4
Print the location of documentation files\&.
.RE
.PP
\fB\-\-htmldir\fR
.RS 4
Print the location of HTML documentation files\&.
.RE
.PP
\fB\-\-includedir\fR
.RS 4
Print the location of C header files of the client interfaces\&.
.RE
.PP
\fB\-\-pkgincludedir\fR
.RS 4
Print the location of other C header files\&.
.RE
.PP
\fB\-\-includedir\-server\fR
.RS 4
Print the location of C header files for server programming\&.
.RE
.PP
\fB\-\-libdir\fR
.RS 4
Print the location of object code libraries\&.
.RE
.PP
\fB\-\-pkglibdir\fR
.RS 4
Print the location of dynamically loadable modules, or where the server would search for them\&. (Other architecture\-dependent data files might also be installed in this directory\&.)
.RE
.PP
\fB\-\-localedir\fR
.RS 4
Print the location of locale support files\&. (This will be an empty string if locale support was not configured when
PostgreSQL
was built\&.)
.RE
.PP
\fB\-\-mandir\fR
.RS 4
Print the location of manual pages\&.
.RE
.PP
\fB\-\-sharedir\fR
.RS 4
Print the location of architecture\-independent support files\&.
.RE
.PP
\fB\-\-sysconfdir\fR
.RS 4
Print the location of system\-wide configuration files\&.
.RE
.PP
\fB\-\-pgxs\fR
.RS 4
Print the location of extension makefiles\&.
.RE
.PP
\fB\-\-configure\fR
.RS 4
Print the options that were given to the
configure
script when
PostgreSQL
was configured for building\&. This can be used to reproduce the identical configuration, or to find out with what options a binary package was built\&. (Note however that binary packages often contain vendor\-specific custom patches\&.) See also the examples below\&.
.RE
.PP
\fB\-\-cc\fR
.RS 4
Print the value of the
\fICC\fR
variable that was used for building
PostgreSQL\&. This shows the C compiler used\&.
.RE
.PP
\fB\-\-cppflags\fR
.RS 4
Print the value of the
\fICPPFLAGS\fR
variable that was used for building
PostgreSQL\&. This shows C compiler switches needed at preprocessing time (typically,
\-I
switches)\&.
.RE
.PP
\fB\-\-cflags\fR
.RS 4
Print the value of the
\fICFLAGS\fR
variable that was used for building
PostgreSQL\&. This shows C compiler switches\&.
.RE
.PP
\fB\-\-cflags_sl\fR
.RS 4
Print the value of the
\fICFLAGS_SL\fR
variable that was used for building
PostgreSQL\&. This shows extra C compiler switches used for building shared libraries\&.
.RE
.PP
\fB\-\-ldflags\fR
.RS 4
Print the value of the
\fILDFLAGS\fR
variable that was used for building
PostgreSQL\&. This shows linker switches\&.
.RE
.PP
\fB\-\-ldflags_ex\fR
.RS 4
Print the value of the
\fILDFLAGS_EX\fR
variable that was used for building
PostgreSQL\&. This shows linker switches used for building executables only\&.
.RE
.PP
\fB\-\-ldflags_sl\fR
.RS 4
Print the value of the
\fILDFLAGS_SL\fR
variable that was used for building
PostgreSQL\&. This shows linker switches used for building shared libraries only\&.
.RE
.PP
\fB\-\-libs\fR
.RS 4
Print the value of the
\fILIBS\fR
variable that was used for building
PostgreSQL\&. This normally contains
\-l
switches for external libraries linked into
PostgreSQL\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Print the version of
PostgreSQL\&.
.RE
.PP
\fB\-?\fR
.br
\fB\-\-help\fR
.RS 4
Show help about
pg_config
command line arguments, and exit\&.
.RE
If more than one option is given, the information is printed in that order, one item per line\&. If no options are given, all available information is printed, with labels\&.
.SH "NOTES"
.PP
The options
\fB\-\-docdir\fR,
\fB\-\-pkgincludedir\fR,
\fB\-\-localedir\fR,
\fB\-\-mandir\fR,
\fB\-\-sharedir\fR,
\fB\-\-sysconfdir\fR,
\fB\-\-cc\fR,
\fB\-\-cppflags\fR,
\fB\-\-cflags\fR,
\fB\-\-cflags_sl\fR,
\fB\-\-ldflags\fR,
\fB\-\-ldflags_sl\fR, and
\fB\-\-libs\fR
were added in
PostgreSQL
8\&.1\&. The option
\fB\-\-htmldir\fR
was added in
PostgreSQL
8\&.4\&. The option
\fB\-\-ldflags_ex\fR
was added in
PostgreSQL
9\&.0\&.
.SH "EXAMPLE"
.PP
To reproduce the build configuration of the current PostgreSQL installation, run the following command:
.sp
.if n \{\
.RS 4
.\}
.nf
eval \&./configure `pg_config \-\-configure`
.fi
.if n \{\
.RE
.\}
.sp
The output of
pg_config \-\-configure
contains shell quotation marks so arguments with spaces are represented correctly\&. Therefore, using
eval
is required for proper results\&.