.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH REPMGR 1 "May 11, 2012"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
repmgr \- PostgreSQL replication manager
.SH SYNOPSIS
.B repmgr
.RI [ options ] " master " {register}
.br
.B repmgr
.RI [ options ] " standby " {register|clone|promote|follow}
.br
.B repmgr
.RI [ options ] " cluster " show
.SH DESCRIPTION
This manual page documents briefly the
.B repmgr
command.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
.\" respectively.
\fBrepmgr\fP is a command program that allows you to monitor and
manage your replicated PostgreSQL as a single cluster. It performs some
tasks like clone a node, promote it or making follow another node and
then exits.

.SH OPTIONS
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
For a complete description, see README.rst file.

.SS General options
.TP
.B \-\-help
Show summary of options.
.TP
.B \-\-version
Show version information.
.TP
.B \-\-verbose
Output verbose activity information.

.SS Connection options
.TP
.B \-d, \-\-dbname=DBNAME
Database to connect to.
.TP
.B \-h, \-\-host=HOSTNAME
Database server host or socket directory.
.TP
.B \-p, \-\-port=PORT
Database server port.
.TP
.B \-U, \-\-username=USERNAME
Database user name to connect as.

.SS Configuration options
.TP
.B \-D, \-\-data-dir=DIR
Local directory where the files will be copied to.
.TP
.B \-l, \-\-local-port=PORT
Standby or witness server local port.
.TP
.B \-f, \-\-config_file=PATH
Path to the configuration file.
.TP
.B \-R, \-\-remote-user=USERNAME
Database server username for rsync.
.TP
.B \-w, \-\-wal-keep-segments=VALUE
Minimum value for the GUC wal_keep_segments (default: 5000).
.TP
.B \-I, \-\-ignore-rsync-warning
Ignore rsync partial transfer warning.
.TP
.B \-F, \-\-force
Force potentially dangerous operations to happen.

.SH COMMANDS
.TP
.B master register
Registers the master in a cluster.
.TP
.B standby register
Registers a standby in a cluster.
.TP
.B standby clone [node]
Allows creation of a new standby.
.TP
.B standby promote
Allows manual promotion of a specific standby into a new master in the
event of a failover.
.TP
.B standby follow
Allows the standby to re-point itself to a new master.
.TP
.B cluster show
Print node information.

.SH SEE ALSO
.BR rsync (1),
.BR repmgrd (8).

.SH RESOURCES
Homepage: http://www.repmgr.org

.SH AUTHOR
repmgr was written by 2ndQuadrant Limited <info@2ndquadrant.com>.
.PP
This manual page was written by Krzysztof Gajdemski <songo@debian.org.pl>,
for the Debian project (and may be used by others).