Preliminary bump to 1.2.7.

[fwd] / fw.1

diff --git a/fw.1 b/fw.1
index 878ad3a..4419f14 100644 (file)
--- a/fw.1
+++ b/fw.1
@@ -1,6 +1,6 @@
 .\" -*-nroff-*-
 .\"
 .\" -*-nroff-*-
 .\"

-.\" $Id: fw.1,v 1.10 2001/02/03 20:30:03 mdw Exp $
+.\" $Id: fw.1,v 1.15 2003/01/24 20:13:04 mdw Exp $

 .\"
 .\" Manual page for fw
 .\"
 .\"
 .\" Manual page for fw
 .\"


@@ -28,6 +28,21 @@
 .\" ---- Revision history ---------------------------------------------------
 .\" 
 .\" $Log: fw.1,v $
 .\" ---- Revision history ---------------------------------------------------
 .\" 
 .\" $Log: fw.1,v $

+.\" Revision 1.15  2003/01/24 20:13:04  mdw
+.\" Fix bogus examples.  Explain quoting rules for `exec' endpoints.
+.\"
+.\" Revision 1.14  2002/02/23 00:05:12  mdw
+.\" Fix spacing around full stops (at last!).
+.\"
+.\" Revision 1.13  2002/02/22 23:45:01  mdw
+.\" Add option to change the listen(2) parameter.
+.\"
+.\" Revision 1.12  2001/02/23 09:11:29  mdw
+.\" Update manual style.
+.\"
+.\" Revision 1.11  2001/02/05 19:47:11  mdw
+.\" Minor fixings to wording.
+.\"

 .\" Revision 1.10  2001/02/03 20:30:03  mdw
 .\" Support re-reading config files on SIGHUP.
 .\"
 .\" Revision 1.10  2001/02/03 20:30:03  mdw
 .\" Support re-reading config files on SIGHUP.
 .\"


@@ -122,7 +137,7 @@
 .
 .\"--------------------------------------------------------------------------
 .
 .
 .\"--------------------------------------------------------------------------
 .

-.TH fw 1 "1 July 1999" fw
+.TH fw 1 "1 July 1999" "Straylight/Edgeware" "fw port forwarder"

 .
 .\"--------------------------------------------------------------------------
 .SH NAME
 .
 .\"--------------------------------------------------------------------------
 .SH NAME


@@ -404,8 +419,8 @@ on the
 A global option, outside of a
 .I fw-stmt
 has no context unless it is explicitly qualified, and affects global
 A global option, outside of a
 .I fw-stmt
 has no context unless it is explicitly qualified, and affects global

-behaviour.  Local options, applied to a source or target in a
-.I fw-stmt
+behaviour.  A local option, applied to a source or target in a
+.IR fw-stmt ,

 has the context of the type of source or target to which it is applied,
 and affects only that source or target.
 .PP
 has the context of the type of source or target to which it is applied,
 and affects only that source or target.
 .PP


@@ -427,7 +442,7 @@ The syntax for qualifying options is like this:
 .br
        |
 .I prefix
 .br
        |
 .I prefix

-.B .
+.B .\&

 .I q-option
 .br
        |
 .I q-option
 .br
        |


@@ -448,7 +463,7 @@ exec.rlimit {
   cpu = 60;
 }
 .VE
   cpu = 60;
 }
 .VE

-is equivalent to
+means the same as

 .VS
 exec.rlimit.core = 0;
 exec.rlimit.cpu = 0;
 .VS
 exec.rlimit.core = 0;
 exec.rlimit.cpu = 0;


@@ -577,7 +592,7 @@ sources and targets is like this:
 .I file
 ::=
 .B file
 .I file
 ::=
 .B file

-.RB  [ . ]
+.RB  [ .\& ]

 .I fspec
 .RB [ ,
 .IR fspec ]
 .I fspec
 .RB [ ,
 .IR fspec ]


@@ -734,7 +749,7 @@ exec
 .I exec
 ::=
 .BR exec
 .I exec
 ::=
 .BR exec

-.RB [ . ]
+.RB [ .\& ]

 .I cmd-spec
 .br
 .I cmd-spec
 .I cmd-spec
 .br
 .I cmd-spec


@@ -773,6 +788,15 @@ otherwise the file named by the first argument
 .RI ( argv0 )
 is used.
 .PP
 .RI ( argv0 )
 is used.
 .PP

