|author||Pablo Neira Ayuso <email@example.com>||2008-10-21 20:13:07 +0200|
|committer||Pablo Neira Ayuso <firstname.lastname@example.org>||2008-10-21 20:13:07 +0200|
doc: update conntrackd manpage
This patch updates the conntrackd manpage some re-writes, missing options and new dependencies. Signed-off-by: Pablo Neira Ayuso <email@example.com>
1 files changed, 12 insertions, 5 deletions
diff --git a/conntrackd.8 b/conntrackd.8
index b2aa10e..9fe77cc 100644
@@ -1,16 +1,16 @@
-.TH CONNTRACKD 8 "Jan 5, 2008" "" ""
+.TH CONNTRACKD 8 "Oct 21, 2008" "" ""
.\" Man page written by Pablo Neira Ayuso <firstname.lastname@example.org> (Dec 2007)
-conntrackd \- netfilter connection tracking userspace daemon
+conntrackd \- netfilter connection tracking user-space daemon
.BR "conntrackd [options]"
-provides a userspace daemon for the netfilter connection tracking system. This daemon synchronizes connection tracking states among several replica firewalls. Thus,
+is the user-space daemon for the netfilter connection tracking system. This daemon synchronizes connection tracking states between several replica firewalls. Thus,
-can be used to implement highly available stateful firewalls. The daemon fully supports Primary-Backup and Multiprimary setups for both symmetric and asymmetric paths. It can also be used as statistics collector.
+can be used to deploy highly available stateful firewalls. The daemon supports Primary-Backup and Multiprimary setups. The daemon can also be used as statistics collector.
The options recognized by
@@ -45,9 +45,14 @@ Dump statistics
.BI "-R "
Force a resync against the kernel connection tracking table
+.BI "-t "
+Reset the in-kernel timers (See PurgeTimeout clause)
The exit code is 0 for correct function. Errors cause an exit code of 1.
+The following example are illustrative, for a real use in a firewall fail-over,
+check the primary-backup.sh script that comes with the sources.
.B conntrackd \-d
Runs conntrackd in daemon and synchronization mode
@@ -64,6 +69,8 @@ Commits the external cache into the kernel connection tracking system. This is u
This daemon requires a Linux kernel version >= 2.6.18. TCP window tracking support requires >= 2.6.22, otherwise you have to disable it. Helpers are fully supported since >= 2.6.25, however, if you use any previous version, depending on the protocol helper and your setup (e.g. if you setup performs NAT sequence adjustments or not), your help connection may be successfully recovered.
There are several unsupported stateful iptables matches such as recent, connbytes and the quota matches which gather internal information to operate. Since that information does not belong to the domain of the connection tracking system, connections affected by those matches may not be fully recovered during the takeover.
+The daemon requires a Linux kernel version >= 2.6.26 to support kernel-space event filtering. Otherwise, all the event filtering is done in userspace with the corresponding extra overhead. If you are not using the Filter clause in the configuration file, ignore this notice.
.SH SEE ALSO
.BR conntrack (8), iptables (8)
@@ -75,6 +82,6 @@ Netfilter's bugzilla (https://bugzilla.netfilter.org).
Pablo Neira Ayuso wrote and maintains the conntrackd tool
-Please send bug reports to <email@example.com>. Subscription is required.
+Please send bug reports to <firstname.lastname@example.org>. Subscription is required.
Man page written by Pablo Neira Ayuso <email@example.com>.