begriffs open source - ai-pg/blob - full-docs/man1/pg_controldata.1

   1 '\" t
   2 .\"     Title: pg_controldata
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "PG_CONTROLDATA" "1" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 pg_controldata \- display control information of a PostgreSQL database cluster
  32 .SH "SYNOPSIS"
  33 .HP \w'\fBpg_controldata\fR\ 'u
  34 \fBpg_controldata\fR [\fIoption\fR] [[\fB\-D\fR | \fB\-\-pgdata\fR]\fIdatadir\fR]
  35 .SH "DESCRIPTION"
  36 .PP
  37 \fBpg_controldata\fR
  38 prints information initialized during
  39 \fBinitdb\fR, such as the catalog version\&. It also shows information about write\-ahead logging and checkpoint processing\&. This information is cluster\-wide, and not specific to any one database\&.
  40 .PP
  41 This utility can only be run by the user who initialized the cluster because it requires read access to the data directory\&. You can specify the data directory on the command line, or use the environment variable
  42 \fBPGDATA\fR\&. This utility supports the options
  43 \fB\-V\fR
  44 and
  45 \fB\-\-version\fR, which print the
  46 pg_controldata
  47 version and exit\&. It also supports options
  48 \fB\-?\fR
  49 and
  50 \fB\-\-help\fR, which output the supported arguments\&.
  51 .SH "ENVIRONMENT"
  52 .PP
  53 \fBPGDATA\fR
  54 .RS 4
  55 Default data directory location
  56 .RE
  57 .PP
  58 \fBPG_COLOR\fR
  59 .RS 4
  60 Specifies whether to use color in diagnostic messages\&. Possible values are
  61 always,
  62 auto
  63 and
  64 never\&.
  65 .RE