Description: Add manpage for bcrelay Author: Khang Nguyen Trong Forwarded: http://sourceforge.net/mailarchive/forum.php?thread_name=1360193742%40msgid.manchmal.in-ulm.de&forum_name=poptop-server Bug-Debian: http://bugs.debian.org/426553 --- /dev/null +++ b/bcrelay.8 @@ -0,0 +1,59 @@ +.TH BCRELAY "8" "31 Dec 2010" "Version 1.3.4" "BCRELAY MANUAL PAGE" +.SH NAME +\fBbcrelay\fR \- a broadcast relay daemon +.SH SYNOPSIS +.B bcrelay +[\fIOPTION\fR]... +.SH DESCRIPTION +.B bcrelay +simply plays as a broadcast repeater. When \fBbcrelay\fR receives packets +from the incomming interface, it will then relay them to the outgoing +interface. +.LP +.SH OPTIONS +.TP +\fB-d\fR,\fB\-\-daemon\fR +Run \fBbcrelay\fR as a daemon. +.TP +\fB-h\fR,\fB\-\-help\fR +Show help message. +.TP +\fB-i\fR,\fB\-\-incoming\fR \fIinterface-in +Defines from which interface broadcasts will be read. +.TP +\fB-s\fR,\fB\-\-outgoing\fR \fIinterface-out +Defines to which interface broadcasts will be relayed. +.TP +\fB-n\fR,\fB\-\-nolog\fR +Disable any logging and tracing to /var/log/messages except fatal error +messages. +.TP +\fB-s\fR,\fB\-\-ipsec\fR \fIargument\fR +Defines an ipsec tunnel to be relayed to. Since ipsec tunnels terminate on +the same interface, we need to define the broadcast address of the other +end-point of the tunnel. This is done as ipsec0:x.x.x.255. +.TP +\fB-v\fR,\fB\-\-version\fR +Show the version of \fBbcrelay\fR. +.TP +Log messages and debugging information go to syslog as daemon. +.TP +Interfaces can be specified as regexpressions, ie. ppp[0-9]+. +.SH AUTHORS +.sp +Original \fBbcrelay\fR program was written by Luc Richards +. + +.sp +\fBBcrelay\fR was modified for \fBpoptop\fR by Richard de Vroede + and rewritten by Norbert van Bolhuis + for version (v1.0+) of \fBbcrelay\fR. + +.sp +This manual page was written by Nguyen Vinh for Debian GNU/Linux System (but +may be used for others). Permission is granted to copy, distribute and/or +modify this document under the terms of the GNU General Public License +Version 2, and any later versions published by Free Software Foundation. +There is no WARRANTY, to the extent permitted by the law. +.SH SEE ALSO +For more detailed information about \fBbcrelay\fR, please read README. --- a/Makefile.am +++ b/Makefile.am @@ -16,7 +16,7 @@ #CFLAGS = -O2 -fno-builtin -Wall -ansi -pedantic -Wmissing-prototypes -Werror -DSBINDIR='"$(sbindir)"' CPPFLAGS = -DSBINDIR='"$(sbindir)"' -man_MANS = pptpctrl.8 pptpd.8 pptpd.conf.5 +man_MANS = pptpctrl.8 pptpd.8 pptpd.conf.5 bcrelay.8 EXTRA_DIST = \ html README* ChangeLog NEWS TODO $(man_MANS) \