From e8ae0831fe4e6d6fd19309623c57d8f93a62958c Mon Sep 17 00:00:00 2001 From: Ian Barwick Date: Mon, 26 Feb 2018 16:54:27 +0900 Subject: [PATCH] doc: add section for various commands --- doc/repmgr-primary-register.sgml | 31 +++++++++++++++-- doc/repmgr-standby-clone.sgml | 1 + doc/repmgr-standby-register.sgml | 58 ++++++++++++++++++++++++++++++++ 3 files changed, 88 insertions(+), 2 deletions(-) diff --git a/doc/repmgr-primary-register.sgml b/doc/repmgr-primary-register.sgml index f0425fca..a1f625de 100644 --- a/doc/repmgr-primary-register.sgml +++ b/doc/repmgr-primary-register.sgml @@ -26,7 +26,7 @@ Execution - Execute with the --dry-run option to check what would happen without + Execute with the option to check what would happen without actually registering the primary. @@ -36,7 +36,7 @@ - If providing the configuration file location with -f/--config-file, + If providing the configuration file location with , avoid using a relative path, as &repmgr; stores the configuration file location in the repmgr metadata for use when &repmgr; is executed remotely (e.g. during ). &repmgr; will attempt to convert the @@ -48,6 +48,33 @@ + + + Options + + + + + + + Check prerequisites but don't actually register the primary. + + + + + + + + + Overwrite an existing node record + + + + + + + + Event notifications diff --git a/doc/repmgr-standby-clone.sgml b/doc/repmgr-standby-clone.sgml index f309b2fb..4d942a2d 100644 --- a/doc/repmgr-standby-clone.sgml +++ b/doc/repmgr-standby-clone.sgml @@ -126,6 +126,7 @@ and display the contents of the file without actually creating it. + Options diff --git a/doc/repmgr-standby-register.sgml b/doc/repmgr-standby-register.sgml index 61aba28f..9e5f7b76 100644 --- a/doc/repmgr-standby-register.sgml +++ b/doc/repmgr-standby-register.sgml @@ -101,6 +101,64 @@ to add the recovery.conf file, then register the standby as usual. + + + + Options + + + + + + + + Check prerequisites but don't actually register the standby. + + + + + + + + + + Overwrite an existing node record + + + + + + + + + + ID of the upstream node to replicate from (optional) + + + + + + + + + wait for the standby to start (timeout in seconds, default 30 seconds) + + + + + + + + + wait for the node record to synchronise to the standby (optional timeout in seconds) + + + + + + + + Event notifications