granicus.if.org Git - postgresql/blob - doc/src/sgml/ref/pg_controldata.sgml

   1 <!--
   2 doc/src/sgml/ref/pg_controldata.sgml
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="APP-PGCONTROLDATA">
   7  <indexterm zone="app-pgcontroldata">
   8   <primary>pg_controldata</primary>
   9  </indexterm>
  10
  11  <refmeta>
  12   <refentrytitle><application>pg_controldata</application></refentrytitle>
  13   <manvolnum>1</manvolnum>
  14   <refmiscinfo>Application</refmiscinfo>
  15  </refmeta>
  16
  17  <refnamediv>
  18   <refname>pg_controldata</refname>
  19   <refpurpose>display control information of a <productname>PostgreSQL</productname> database cluster</refpurpose>
  20  </refnamediv>
  21
  22  <refsynopsisdiv>
  23   <cmdsynopsis>
  24    <command>pg_controldata</command>
  25    <arg choice="opt"><replaceable class="parameter">option</replaceable></arg>
  26    <arg choice="opt"><arg choice="opt"><option>-D</option></arg> <replaceable class="parameter">datadir</replaceable></arg>
  27   </cmdsynopsis>
  28  </refsynopsisdiv>
  29
  30  <refsect1 id="R1-APP-PGCONTROLDATA-1">
  31   <title>Description</title>
  32   <para>
  33    <command>pg_controldata</command> prints information initialized during
  34    <command>initdb</>, such as the catalog version.
  35    It also shows information about write-ahead logging and checkpoint
  36    processing.  This information is cluster-wide, and not specific to any one
  37    database.
  38   </para>
  39
  40   <para>
  41    This utility can only be run by the user who initialized the cluster because
  42    it requires read access to the data directory.
  43    You can specify the data directory on the command line, or use
  44    the environment variable <envar>PGDATA</>.  This utility supports the options
  45    <option>-V</> and <option>--version</>, which print the
  46    <application>pg_controldata</application> version and exit.  It also
  47    supports options <option>-?</> and <option>--help</>, which output the
  48    supported arguments.
  49   </para>
  50  </refsect1>
  51
  52  <refsect1>
  53   <title>Environment</title>
  54
  55   <variablelist>
  56    <varlistentry>
  57     <term><envar>PGDATA</envar></term>
  58
  59     <listitem>
  60      <para>
  61       Default data directory location
  62      </para>
  63     </listitem>
  64    </varlistentry>
  65   </variablelist>
  66  </refsect1>
  67 </refentry>