keepalived/patches/keepalived-1.2.7-update-keepalived-man-page.patch

   1 From 3a0a8643450bf9be6920ae857c03377102fdfd40 Mon Sep 17 00:00:00 2001
   2 From: Ryan O'Hara <rohara@redhat.com>
   3 Date: Mon, 5 Nov 2012 11:28:21 -0600
   4 Subject: [PATCH 04/10] Update keepalived man page
   5
   6 The keepalived(8) was out-of-date and, in some cases, inaccurate. This
   7 patch provides a complete rewrite of the keepalived(8) man page. This
   8 includes updated synopsis, description, and options.
   9
  10 Signed-off-by: Ryan O'Hara <rohara@redhat.com>
  11 ---
  12  doc/man/man8/keepalived.8 |  179 ++++++++++++++++++++++++++-------------------
  13  1 files changed, 104 insertions(+), 75 deletions(-)
  14
  15 diff --git a/doc/man/man8/keepalived.8 b/doc/man/man8/keepalived.8
  16 index 861045a..94c366a 100644
  17 --- a/doc/man/man8/keepalived.8
  18 +++ b/doc/man/man8/keepalived.8
  19 @@ -1,75 +1,104 @@
  20 -.\"
  21 -.\" keepalived(8)
  22 -.\"
  23 -.\" Copyright (C) 2004 Joseph Mack
  24 -.TH keepalived 8 "Jan 2004"
  25 -.SH NAME
  26 -keepalived. \- keepalive demon
  27 -.SH SYNOPSIS
  28 -.B "/usr/sbin/keepalived [-n] [-f keepalived.conf] [-d] [-h] [-v]"
  29 -.SH DESCRIPTION
  30 -The
  31 -.B keepalived
  32 -The keepalived server implements the vrrpd routing demon
  33 -which enables routing failover for a pair (or set) of routers
  34 -(or LVS directors)
  35 -and the keepalived demon which sets up and does the health checking
  36 -of virtual services in a Linux Virtual Servier.
  37 -.SH OPTIONS
  38 -.TP
  39 -.B --vrrp, -P
  40 -Only run the VRRP subsystem.
  41 -.TP
  42 -.B --check, -C
  43 -Only run the healthchecker subsystem.
  44 -.TP
  45 -.B --dont-release-vrrp, -V
  46 -leave (don't remove) VRRP VIPs & VROUTEs on daemon stop.
  47 -.TP
  48 ---dont-release-ipvs, -I
  49 -Dont remove IPVS topology on daemon stop.
  50 -.TP
  51 ---dont-fork, -n
  52 -Dont fork the daemon process.
  53 -.TP
  54 ---use-file, -f keepalived.conf_file
  55 -Use the specified configuration file.
  56 -.TP
  57 ---wdog-vrrp, -R
  58 -Define VRRP watchdog polling delay (default=5s)
  59 -.TP
  60 ---wdog-check, -H
  61 -Define healthchecker's watchdog polling delay (default=5s)
  62 -.TP
  63 ---dump-conf, -d
  64 -Dump the configuration data.
  65 -.TP
  66 ---log-console, -l
  67 -Log messages to local console.
  68 -.TP
  69 ---log-detail, -D
  70 -Detailed log messages (the default with the rc script provided).
  71 -.TP
  72 ---log-facility, -S
  73 -0-7 Set syslog facility to LOG_LOCAL[0-7] (default=LOG_DAEMON)
  74 -.TP
  75 ---snmp, -x
  76 -Enable SNMP support
  77 -.TP
  78 ---help, -h
  79 -Display a short inlined help screen.
  80 -.TP
  81 ---version, -v
  82 -Display the version number.
  83 -
  84 -.SH FILES
  85 -.BR /etc/keepalived/keepalived.conf
  86 -.SH SEE ALSO
  87 -.BR keepalived.conf(5)
  88 -.SH AUTHORS
  89 -.br
  90 -Joseph Mack
  91 -.br
  92 -from inspection of the output of
  93 -.I keepalived --help
  94 -from keepalived-1.1.4
  95 +.TH KEEPALIVED "8" "November 2012"
  96 +
  97 +.na
  98 +.nh
  99 +
 100 +.SH "NAME"
 101 +keepalived \- load\-balancing and high\-availability service
 102 +
 103 +.SH "SYNOPSIS"
 104 +\fBkeepalived\fP
 105 +[\fB\-f\fP|\fB\-\-use\-file\fP=FILE]
 106 +[\fB\-P\fP|\fB\-\-vrrp\fP]
 107 +[\fB\-C\fP|\fB\-\-check\fP]
 108 +[\fB\-l\fP|\fB\-\-log\-console\fP]
 109 +[\fB\-D\fP|\fB\-\-log\-detail\fP]
 110 +[\fB\-S\fP|\fB\-\-log\-facility\fP={0-7}]
 111 +[\fB\-V\fP|\fB\-\-dont\-release\-vrrp\fP]
 112 +[\fB\-I\fP|\fB\-\-dont\-release\-ipvs\fP]
 113 +[\fB\-R\fP|\fB\-\-dont\-respawn\fP]
 114 +[\fB\-n\fP|\fB\-\-dont\-fork\fP]
 115 +[\fB\-d\fP|\fB\-\-dump\-conf\fP]
 116 +[\fB\-p\fP|\fB\-\-pid\fP=FILE]
 117 +[\fB\-r\fP|\fB\-\-vrrp_pid\fP=FILE]
 118 +[\fB\-c\fP|\fB\-\-checkers_pid\fP=FILE]
 119 +[\fB\-v\fP|\fB\-\-version\fP]
 120 +[\fB\-h\fP|\fB\-\-help\fP]
 121 +
 122 +.SH "DESCRIPTION"
 123 +Keepalived provides simple and robust facilities for load\-balancing
 124 +and high\-availability. The load\-balancing framework relies on
 125 +well\-known and widely used Linux Virtual Server (IPVS) kernel module
 126 +providing Layer4 load\-balancing. Keepalived implements a set of
 127 +checkers to dynamically and adaptively maintain and manage
 128 +load\-balanced server pool according their health. Keepalived also
 129 +implements the VRRPv2 protocol to achieve high\-availability with
 130 +director failover.
 131 +
 132 +.SH "OPTIONS"
 133 +.TP
 134 +\fB -f, --use-file\fP=FILE
 135 +Use the specified configuration file. The default configuration file
 136 +is "/etc/keepalived/keepalived.conf".
 137 +.TP
 138 +\fB -P, --vrrp\fP
 139 +Only run the VRRP subsystem. This is useful for configurations that do
 140 +not use IPVS load balancer.
 141 +.TP
 142 +\fB -C, --check\fP
 143 +Only run the healthcheck subsystem. This is useful for configurations
 144 +that use the IPVS load balancer with a single director with no failover.
 145 +.TP
 146 +\fB -l, --log-console\fP
 147 +Log messages to the local console. The default behavior is to log
 148 +messages to syslog.
 149 +.TP
 150 +\fB -D, --log-detail\fP
 151 +Detailed log messages.
 152 +.TP
 153 +\fB -S, --log-facility\fP=[0-7]
 154 +Set syslog facility to LOG_LOCAL[0-7]. The default syslog facility is LOG_DAEMON.
 155 +.TP
 156 +\fB -V, --dont-release-vrrp\fP
 157 +Don't remove VRRP VIPs and VROUTEs on daemon stop. The default
 158 +behavior is to remove all VIPs and VROUTEs when keepalived exits
 159 +.TP
 160 +\fB -I, --dont-release-ipvs\fP
 161 +Don't remove IPVS topology on daemon stop. The default behavior it to
 162 +remove all entries from the IPVS virtual server table on when
 163 +keepalived exits.
 164 +.TP
 165 +\fB -R, --dont-respawn\fP
 166 +Don't respawn child processes. The default behavior is to restart the
 167 +VRRP and checker processes if either process exits.
 168 +.TP
 169 +\fB -n, --dont-fork\fP
 170 +Don't fork the daemon process. This option will cause keepalived to
 171 +run in the foreground.
 172 +.TP
 173 +\fB -d, --dump-conf\fP
 174 +Dump the configuration data.
 175 +.TP
 176 +\fB -p, --pid\fP=FILE
 177 +Use specified pidfile for parent keepalived process. The default
 178 +pidfile for keepalived is "/var/run/keepalived.pid".
 179 +.TP
 180 +\fB -r, --vrrp_pid\fP=FILE
 181 +Use specified pidfile for VRRP child process. The default pidfile for
 182 +the VRRP child process is "/var/run/keepalived_vrrp.pid".
 183 +.TP
 184 +\fB -c, --checkers_pid\fP=FILE
 185 +Use specified pidfile for checkers child process. The default pidfile
 186 +for the checker child process is "/var/run/keepalived_checkers.pid".
 187 +.TP
 188 +\fB -v, --version\fP
 189 +Display the version and exit.
 190 +.TP
 191 +\fB -h, --help\fP
 192 +Display this help message and exit.
 193 +
 194 +.SH "SEE ALSO"
 195 +\fBkeepalived.conf\fP(5), \fBipvsadm\fP(8)
 196 +
 197 +.SH "AUTHOR"
 198 +This man page was written by Ryan O'Hara <rohara@redhat.com>
 199 --
 200 1.7.1
 201