Add manpages from Jonathan McDowell

Remove reference to old -a command line argument

diff --git a/Changes b/Changes
index ae77ea2..e64d7af 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,3 +1,7 @@
+* ?
+- Add manpages from Jonathan McDowell
+- Remove reference to old -a command line argument
+
 * Tue Nov 16 2004 Brendan O'Dea <bod@optusnet.com.au> 2.0.8
 - Ignore gateway address in Framed-Route (from Jonathan McDowell).
 - Call sessionshutdown() when a tunnel is dropped rather than

diff --git a/Makefile b/Makefile
index 722e9d2..cc3429c 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -2,6 +2,7 @@ DESTDIR =
 bindir = /usr/sbin
 etcdir = /etc/l2tpns
 libdir = /usr/lib/l2tpns
+mandir = /usr/share/man/man8
 statedir = /var/lib/l2tpns
 
 DEFINES =
@@ -83,7 +84,9 @@ bounce:       test/bounce.o
 
 install: all
        $(INSTALL) -m 0755 l2tpns $(DESTDIR)$(bindir)/l2tpns
+       $(INSTALL) -m 0644 l2tpns.8 $(DESTDIR)$(mandir)/l2tpns.8
        $(INSTALL) -m 0755 nsctl $(DESTDIR)$(bindir)/nsctl
+       $(INSTALL) -m 0644 nsctl.8 $(DESTDIR)$(mandir)/nsctl.8
        @if [ -f $(DESTDIR)$(etcdir)/startup-config ]; then \
                echo '***' Installing default config files in $(DESTDIR)$(etcdir) as .defaults; \
                suffix=.default; \

diff --git a/l2tpns.8 b/l2tpns.8
new file mode 100644 (file)
index 0000000..1f6c687
--- /dev/null
+++ b/l2tpns.8
@@ -0,0 +1,68 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH L2TPNS 8 "November 16, 2004"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+l2tpns \- L2TP LNS daemon
+.SH SYNOPSIS
+.B l2tpns
+[ \fB-d\fR ] [ \fB-c\fR \fI<file>\fR ] [ \fB-h\fR \fI<hostname>\fR ] [ \fB-a\fR \fI<address>\fR ] [ \fB-v\fR ]
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B l2tpns
+command.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
+.\" respectively.
+\fBl2tpns\fP is an L2TP LNS daemon that doesn't require kernel support
+for PPP or L2TP, nor any kernel patches. For more information on L2TP see
+RFC 2661.
+.PP
+Once running l2tpns can be controlled by telnetting to port 23 on the
+machine running the daemon.
+.SH OPTIONS
+.TP
+.B \-d
+Detach from terminal and fork into the background. By default l2tpns
+will stay in the foreground.
+.TP
+.B \-c <file>
+Specify config file.
+.TP
+.B \-h <hostname>
+Force hostname to <hostname>.
+.TP
+.B \-v
+Increase verbosity for debugging. Can be used multiple times.
+.br
+.SH FILES
+.TP
+\fB\fI/etc/l2tpns/startup-config\fR
+The default configuration file.
+.TP
+\fB\fI/etc/l2tpns/ip_pool\fR
+IP address pool configuration.
+.TP
+\fB\fI/etc/l2tpns/users\fR
+Username/password configuration for access to admin interface.
+.SH SEE ALSO
+\fInsctl\fR(8)
+.SH AUTHOR
+This manual page was written by Jonathan McDowell <noodles@earth.li>,
+for the Debian GNU/Linux system (but may be used by others).
+

diff --git a/l2tpns.c b/l2tpns.c
index 5307009..a6bff01 100644 (file)
--- a/l2tpns.c
+++ b/l2tpns.c
@@ -4,7 +4,7 @@
 // Copyright (c) 2002 FireBrick (Andrews & Arnold Ltd / Watchfront Ltd) - GPL licenced
 // vim: sw=8 ts=8
 
-char const *cvs_id_l2tpns = "$Id: l2tpns.c,v 1.49 2004-11-16 07:54:32 bodea Exp $";
+char const *cvs_id_l2tpns = "$Id: l2tpns.c,v 1.50 2004-11-16 21:54:46 fred_nerk Exp $";
 
 #include <arpa/inet.h>
 #include <assert.h>
@@ -2952,10 +2952,9 @@ int main(int argc, char *argv[])
                                break;
                        default:
                                printf("Args are:\n"
-                                      "\t-d\tDetach from terminal\n"
+                                      "\t-d\t\tDetach from terminal\n"
                                       "\t-c <file>\tConfig file\n"
                                       "\t-h <hostname>\tForce hostname\n"
-                                      "\t-a <address>\tUse specific address\n"
                                       "\t-v\t\tDebug\n");
 
                                return (0);

diff --git a/nsctl.8 b/nsctl.8
new file mode 100644 (file)
index 0000000..9d79f56
--- /dev/null
+++ b/nsctl.8
@@ -0,0 +1,41 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH NSCTL 8 "November 16, 2004"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+nsctl \- Issue commands to l2tpns plugins
+.SH SYNOPSIS
+.B nsctl \fI<host>\fP \fI<command>\fP [ \fIargs...\fP ]
+.SH DESCRIPTION
+nsctl is part of the l2tpns package. It allows the system administrator
+to allow messages to be passed to l2tpns plugins.
+.SH OPTIONS
+.TP
+.B <host>
+The host running l2tpns that should receive the message.
+.TP
+.B <command>
+The command to send. Currently one of \fIload_plugin\fP,
+\fIunload_plugin\fP, \fIgarden\fP or \fIungarden\fP.
+\fIgarden\fP/\fIungarden\fP enable or disable the walled garden plugin
+for a particular user; they take a single argument which is the session
+id to affect.
+.SH SEE ALSO
+.BR l2tpns(8)
+.SH AUTHOR
+This manual page was written by Jonathan McDowell <noodles@the.earth.li>,
+for the Debian GNU/Linux system (but may be used by others).
+