diff options
| -rw-r--r-- | usr.sbin/hostated/hostated.8 | 17 | ||||
| -rw-r--r-- | usr.sbin/hostated/hostated.conf.5 | 36 | ||||
| -rw-r--r-- | usr.sbin/hoststated/hoststated.8 | 17 | ||||
| -rw-r--r-- | usr.sbin/hoststated/hoststated.conf.5 | 36 | ||||
| -rw-r--r-- | usr.sbin/relayd/relayd.8 | 17 | ||||
| -rw-r--r-- | usr.sbin/relayd/relayd.conf.5 | 36 |
6 files changed, 90 insertions, 69 deletions
diff --git a/usr.sbin/hostated/hostated.8 b/usr.sbin/hostated/hostated.8 index 1a74ea55a63..8696bf6e2d5 100644 --- a/usr.sbin/hostated/hostated.8 +++ b/usr.sbin/hostated/hostated.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hostated.8,v 1.1 2006/12/16 11:45:07 reyk Exp $ +.\" $OpenBSD: hostated.8,v 1.2 2006/12/16 11:52:51 reyk Exp $ .\" .\" Copyright (c) 2006 Pierre-Yves Ritschard <pyr@openbsd.org> .\" @@ -32,7 +32,8 @@ as well as related pf rdr rules. To communicate with .Xr pf 4 .Nm -uses the anchor facility. To enable +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 @@ -46,13 +47,15 @@ rdr-anchor "hostated/*" 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 used to create the proper rule. +rdr rule. +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 -by the content of another table when it is empty. This can be used to serve -static content when a dynamic service goes down. +table. +Additionnaly, 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 diff --git a/usr.sbin/hostated/hostated.conf.5 b/usr.sbin/hostated/hostated.conf.5 index c4f7b76ba0f..93addf71f15 100644 --- a/usr.sbin/hostated/hostated.conf.5 +++ b/usr.sbin/hostated/hostated.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hostated.conf.5,v 1.1 2006/12/16 11:45:07 reyk Exp $ +.\" $OpenBSD: hostated.conf.5,v 1.2 2006/12/16 11:52:51 reyk Exp $ .\" .\" Copyright (c) 2006 Pierre-Yves Ritschard <pyr@spootnik.org> .\" @@ -82,7 +82,8 @@ The default interval is 10 seconds. .El .Sh TABLES Tables are used to group a set of hosts that can be checked using the same -method. Only one health-checking method can be used per table. +method. +Only one health-checking method can be used per table. Table specific configuration directives are described below. .Bl -tag -width Ds .It Ic check tcp @@ -100,26 +101,27 @@ gives the HTTP return code For each host in the table, verify that retrieving the URL .Ar path produces a content whose SHA1 digest is -.Ar digest -. The digest does not take the HTTP headers into account. To compute the -digest you can use this simple command: +.Ar digest . +The digest does not take the HTTP headers into account. +To compute the digest you can use this simple command: .Bd -literal -offset 2n ftp -o - http://host[:port]/path | sha1 - .Ed +.Pp This will give you a digest of the form .Bd -literal -offset 2n a9993e36476816aba3e25717850c26c9cd0d89d - .Ed +.Pp that you can use as-is in your digest statement. .It Ic timeout Ar number Set the timeout in milliseconds for each host that is checked. The default timeout is 200 milliseconds. .It Ic real port Ar number When using the tcp or http checking methods, use this port to connect -to hosts. This parameter is mandatory. Main and backup tables need -to have the same real port. +to hosts. +This parameter is mandatory. +Main and backup tables need to have the same real port. .It Ic host Ar address Add the host whose address is .Ar address @@ -140,25 +142,27 @@ below. .Bl -tag -width Ds .It Ic virtual ip Ar address Ic port Ar number Specify an address and a port that will be used to redirect requests -to the hosts in the main or backup table. -Optionally an interface name can be specified like this +to the hosts in the main or backup table. +Optionally an interface name can be specified like this. .Bd -literal -offset indent interface ``ifname'' - .Ed +.Pp to specify which interface the rdr rule will be enabled on. .It Ic table Ar name -Specify the main table to be used. This is mandatory. +Specify the main table to be used. +This is mandatory. .It Ic backup table Ar name Specify the table to switch to when all hosts in the main table are seen as down or disabled. .It Ic disable -Set the service initially disabled. It can be later enabled through +Set the service initially disabled. +It can be later enabled through .It Ic tag Ar name Automatically tag packets passing through the .Xr pf 4 -rdr rule with the name supplied. This allows for easier filter rules -in your main +rdr rule with the name supplied. +This allows for easier filter rules in your main .Xr pf 4 configuration. .Xr hostatectl 5 . diff --git a/usr.sbin/hoststated/hoststated.8 b/usr.sbin/hoststated/hoststated.8 index 6c2ae336645..18715f082f9 100644 --- a/usr.sbin/hoststated/hoststated.8 +++ b/usr.sbin/hoststated/hoststated.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hoststated.8,v 1.1 2006/12/16 11:45:07 reyk Exp $ +.\" $OpenBSD: hoststated.8,v 1.2 2006/12/16 11:52:51 reyk Exp $ .\" .\" Copyright (c) 2006 Pierre-Yves Ritschard <pyr@openbsd.org> .\" @@ -32,7 +32,8 @@ as well as related pf rdr rules. To communicate with .Xr pf 4 .Nm -uses the anchor facility. To enable +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 @@ -46,13 +47,15 @@ rdr-anchor "hostated/*" 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 used to create the proper rule. +rdr rule. +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 -by the content of another table when it is empty. This can be used to serve -static content when a dynamic service goes down. +table. +Additionnaly, 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 diff --git a/usr.sbin/hoststated/hoststated.conf.5 b/usr.sbin/hoststated/hoststated.conf.5 index 1c87944228d..d0eb3484e72 100644 --- a/usr.sbin/hoststated/hoststated.conf.5 +++ b/usr.sbin/hoststated/hoststated.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hoststated.conf.5,v 1.1 2006/12/16 11:45:07 reyk Exp $ +.\" $OpenBSD: hoststated.conf.5,v 1.2 2006/12/16 11:52:51 reyk Exp $ .\" .\" Copyright (c) 2006 Pierre-Yves Ritschard <pyr@spootnik.org> .\" @@ -82,7 +82,8 @@ The default interval is 10 seconds. .El .Sh TABLES Tables are used to group a set of hosts that can be checked using the same -method. Only one health-checking method can be used per table. +method. +Only one health-checking method can be used per table. Table specific configuration directives are described below. .Bl -tag -width Ds .It Ic check tcp @@ -100,26 +101,27 @@ gives the HTTP return code For each host in the table, verify that retrieving the URL .Ar path produces a content whose SHA1 digest is -.Ar digest -. The digest does not take the HTTP headers into account. To compute the -digest you can use this simple command: +.Ar digest . +The digest does not take the HTTP headers into account. +To compute the digest you can use this simple command: .Bd -literal -offset 2n ftp -o - http://host[:port]/path | sha1 - .Ed +.Pp This will give you a digest of the form .Bd -literal -offset 2n a9993e36476816aba3e25717850c26c9cd0d89d - .Ed +.Pp that you can use as-is in your digest statement. .It Ic timeout Ar number Set the timeout in milliseconds for each host that is checked. The default timeout is 200 milliseconds. .It Ic real port Ar number When using the tcp or http checking methods, use this port to connect -to hosts. This parameter is mandatory. Main and backup tables need -to have the same real port. +to hosts. +This parameter is mandatory. +Main and backup tables need to have the same real port. .It Ic host Ar address Add the host whose address is .Ar address @@ -140,25 +142,27 @@ below. .Bl -tag -width Ds .It Ic virtual ip Ar address Ic port Ar number Specify an address and a port that will be used to redirect requests -to the hosts in the main or backup table. -Optionally an interface name can be specified like this +to the hosts in the main or backup table. +Optionally an interface name can be specified like this. .Bd -literal -offset indent interface ``ifname'' - .Ed +.Pp to specify which interface the rdr rule will be enabled on. .It Ic table Ar name -Specify the main table to be used. This is mandatory. +Specify the main table to be used. +This is mandatory. .It Ic backup table Ar name Specify the table to switch to when all hosts in the main table are seen as down or disabled. .It Ic disable -Set the service initially disabled. It can be later enabled through +Set the service initially disabled. +It can be later enabled through .It Ic tag Ar name Automatically tag packets passing through the .Xr pf 4 -rdr rule with the name supplied. This allows for easier filter rules -in your main +rdr rule with the name supplied. +This allows for easier filter rules in your main .Xr pf 4 configuration. .Xr hostatectl 5 . diff --git a/usr.sbin/relayd/relayd.8 b/usr.sbin/relayd/relayd.8 index ea9f7db07be..7e02600665a 100644 --- a/usr.sbin/relayd/relayd.8 +++ b/usr.sbin/relayd/relayd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: relayd.8,v 1.1 2006/12/16 11:45:07 reyk Exp $ +.\" $OpenBSD: relayd.8,v 1.2 2006/12/16 11:52:51 reyk Exp $ .\" .\" Copyright (c) 2006 Pierre-Yves Ritschard <pyr@openbsd.org> .\" @@ -32,7 +32,8 @@ as well as related pf rdr rules. To communicate with .Xr pf 4 .Nm -uses the anchor facility. To enable +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 @@ -46,13 +47,15 @@ rdr-anchor "hostated/*" 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 used to create the proper rule. +rdr rule. +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 -by the content of another table when it is empty. This can be used to serve -static content when a dynamic service goes down. +table. +Additionnaly, 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 diff --git a/usr.sbin/relayd/relayd.conf.5 b/usr.sbin/relayd/relayd.conf.5 index 349dce672b4..8e243e50a40 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.1 2006/12/16 11:45:07 reyk Exp $ +.\" $OpenBSD: relayd.conf.5,v 1.2 2006/12/16 11:52:51 reyk Exp $ .\" .\" Copyright (c) 2006 Pierre-Yves Ritschard <pyr@spootnik.org> .\" @@ -82,7 +82,8 @@ The default interval is 10 seconds. .El .Sh TABLES Tables are used to group a set of hosts that can be checked using the same -method. Only one health-checking method can be used per table. +method. +Only one health-checking method can be used per table. Table specific configuration directives are described below. .Bl -tag -width Ds .It Ic check tcp @@ -100,26 +101,27 @@ gives the HTTP return code For each host in the table, verify that retrieving the URL .Ar path produces a content whose SHA1 digest is -.Ar digest -. The digest does not take the HTTP headers into account. To compute the -digest you can use this simple command: +.Ar digest . +The digest does not take the HTTP headers into account. +To compute the digest you can use this simple command: .Bd -literal -offset 2n ftp -o - http://host[:port]/path | sha1 - .Ed +.Pp This will give you a digest of the form .Bd -literal -offset 2n a9993e36476816aba3e25717850c26c9cd0d89d - .Ed +.Pp that you can use as-is in your digest statement. .It Ic timeout Ar number Set the timeout in milliseconds for each host that is checked. The default timeout is 200 milliseconds. .It Ic real port Ar number When using the tcp or http checking methods, use this port to connect -to hosts. This parameter is mandatory. Main and backup tables need -to have the same real port. +to hosts. +This parameter is mandatory. +Main and backup tables need to have the same real port. .It Ic host Ar address Add the host whose address is .Ar address @@ -140,25 +142,27 @@ below. .Bl -tag -width Ds .It Ic virtual ip Ar address Ic port Ar number Specify an address and a port that will be used to redirect requests -to the hosts in the main or backup table. -Optionally an interface name can be specified like this +to the hosts in the main or backup table. +Optionally an interface name can be specified like this. .Bd -literal -offset indent interface ``ifname'' - .Ed +.Pp to specify which interface the rdr rule will be enabled on. .It Ic table Ar name -Specify the main table to be used. This is mandatory. +Specify the main table to be used. +This is mandatory. .It Ic backup table Ar name Specify the table to switch to when all hosts in the main table are seen as down or disabled. .It Ic disable -Set the service initially disabled. It can be later enabled through +Set the service initially disabled. +It can be later enabled through .It Ic tag Ar name Automatically tag packets passing through the .Xr pf 4 -rdr rule with the name supplied. This allows for easier filter rules -in your main +rdr rule with the name supplied. +This allows for easier filter rules in your main .Xr pf 4 configuration. .Xr hostatectl 5 . |