.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` 
.    ds C' 
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PG_CONFTOOL 1"
.TH PG_CONFTOOL 1 2024-04-15 Debian "Debian PostgreSQL infrastructure"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
pg_conftool \- read and edit PostgreSQL cluster configuration files
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBpg_conftool\fR [\fIoptions\fR] [\fIversion\fR \fIcluster\fR] [\fIconfigfile\fR] \fBcommand\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBpg_conftool\fR allows showing and setting parameters in PostgreSQL configuration
files.
.PP
If \fIversion\fR \fIcluster\fR is omitted, it defaults to the default cluster (see
\&\fBuser_clusters\fR\|(5) and \fBpostgresqlrc\fR\|(5)). If \fIconfigfile\fR is omitted, it defaults
to \fBpostgresql.conf\fR. \fIconfigfile\fR can also be a path, in which case
\&\fIversion\fR \fIcluster\fR is ignored.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-b\fR, \fB\-\-boolean\fR" 4
.IX Item "-b, --boolean"
Format boolean value as \fBon\fR or \fBoff\fR (not for "show all").
.IP "\fB\-s\fR, \fB\-\-short\fR" 4
.IX Item "-s, --short"
Show only the value (instead of key = value pair).
.IP "\fB\-v\fR, \fB\-\-verbose\fR" 4
.IX Item "-v, --verbose"
Verbose output.
.IP \fB\-\-help\fR 4
.IX Item "--help"
Print help.
.SH COMMANDS
.IX Header "COMMANDS"
.IP "\fBshow\fR \fIparameter\fR|\fBall\fR" 4
.IX Item "show parameter|all"
Show a parameter, or all present in this config file.
.IP "\fBset\fR \fIparameter\fR \fIvalue\fR" 4
.IX Item "set parameter value"
Set or update a parameter.
.IP "\fBremove\fR \fIparameter\fR" 4
.IX Item "remove parameter"
Remove (comment out) a parameter from a config file.
.IP \fBedit\fR 4
.IX Item "edit"
Open the config file in an editor.  Unless \fR\f(CB$EDITOR\fR\fB\fR is set, \fBvi\fR is used.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBuser_clusters\fR\|(5), \fBpostgresqlrc\fR\|(5)
.SH AUTHOR
.IX Header "AUTHOR"
Christoph Berg <myon@debian.org>