blast: Upper-case metasyntactic variables in the usage message.

[fwd] / fw.1

diff --git a/fw.1 b/fw.1
index d90d9d9..e72ed1c 100644 (file)
--- a/fw.1
+++ b/fw.1
@@ -1,6 +1,6 @@
 .\" -*-nroff-*-
 .\"
 .\" -*-nroff-*-
 .\"

-.\" $Id: fw.1,v 1.17 2003/11/29 20:36:07 mdw Exp $
+.\" $Id$

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


@@ -25,61 +25,6 @@
 .\" along with `fw'; if not, write to the Free Software Foundation,
 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 .
 .\" along with `fw'; if not, write to the Free Software Foundation,
 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 .

-.\" ---- Revision history ---------------------------------------------------
-.\" 
-.\" $Log: fw.1,v $
-.\" Revision 1.17  2003/11/29 20:36:07  mdw
-.\" Privileged outgoing connections.
-.\"
-.\" Revision 1.16  2003/11/25 14:46:50  mdw
-.\" Update docco for new options.
-.\"
-.\" 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.9  2000/03/23 00:37:33  mdw
-.\" Add option to change user and group after initialization.  Naughtily
-.\" reassign short equivalents of --grammar and --options.
-.\"
-.\" Revision 1.8  1999/12/22 15:44:43  mdw
-.\" Fix some errors, and document new option.
-.\"
-.\" Revision 1.7  1999/10/22 22:45:15  mdw
-.\" Describe new socket connection options.
-.\"
-.\" Revision 1.6  1999/10/10 16:46:29  mdw
-.\" Include grammar and options references at the end of the manual.
-.\"
-.\" Revision 1.5  1999/09/26 18:18:05  mdw
-.\" Remove a fixed bug from the list.  Fix some nasty formatting
-.\" misfeatures.
-.\"
-.\" Revision 1.4  1999/08/19 18:32:48  mdw
-.\" Improve lexical analysis.  In particular, `chmod' patterns don't have to
-.\" be quoted any more.
-.\"
-.\" Revision 1.3  1999/07/30 06:49:00  mdw
-.\" Minor tidying and typo correction.
-.\"
-.\" Revision 1.2  1999/07/26 23:31:04  mdw
-.\" Document lots of new features and syntax.
-.\"
-.

 .\"----- Various bits of fancy styling --------------------------------------
 .
 .\" --- Indented paragraphs with right-aligned tags ---
 .\"----- Various bits of fancy styling --------------------------------------
 .
 .\" --- Indented paragraphs with right-aligned tags ---


@@ -155,6 +100,8 @@ fw \- port forwarder
 .
 .B fw
 .RB [ \-dlq ]
 .
 .B fw
 .RB [ \-dlq ]

+.RB [ \-p
+.IR file ]

 .RB [ \-f
 .IR file ]
 .RB [ \-s
 .RB [ \-f
 .IR file ]
 .RB [ \-s


@@ -230,6 +177,15 @@ initializing properly.
 .B "\-l, \-\-syslog, \-\-log"
 Emit logging information to the system log, rather than standard error.
 .TP
 .B "\-l, \-\-syslog, \-\-log"
 Emit logging information to the system log, rather than standard error.
 .TP

+.BI "\-p, \-\-pidfile=" file
+Write
+.BR fw 's
+process-id to
+.I file
+during start-up.  If
+.B \-d
+is given too, then the process-id is written after forking (obviously).
+.TP

 .B "\-q, \-\-quiet"
 Don't output any logging information.  This option is not recommended
 for normal use, although it can make system call traces clearer so I use
 .B "\-q, \-\-quiet"
 Don't output any logging information.  This option is not recommended
 for normal use, although it can make system call traces clearer so I use


@@ -619,7 +575,7 @@ sources and targets is like this:
 .br
 .I name-spec
 ::=
 .br
 .I name-spec
 ::=

-.RB [[ : ] file [ : ]]
+.RB [[ : ] name [ : ]]

 .I file-name
 .br
 .I file-name
 .I file-name
 .br
 .I file-name


@@ -1158,7 +1114,7 @@ process is compromised, it can't make privileged connections to other
 addresses.  Note that because of this privilege separation, it's also
 not possible to reconfigure
 .B fw
 addresses.  Note that because of this privilege separation, it's also
 not possible to reconfigure
 .B fw

-to make privileged connections to different peer addresses later. by
+to make privileged connections to different peer addresses later by

 changing configuration files and sending the daemon a
 .BR SIGHUP .
 .OE
 changing configuration files and sending the daemon a
 .BR SIGHUP .
 .OE


@@ -1224,6 +1180,7 @@ To emulate
 .VS
 from file stdin, null to file null, stdout
 .VE
 .VS
 from file stdin, null to file null, stdout
 .VE

+.sp -1 \" undo final space

 .
 .\"--------------------------------------------------------------------------
 .SH "SIGNAL HANDLING"
 .
 .\"--------------------------------------------------------------------------
 .SH "SIGNAL HANDLING"


@@ -1266,7 +1223,6 @@ to reload its configuration.  Any existing connections are allowed to
 run their course.  If no such configuration files are available,
 .B fw
 just logs a message about the signal and continues.
 run their course.  If no such configuration files are available,
 .B fw
 just logs a message about the signal and continues.

-.PP

 .
 .\"--------------------------------------------------------------------------
 .SH "GRAMMAR SUMMARY"
 .
 .\"--------------------------------------------------------------------------
 .SH "GRAMMAR SUMMARY"


@@ -1366,7 +1322,7 @@ just logs a message about the signal and continues.
 .br
 .I name-spec
 ::=
 .br
 .I name-spec
 ::=

-.RB [[ : ] file [ : ]]
+.RB [[ : ] name [ : ]]

 .I file-name
 .br
 .I file-name
 .I file-name
 .br
 .I file-name