.\" -*- 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_LSCLUSTERS 1"
.TH PG_LSCLUSTERS 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_lsclusters \- show information about all PostgreSQL clusters
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBpg_lsclusters\fR [\fIoptions\fR] [\fIversion\fR [\fIcluster\fR]]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This command list the status and some configuration details of all clusters.
If a version and optionally a cluster name are given, only these are shown.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-h\fR, \fB\-\-no\-header\fR" 4
.IX Item "-h, --no-header"
Do not print the column header line.
.IP "\fB\-j\fR, \fB\-\-json\fR" 4
.IX Item "-j, --json"
Output information in JSON format. Needs JSON.pm installed.
(Debian package: libjson-perl)
.IP "\fB\-s\fR, \fB\-\-start\-conf\fR" 4
.IX Item "-s, --start-conf"
Include \fIstart.conf\fR information in status column.
.IP \fB\-\-help\fR 4
.IX Item "--help"
Print usage help.
.SH NOTES
.IX Header "NOTES"
The cluster status is shown as \fBonline\fR or \fBdown\fR. If a \fIrecovery.conf\fR file
is found in the data directory, \fB,recovery\fR is appended. The latter needs read
access to the data directory, which only root and the cluster owner have.
.PP
The output lines are colored green and red to indicate the cluster status
visually.
.SH AUTHOR
.IX Header "AUTHOR"
Martin Pitt <mpitt@debian.org>