summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTheo de Raadt <deraadt@cvs.openbsd.org>2007-12-07 17:19:43 +0000
committerTheo de Raadt <deraadt@cvs.openbsd.org>2007-12-07 17:19:43 +0000
commitb3bd3ba36721a05516071199e16df422dac5dfc9 (patch)
tree52d0a0f5cc3f8af2e35f0dbf256189edbcc942be
parentd75f94d842d2ecbea5f31fb27532593b5021098d (diff)
partial update of the man pages to new relayd name
-rw-r--r--usr.sbin/relayd/relayd.832
-rw-r--r--usr.sbin/relayd/relayd.conf.546
2 files changed, 39 insertions, 39 deletions
diff --git a/usr.sbin/relayd/relayd.8 b/usr.sbin/relayd/relayd.8
index d1c0efa83d3..0c446379a98 100644
--- a/usr.sbin/relayd/relayd.8
+++ b/usr.sbin/relayd/relayd.8
@@ -1,4 +1,4 @@
-.\" $OpenBSD: relayd.8,v 1.10 2007/09/28 18:08:00 pyr Exp $
+.\" $OpenBSD: relayd.8,v 1.11 2007/12/07 17:19:42 deraadt Exp $
.\"
.\" Copyright (c) 2006 Pierre-Yves Ritschard <pyr@openbsd.org>
.\"
@@ -14,12 +14,12 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: September 28 2007 $
-.Dt HOSTSTATED 8
+.Dd $Mdocdate: December 7 2007 $
+.Dt RELAYD 8
.Os
.Sh NAME
-.Nm hoststated
-.Nd Host Status daemon
+.Nm relayd
+.Nd Relay daemon
.Sh SYNOPSIS
.Nm
.Op Fl dnv
@@ -29,7 +29,7 @@
.Op Fl f Ar file
.Sh DESCRIPTION
.Nm
-is a host status daemon for server load-balancing.
+is a relaying daemon for server load-balancing.
It monitors groups of hosts for availability,
which is determined by checking for a specific service
common to a host group.
@@ -49,7 +49,7 @@ to properly set up
rules, the following line is required in the NAT section of
.Xr pf.conf 5 :
.Bd -literal -offset indent
-rdr-anchor "hoststated/*"
+rdr-anchor "relayd/*"
.Ed
.Pp
Layer 7 load-balancing happens at the application level and is
@@ -86,9 +86,9 @@ will be mapped to a
table containing only hosts which are up.
.Pp
All these entities can be configured in
-.Xr hoststated.conf 5
+.Xr relayd.conf 5
and
-.Xr hoststatectl 8
+.Xr relayctl 8
can be used to alter or report the status of each entity.
.Pp
The options are as follows:
@@ -111,7 +111,7 @@ will run in the foreground and log to
.It Fl f Ar file
Specify an alternative configuration file.
The default is
-.Pa /etc/hoststated.conf .
+.Pa /etc/relayd.conf .
.It Fl n
Configtest mode.
Only check the configuration file for validity.
@@ -119,18 +119,18 @@ Only check the configuration file for validity.
Produce more verbose output.
.El
.Sh FILES
-.Bl -tag -width "/var/run/hoststated.sockXX" -compact
-.It /etc/hoststated.conf
+.Bl -tag -width "/var/run/relayd.sockXX" -compact
+.It /etc/relayd.conf
Default
.Nm
configuration file.
-.It /var/run/hoststated.sock
+.It /var/run/relayd.sock
Unix-domain socket used for communication with
-.Xr hoststatectl 8 .
+.Xr relayctl 8 .
.El
.Sh SEE ALSO
-.Xr hoststated.conf 5 ,
-.Xr hoststatectl 8
+.Xr relayd.conf 5 ,
+.Xr relayctl 8
.Sh HISTORY
The
.Nm
diff --git a/usr.sbin/relayd/relayd.conf.5 b/usr.sbin/relayd/relayd.conf.5
index f989b4b4842..4bed67901fb 100644
--- a/usr.sbin/relayd/relayd.conf.5
+++ b/usr.sbin/relayd/relayd.conf.5
@@ -1,4 +1,4 @@
-.\" $OpenBSD: relayd.conf.5,v 1.69 2007/11/26 09:38:25 reyk Exp $
+.\" $OpenBSD: relayd.conf.5,v 1.70 2007/12/07 17:19:42 deraadt Exp $
.\"
.\" Copyright (c) 2006, 2007 Reyk Floeter <reyk@openbsd.org>
.\" Copyright (c) 2006, 2007 Pierre-Yves Ritschard <pyr@openbsd.org>
@@ -15,16 +15,16 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: November 26 2007 $
-.Dt HOSTSTATED.CONF 5
+.Dd $Mdocdate: December 7 2007 $
+.Dt RELAYD.CONF 5
.Os
.Sh NAME
-.Nm hoststated.conf
-.Nd Host Status daemon configuration file
+.Nm relayd.conf
+.Nd Relay daemon configuration file
.Sh DESCRIPTION
.Nm
is the configuration file for the Host Status Daemon,
-.Xr hoststated 8 .
+.Xr relayd 8 .
.Sh SECTIONS
.Nm
is divided into six main sections:
@@ -34,7 +34,7 @@ User-defined variables may be defined and used later, simplifying the
configuration file.
.It Sy Global Configuration
Global settings for
-.Xr hoststated 8 .
+.Xr relayd 8 .
.It Sy Tables
Table definitions describe the content of a
.Xr pf 4
@@ -72,7 +72,7 @@ Additional configuration files can be included with the
.Ic include
keyword, for example:
.Bd -literal -offset indent
-include "/etc/hoststated.conf.local"
+include "/etc/relayd.conf.local"
.Ed
.Sh MACROS
Macros can be defined that will later be expanded in context.
@@ -143,7 +143,7 @@ When using relays, run the specified number of processes to handle
relayed connections.
This will increase the performance and prevents delays when connecting
to a relay.
-.Xr hoststated 8
+.Xr relayd 8
will run 5 relay processes by default and every process will handle
all configured relays.
.Pp
@@ -252,10 +252,10 @@ on the command line:
/usr/local/bin/checkload.pl front-www1.private.example.com
.Ed
.Pp
-.Xr hoststated 8
+.Xr relayd 8
expects a positive return value on success and zero on failure.
Note that the script will be executed with the privileges of the
-.Qq _hoststated
+.Qq _relayd
user and terminated after
.Ar timeout
milliseconds.
@@ -277,7 +277,7 @@ keyword in
.It Ic disable
Start the table disabled \(en no hosts will be checked in this table.
The table can be later enabled through
-.Xr hoststatectl 8 .
+.Xr relayctl 8 .
.It Xo
.Ic host Ar address
.Op Ic retry Ar number
@@ -298,7 +298,7 @@ When using the TCP or HTTP checking methods, use this
.Ar port
to connect to hosts.
If this parameter is not specified,
-.Xr hoststated 8
+.Xr relayd 8
will create a template table which inherits the port from the
referencing service or relay.
Main and backup tables need to have the same real port.
@@ -322,7 +322,7 @@ are seen as down or disabled.
.It Ic disable
Set the service initially disabled.
It can be later enabled through
-.Xr hoststatectl 8 .
+.Xr relayctl 8 .
.It Ic sticky-address
This has the same effect than specifying sticky-address
for a rdr rule in
@@ -489,7 +489,7 @@ Handle the Hypertext Transfer Protocol
Generic handler for TCP-based protocols.
.El
.Pp
-.Xr hoststated 8
+.Xr relayd 8
also supports relaying of UDP protocols.
There is no generic handler for UDP-based protocols because it is a
stateless datagram-based protocol which has to look into the
@@ -500,7 +500,7 @@ The supported UDP protocols are:
.It Ic dns
Domain Name System (DNS) protocol.
The request IDs in the DNS header will be used to match the state.
-.Xr hoststated 8
+.Xr relayd 8
will replace these IDs with random values to compensate for
predictable values generated by some hosts.
.El
@@ -586,7 +586,7 @@ request url filter "example.com/index.html"
request url filter "example.com/test.cgi?val=1"
.Ed
.Pp
-.Xr hoststated 8
+.Xr relayd 8
will match the full URL and different possible suffix/prefix
combinations by stripping subdomains and path components (up to 5
levels), and the query string.
@@ -840,8 +840,8 @@ The configured session timeout of the relay.
.El
.Sh FILES
.Bl -tag -width "/etc/ssl/private/address.keyXX" -compact
-.It Pa /etc/hoststated.conf
-.Xr hoststated 8
+.It Pa /etc/relayd.conf
+.Xr relayd 8
configuration file.
.Pp
.It Pa /etc/services
@@ -889,7 +889,7 @@ service www {
virtual host www.example.com port 8080 interface trunk0
virtual host www6.example.com port 80 interface trunk0
- tag HOSTSTATED
+ tag RELAYD
table phphosts
backup table sorryhost
}
@@ -947,8 +947,8 @@ relay sshforward {
}
.Ed
.Sh SEE ALSO
-.Xr hoststatectl 8 ,
-.Xr hoststated 8 ,
+.Xr relayctl 8 ,
+.Xr relayd 8 ,
.Xr ssl 8
.Sh HISTORY
The
@@ -958,7 +958,7 @@ file format first appeared in
.Sh AUTHORS
.An -nosplit
The
-.Xr hoststated 8
+.Xr relayd 8
program was written by
.An Pierre-Yves Ritschard Aq pyr@openbsd.org
and