1
0
mirror of https://github.com/postgres/postgres.git synced 2025-12-19 17:02:53 +03:00
Files
postgres/doc/src/sgml/ref/pg_controldata.sgml
Peter Eisentraut bb4eefe7bf doc: Improve DocBook XML validity
DocBook XML is superficially compatible with DocBook SGML but has a
slightly stricter DTD that we have been violating in a few cases.
Although XSLT doesn't care whether the document is valid, the style
sheets don't necessarily process invalid documents correctly, so we need
to work toward fixing this.

This first commit moves the indexterms in refentry elements to an
allowed position.  It has no impact on the output.
2014-02-23 21:31:08 -05:00

68 lines
2.0 KiB
Plaintext

<!--
doc/src/sgml/ref/pg_controldata.sgml
PostgreSQL documentation
-->
<refentry id="APP-PGCONTROLDATA">
<indexterm zone="app-pgcontroldata">
<primary>pg_controldata</primary>
</indexterm>
<refmeta>
<refentrytitle><application>pg_controldata</application></refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
<refname>pg_controldata</refname>
<refpurpose>display control information of a <productname>PostgreSQL</productname> database cluster</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_controldata</command>
<arg choice="opt"><replaceable class="parameter">option</replaceable></arg>
<arg choice="opt"><replaceable class="parameter">datadir</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="R1-APP-PGCONTROLDATA-1">
<title>Description</title>
<para>
<command>pg_controldata</command> prints information initialized during
<command>initdb</>, 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.
</para>
<para>
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 <envar>PGDATA</>. This utility supports the options
<option>-V</> and <option>--version</>, which print the
<application>pg_controldata</application> version and exit. It also
supports options <option>-?</> and <option>--help</>, which output the
supported arguments.
</para>
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term><envar>PGDATA</envar></term>
<listitem>
<para>
Default data directory location
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>