summaryrefslogtreecommitdiff
path: root/usr.sbin/hoststated/hoststated.8
diff options
context:
space:
mode:
Diffstat (limited to 'usr.sbin/hoststated/hoststated.8')
-rw-r--r--usr.sbin/hoststated/hoststated.839
1 files changed, 19 insertions, 20 deletions
diff --git a/usr.sbin/hoststated/hoststated.8 b/usr.sbin/hoststated/hoststated.8
index d7f7806b161..3bea663ae17 100644
--- a/usr.sbin/hoststated/hoststated.8
+++ b/usr.sbin/hoststated/hoststated.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: hoststated.8,v 1.3 2006/12/16 12:42:14 reyk Exp $
+.\" $OpenBSD: hoststated.8,v 1.4 2006/12/18 19:48:04 jmc Exp $
.\"
.\" Copyright (c) 2006 Pierre-Yves Ritschard <pyr@openbsd.org>
.\"
@@ -27,55 +27,54 @@
.Sh DESCRIPTION
.Nm
is the host status daemon for server load balancing.
-Its main purpose is to maintain pf tables up to date
-as well as related pf rdr rules.
-To communicate with
+Its main purpose is to keep
.Xr pf 4
+tables up to date
+as well as any related pf rdr rules.
+To communicate with pf,
.Nm
uses the anchor facility.
To enable
.Nm
-to install rulesets through the anchor you will
-need the following line in the NAT section of your
-.Xr pf.conf 5
-configuration file:
-.Bd -literal -offset 2n
+to install rulesets through the anchor,
+the following line is required in the NAT section of
+.Xr pf.conf 5 :
+.Bd -literal -offset indent
rdr-anchor "hostated/*"
.Ed
.Pp
.Nm
-manipulates three data types: services, tables and hosts.
+manipulates three data types: services, tables, and hosts.
Each service represents a
.Xr pf 4
rdr rule.
-A service contains at least one table and one virtual ip which are
+A service contains at least one table and one virtual IP which are
used to create the proper rule.
-Each table contains at least one host, and is mapped to a
-.Xr pf 4
-table.
-Additionnaly, a table can be backed up i.e its content will be swapped
+Each table contains at least one host, and is mapped to a pf table.
+Additionally a table can be backed up i.e. its content will be swapped
by the content of another table when it is empty.
This can be used to serve static content when a dynamic service goes down.
See
.Xr hostated.conf 5
for a more detailed explanation of how to configure
-.Nm
-.
+.Nm .
.Pp
.Xr hostatectl 8
-can be used to enable or disable hosts, tables and services as well
+can be used to enable or disable hosts, tables, and services as well
as showing the current status of each object.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl d
Do not daemonize.
-If this options is specified,
+If this option is specified,
.Nm
will run in the foreground and log to
.Em stderr .
.It Fl f Ar file
-Specify an alternative configurate file.
+Specify an alternative configuration file.
+The default is
+.Pa /etc/hostated.conf .
.It Fl n
Configtest mode.
Only check the configuration file for validity.