+Note that the shell command or program name string must, if present,
+have any delimiter characters (including
+.RB ` / '
+and 
+.RB ` . ')
+quoted; this is not required in the
+.RB ` [ '-enclosed
+argument list.
+.PP

 The standard input and output of the program are forwarded to the other
 end of the connection.  The standard error stream is caught by
 .B fw
 The standard input and output of the program are forwarded to the other
 end of the connection.  The standard error stream is caught by
 .B fw


@@ -940,7 +964,7 @@ The syntax for socket sources and targets is:
 .br
 .I socket-source
 ::=
 .br
 .I socket-source
 ::=

-.RB [ socket [ . ]]
+.RB [ socket [ .\& ]]

 .RB [[ : ] \c
 .IR addr-type \c
 .RB [ : ]]
 .RB [[ : ] \c
 .IR addr-type \c
 .RB [ : ]]


@@ -948,7 +972,7 @@ The syntax for socket sources and targets is:
 .br
 .I socket-target
 ::=
 .br
 .I socket-target
 ::=

-.RB [ socket [ . ]]
+.RB [ socket [ .\& ]]

 .RB [[ : ] \c
 .IR addr-type \c
 .RB [ : ]]
 .RB [[ : ] \c
 .IR addr-type \c
 .RB [ : ]]


@@ -985,6 +1009,16 @@ the
 option is not recommended.
 .OE
 .OS "Socket options"
 option is not recommended.
 .OE
 .OS "Socket options"

+.B socket.listen
+.RB [ = ]
+.I number
+.OD
+Sets the maximum of the kernel incoming connection queue for this socket
+source.  This is the number given to the
+.BR listen (2)
+system call.  The default is 5.
+.OE
+.OS "Socket options"

 .B socket.logging
 .RB [ = ]
 .BR yes | no
 .B socket.logging
 .RB [ = ]
 .BR yes | no


@@ -1027,7 +1061,7 @@ source and target addresses have the following syntax:
 .br
 .I addr-elt
 ::=
 .br
 .I addr-elt
 ::=

-.B .
+.B .\&

 |
 .I word
 .GE
 |
 .I word
 .GE


@@ -1120,7 +1154,7 @@ from file stdin, stdout to unix:/tmp/fortunes
 To emulate
 .BR cat (1):
 .VS
 To emulate
 .BR cat (1):
 .VS

-from stdin, null to null, stdout
+from file stdin, null to file null, stdout

 .VE
 .
 .\"--------------------------------------------------------------------------
 .VE
 .
 .\"--------------------------------------------------------------------------


@@ -1218,7 +1252,7 @@ just logs a message about the signal and continues.
 .br
        |
 .I prefix
 .br
        |
 .I prefix

-.B .
+.B .\&

 .I q-option
 .br
        |
 .I q-option
 .br
        |


@@ -1243,7 +1277,7 @@ just logs a message about the signal and continues.
 .I file
 ::=
 .B file
 .I file
 ::=
 .B file

-.RB  [ . ]
+.RB  [ .\& ]

 .I fspec
 .RB [ ,
 .IR fspec ]
 .I fspec
 .RB [ ,
 .IR fspec ]


@@ -1304,7 +1338,7 @@ exec
 .I exec
 ::=
 .BR exec
 .I exec
 ::=
 .BR exec

-.RB [ . ]
+.RB [ .\& ]

 .I cmd-spec
 .br
 .I cmd-spec
 .I cmd-spec
 .br
 .I cmd-spec


@@ -1344,7 +1378,7 @@ exec
 .br
 .I socket-source
 ::=
 .br
 .I socket-source
 ::=

-.RB [ socket [ . ]]
+.RB [ socket [ .\& ]]

 .RB [[ : ] \c
 .IR addr-type \c
 .RB [ : ]]
 .RB [[ : ] \c
 .IR addr-type \c
 .RB [ : ]]


@@ -1352,7 +1386,7 @@ exec
 .br
 .I socket-target
 ::=
 .br
 .I socket-target
 ::=

-.RB [ socket [ . ]]
+.RB [ socket [ .\& ]]

 .RB [[ : ] \c
 .IR addr-type \c
 .RB [ : ]]
 .RB [[ : ] \c
 .IR addr-type \c
 .RB [ : ]]


@@ -1379,7 +1413,7 @@ exec
 .br
 .I addr-elt
 ::=
 .br
 .I addr-elt
 ::=

-.B .
+.B .\&

 |
 .I word
 .PP
 |
 .I word
 .PP


@@ -1460,6 +1494,10 @@ exec
 .IR number | \c
 .BR unlimited | one-shot
 .br
 .IR number | \c
 .BR unlimited | one-shot
 .br

+.B socket.listen
+.RB [ = ]
+.I number
+.br

 .B socket.logging
 .RB [ = ]
 .BR yes | no
 .B socket.logging
 .RB [ = ]
 .BR yes | no


@@ -1487,6 +1525,8 @@ this program.  I take security very seriously, and I will fix security
 holes as a matter of priority when I find out about them.  I will be
 annoyed if I have to read about problems on Bugtraq because they weren't
 mailed to me first.
 holes as a matter of priority when I find out about them.  I will be
 annoyed if I have to read about problems on Bugtraq because they weren't
 mailed to me first.

+.PP
+The program is too complicated, and this manual page is too long.

 .
 .\"--------------------------------------------------------------------------
 .SH "AUTHOR"
 .
 .\"--------------------------------------------------------------------------
 .SH "AUTHOR"