socket: New option accept-count.
[fwd] / fw.1.in
diff --git a/fw.1.in b/fw.1.in
index 542e48b..1b7d4d5 100644 (file)
--- a/fw.1.in
+++ b/fw.1.in
@@ -1,26 +1,24 @@
 .\" -*-nroff-*-
 .\"
-.\" $Id$
-.\"
 .\" Manual page for fw
 .\"
 .\" (c) 1999 Straylight/Edgeware
 .\"
 .
 .\"----- Licensing notice ---------------------------------------------------
-.\" 
+.\"
 .\" This file is part of the `fw' port forwarder.
-.\" 
+.\"
 .\" `fw' is free software; you can redistribute it and/or modify
 .\" it under the terms of the GNU General Public License as published by
 .\" the Free Software Foundation; either version 2 of the License, or
 .\" (at your option) any later version.
-.\" 
+.\"
 .\" `fw' is distributed in the hope that it will be useful,
 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 .\" GNU General Public License for more details.
-.\" 
+.\"
 .\" You should have received a copy of the GNU General Public License
 .\" along with `fw'; if not, write to the Free Software Foundation,
 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
@@ -263,7 +261,7 @@ Whitespace characters separate words but are otherwise ignored.  All
 considered to be whitespace for these purposes.
 .TP
 .I "special characters"
-There are three special characters.  The 
+There are three special characters.  The
 .RB ` # '
 character, if it appears at the start of a word, introduces a
 .I comment
@@ -678,7 +676,7 @@ the file is created if it doesn't exist.
 Controls the behaviour if the output file already exists.  If
 .BR no ,
 an error is reported.  If
-.B truncate 
+.B truncate
 (the default), the existing file is replaced by the new data.  If
 .BR append ,
 the new data is appended to the file.
@@ -757,7 +755,7 @@ is used.
 Note that the shell command or program name string must, if present,
 have any delimiter characters (including
 .RB ` / '
-and 
+and
 .RB ` . ')
 quoted; this is not required in the
 .RB ` [ '-enclosed
@@ -954,6 +952,24 @@ is given, is
 Socket sources support options; socket targets do not.  The source
 options provided are:
 .OS "Socket options"
+.BR socket. [ accept | accept-count ]
+.RB [ = ]
+.IR number | \c
+.B unlimited
+.OD
+Controls the number of connections that
+.B fw
+accepts at a time on a particular socket.  This parameter affects how
+.B fw
+prioritizes between keeping up with connection turnover and processing
+existing connections.  The default is 1, which strongly favours existing
+connections.  The special value
+.B unlimited
+(or
+.BR infinite )
+removes any limit, and therefore favours connection turnover.
+.OE
+.OS "Socket options"
 .B socket.conn
 .RB [ = ]
 .IR number | \c
@@ -989,7 +1005,7 @@ system call.  The default is 5.
 .RB [ = ]
 .BR yes | no
 .OD
-Whether to log incoming connections.  If 
+Whether to log incoming connections.  If
 .B yes
 (the default) incoming connections are logged, together with information
 about the client (where available) and whether the connection was
@@ -1108,7 +1124,7 @@ has
 .I dropped
 privileges after initialization (the
 .B \-s
-option).  Before dropping privileges, 
+option).  Before dropping privileges,
 .B fw
 forks off a separate process which continues to run with root
 privileges, and on demand passes sockets bound to privileged ports and