---
name: "pg_conftool"
section: "1"
platform: "linux"
package: "postgresql-common"
version: "278"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/pg_conftool"
---

# pg\_conftool(1)

read and edit PostgreSQL cluster configuration files

## NAME

pg\_conftool - read and edit PostgreSQL cluster configuration files

## SYNOPSIS

**pg\_conftool** \[*options*\] \[*version* *cluster*\] \[*configfile*\] **command**

## DESCRIPTION

**pg\_conftool** allows showing and setting parameters in PostgreSQL configuration files.

If *version* *cluster* is omitted, it defaults to the default cluster (see [**user\_clusters**(5)](/user_clusters/5.md) and [**postgresqlrc**(5)](/postgresqlrc/5.md)). If *configfile* is omitted, it defaults to **postgresql.conf**. *configfile* can also be a path, in which case *version* *cluster* is ignored.

## OPTIONS

- **-b**, **--boolean**

  Format boolean value as **on** or **off** (not for "show all").

- **-s**, **--short**

  Show only the value (instead of key = value pair).

- **-v**, **--verbose**

  Verbose output.

- **--help**

  Print help.

## COMMANDS

- **show** *parameter*\|**all**

  Show a parameter, or all present in this config file.

- **set** *parameter* *value*

  Set or update a parameter.

- **remove** *parameter*

  Remove (comment out) a parameter from a config file.

- **edit**

  Open the config file in an editor.  Unless **$EDITOR** is set, **vi** is used.

## SEE ALSO

[**user\_clusters**(5)](/user_clusters/5.md), [**postgresqlrc**(5)](/postgresqlrc/5.md)

## AUTHOR

Christoph Berg \<myon@debian.org\>