Skip to content
Snippets Groups Projects
Commit f74eddf1 authored by Martin Pitt's avatar Martin Pitt
Browse files

consistent POD formatting

parent d74a8a52
No related branches found
No related tags found
No related merge requests found
......@@ -247,32 +247,32 @@ B<pg_createcluster> [I<options>] I<version> I<name>
=head1 DESCRIPTION
B<pg_createcluster> creates a new PostgreSQL server cluster (i. e. a
collection of databases served by a B<postmaster> instance) and
collection of databases served by a L<postmaster(1)> instance) and
integrates it into the multi-version/multi-cluster architecture of the
B<postgresql-common> package.
Given a major PostgreSQL I<version> (like "7.4" or "8.0") and a cluster I<name>
(which must be unique for all clusters of one particular version), it creates
the necessary configuration files in
B</etc/postgresql/>I<version>B</>I<name>B</>; in particular these are
B<postgresql.conf>, B<pg_ident.conf>, B<pg_hba.conf>, a symbolic link
B<pgdata> which points to the actual data directory I<data dir> (which defaults
to B</var/lib/postgresql/>I<version>B</>I<name>B</>), and a symbolic link
B<log> which points to the log file (by default,
B</var/log/postgresql/postgresql->I<version>B<->I<name>B<.log>).
C</etc/postgresql/>I<version>C</>I<name>C</>; in particular these are
C<postgresql.conf>, C<pg_ident.conf>, C<pg_hba.conf>, a symbolic link
C<pgdata> which points to the actual data directory I<data dir> (which defaults
to C</var/lib/postgresql/>I<version>C</>I<name>C</>), and a symbolic link
C<log> which points to the log file (by default,
C</var/log/postgresql/postgresql->I<version>C<->I<name>C<.log>).
To enable easy integration of B<pg_autovacuum>, this program also creates a
symbolic link B<autovacuum_log> which points to the pg_autuvacuum log file (by
default, B</var/log/postgresql/pg_autovacuum->I<version>B<->I<name>B<.log>).
symbolic link C<autovacuum_log> which points to the pg_autuvacuum log file (by
default, C</var/log/postgresql/pg_autovacuum->I<version>C<->I<name>C<.log>).
B<postgresql.conf> is automatically adapted to use the next available port, i.
C<postgresql.conf> is automatically adapted to use the next available port, i.
e. the first port (starting from 5432) which is not yet used by an already
existing cluster.
If the data directory does not yet exist, PostgreSQL's B<initdb> command is
If the data directory does not yet exist, PostgreSQL's L<initdb(1)> command is
used to generate a new cluster structure. If the data directory already exists,
it is integrated into the B<postgresql-common> structure by moving the
configuration file and creating the B<pgdata> link.
configuration file and creating the C<pgdata> link.
If the log file does not exist, it is created. In any case the permissions are
adjusted to allow write access to the cluster owner.
......@@ -302,9 +302,9 @@ C</var/lib/postgresql/>I<version>C</>I<cluster>.
=item B<-s> I<dir>, B<--socketdir=>I<dir>
Explicitly set the directory where the L<postmaster(1)> server stores the Unix
socket for local connections. Defaults to B</var/run/postgresql/> for clusters
owned by the user B<postgres>, and B</tmp> for clusters owned by other users.
Please be aware that B</tmp> is an unsafe directory since everybody can create
socket for local connections. Defaults to C</var/run/postgresql/> for clusters
owned by the user B<postgres>, and C</tmp> for clusters owned by other users.
Please be aware that C</tmp> is an unsafe directory since everybody can create
a socket there and impersonate the database server.
=back
......
......@@ -200,8 +200,8 @@ where I<action> = B<start>|B<stop>|B<restart>|B<reload>|B<autovac-start>|B<autov
=head1 DESCRIPTION
This program controls the B<postmaster> server for a particular cluster. It
essentially wraps the B<pg_ctl> command. It determines the cluster version and
data path and calls the right version of B<pg_ctl> with appropriate
essentially wraps the L<pg_ctl(1)> command. It determines the cluster version
and data path and calls the right version of B<pg_ctl> with appropriate
configuration parameters and paths.
You have to start this program as the user who owns the database cluster. If
......@@ -226,10 +226,10 @@ C<autovacuum.conf> file).
=item B<stop>
Stops the B<postmaster> server (and B<pg_autovacuum>, if running) of the given
cluster with increasing force. Initially, the B<fast> mode is used which rolls
back all active transactions and thus shuts down cleanly. If that does not
work, shutdown is attempted again in B<immediate> mode, which can leave the
Stops the L<postmaster(1)> server (and B<pg_autovacuum>, if running) of the
given cluster with increasing force. Initially, the B<fast> mode is used which
rolls back all active transactions and thus shuts down cleanly. If that does
not work, shutdown is attempted again in B<immediate> mode, which can leave the
cluster in an inconsistent state and thus will lead to a recovery run at the
next start. If this still does not help, the B<postmaster> process is killed.
......
......@@ -57,8 +57,8 @@ B<pg_dropcluster> [B<--stop-server>] I<cluster-version> I<cluster-name>
This program removes all files that belong to a given PostgreSQL cluster; that
includes the data directory, the log file, and all configuration files that
were created by B<pg_createcluster>. If the configuration directory
(B</etc/postgresql/>I<version>B</>I<cluster>) is empty after this, it is
were created by L<pg_createcluster(1)>. If the configuration directory
(C</etc/postgresql/>I<version>C</>I<cluster>) is empty after this, it is
removed as well.
Usually a cluster which still has a running server attached will not be
......
......@@ -74,14 +74,14 @@ B<dropdb> [B<--cluster> I<version>/I<cluster>] [...]
=head1 DESCRIPTION
This program is run only as a link to names which correspond to PostgreSQL
programs in B</usr/lib/postgresql/>I<version>B</bin>. It determines the
programs in C</usr/lib/postgresql/>I<version>C</bin>. It determines the
configured cluster and database for the user and calls the appropriate version
of the desired program to connect to that cluster and database, supplying any
specifed options to that command.
By default, the cluster is determined from the configuration files
L<user_clusters(5)> and L<postgresqlrc(5)>. However, this can be overriden by
specifying the B<$PGCLUSTER> environment variable or the B<--cluster>
specifying the C<$PGCLUSTER> environment variable or the B<--cluster>
I<version>/I<cluster> option.
=head1 ENVIRONMENT
......@@ -90,9 +90,9 @@ I<version>/I<cluster> option.
=item B<PGCLUSTER>
If B<$PGCLUSTER> is set, its value (of the form I<version>/I<cluster>)
If C<$PGCLUSTER> is set, its value (of the form I<version>/I<cluster>)
specifies the desired cluster, similar to the B<--cluster> option. However, if
B<--cluster> is specified, it overrides the value of B<$PGCLUSTER>.
B<--cluster> is specified, it overrides the value of C<$PGCLUSTER>.
=back
......@@ -100,12 +100,12 @@ B<--cluster> is specified, it overrides the value of B<$PGCLUSTER>.
=over
=item B</etc/postgresql-common/user_clusters>
=item C</etc/postgresql-common/user_clusters>
stores the default cluster and database for users and groups as set by
the administrators.
=item B<$HOME/.postgresqlrc>
=item C<$HOME/.postgresqlrc>
stores defaults set by the user himself.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment