Add manpages from Jonathan McDowell
[l2tpns.git] / l2tpns.8
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH L2TPNS 8 "November 16, 2004"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 l2tpns \- L2TP LNS daemon
20 .SH SYNOPSIS
21 .B l2tpns
22 [ \fB-d\fR ] [ \fB-c\fR \fI<file>\fR ] [ \fB-h\fR \fI<hostname>\fR ] [ \fB-a\fR \fI<address>\fR ] [ \fB-v\fR ]
23 .br
24 .SH DESCRIPTION
25 This manual page documents briefly the
26 .B l2tpns
27 command.
28 .PP
29 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
30 .\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
31 .\" respectively.
32 \fBl2tpns\fP is an L2TP LNS daemon that doesn't require kernel support
33 for PPP or L2TP, nor any kernel patches. For more information on L2TP see
34 RFC 2661.
35 .PP
36 Once running l2tpns can be controlled by telnetting to port 23 on the
37 machine running the daemon.
38 .SH OPTIONS
39 .TP
40 .B \-d
41 Detach from terminal and fork into the background. By default l2tpns
42 will stay in the foreground.
43 .TP
44 .B \-c <file>
45 Specify config file.
46 .TP
47 .B \-h <hostname>
48 Force hostname to <hostname>.
49 .TP
50 .B \-v
51 Increase verbosity for debugging. Can be used multiple times.
52 .br
53 .SH FILES
54 .TP
55 \fB\fI/etc/l2tpns/startup-config\fR
56 The default configuration file.
57 .TP
58 \fB\fI/etc/l2tpns/ip_pool\fR
59 IP address pool configuration.
60 .TP
61 \fB\fI/etc/l2tpns/users\fR
62 Username/password configuration for access to admin interface.
63 .SH SEE ALSO
64 \fInsctl\fR(8)
65 .SH AUTHOR
66 This manual page was written by Jonathan McDowell <noodles@earth.li>,
67 for the Debian GNU/Linux system (but may be used by others).
68