doc/src/sgml/ref/pg_controldata.sgml

   1 <!--
   2 $PostgreSQL: pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.7 2003/11/29 19:51:39 pgsql Exp $
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="APP-PGCONTROLDATA">
   7  <refmeta>
   8   <refentrytitle id="APP-PGCONTROLDATA-TITLE"><application>pg_controldata</application></refentrytitle>
   9   <manvolnum>1</manvolnum>
  10   <refmiscinfo>Application</refmiscinfo>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>pg_controldata</refname>
  15   <refpurpose>display control information of a <productname>PostgreSQL</productname> database cluster</refpurpose>
  16  </refnamediv>
  17
  18  <indexterm zone="app-pgcontroldata">
  19   <primary>pg_controldata</primary>
  20  </indexterm>
  21
  22  <refsynopsisdiv>
  23   <cmdsynopsis>
  24    <command>pg_controldata</command>
  25    <arg><replaceable class="parameter">datadir</replaceable></arg>
  26   </cmdsynopsis>
  27  </refsynopsisdiv>
  28
  29  <refsect1 id="R1-APP-PGCONTROLDATA-1">
  30   <title>Description</title>
  31   <para>
  32    <command>pg_controldata</command> prints information initialized during
  33    <command>initdb</>, such as the catalog version and server locale.
  34    It also shows information about write-ahead logging and checkpoint
  35    processing.  This information is cluster-wide, and not specific to any one
  36    database.
  37   </para>
  38
  39   <para>
  40    This utility may only be run by the user who initialized the cluster because
  41    it requires read access to the data directory.
  42    You can specify the data directory on the command line, or use
  43    the environment variable <envar>PGDATA</>.
  44   </para>
  45  </refsect1>
  46
  47  <refsect1>
  48   <title>Environment</title>
  49
  50   <variablelist>
  51    <varlistentry>
  52     <term><envar>PGDATA</envar></term>
  53
  54     <listitem>
  55      <para>
  56       Default data directory location
  57      </para>
  58     </listitem>
  59    </varlistentry>
  60
  61   </variablelist>
  62  </refsect1>
  63 </refentry>
  64
  65 <!-- Keep this comment at the end of the file
  66 Local variables:
  67 mode: sgml
  68 sgml-omittag:nil
  69 sgml-shorttag:t
  70 sgml-minimize-attributes:nil
  71 sgml-always-quote-attributes:t
  72 sgml-indent-step:1
  73 sgml-indent-data:t
  74 sgml-parent-document:nil
  75 sgml-default-dtd-file:"../reference.ced"
  76 sgml-exposed-tags:nil
  77 sgml-local-catalogs:"/usr/lib/sgml/catalog"
  78 sgml-local-ecat-files:nil
  79 End:
  80 -->