Merge branch 'fdn-mods'
[l2tpns.git] / Docs / l2tpns.8
1 .\" -*- nroff -*-
2 .de Id
3 .ds Dt \\$4 \\$5
4 ..
5 .Id $Id: l2tpns.8,v 1.4 2005/06/12 06:09:35 bodea Exp $
6 .TH L2TPNS 8 "\*(Dt" L2TPNS "System Management Commands"
7 .SH NAME
8 l2tpns \- Layer 2 tunneling protocol network server (LNS)
9 .SH SYNOPSIS
10 .B l2tpns
11 .RB [ \-d ]
12 .RB [ \-v ]
13 .RB [ \-c
14 .IR file ]
15 .RB [ \-h
16 .IR hostname ]
17 .SH DESCRIPTION
18 .B l2tpns
19 is a daemon for terminating layer 2 tunneling protocol (L2TP: RFC
20 2661) sessions.
21 .PP
22 Once running,
23 .B l2tpns
24 may be controlled by telnetting to port 23 on the machine running the
25 daemon and with the
26 .B nsctl
27 utility.
28 .SH OPTIONS
29 .TP
30 .B \-d
31 Detach from terminal and fork into the background. By default l2tpns
32 will stay in the foreground.
33 .TP
34 .B \-v
35 Increase verbosity for debugging. Can be used multiple times.
36 .TP
37 .BI "\-c " file
38 Specify configuration file.
39 .TP
40 .BI "\-h " hostname
41 Force hostname to
42 .IR hostname .
43 .SH FILES
44 .TP
45 .I /etc/l2tpns/startup-config
46 The default configuration file.
47 .TP
48 .I /etc/l2tpns/ip_pool
49 IP address pool configuration.
50 .TP
51 .I /etc/l2tpns/users
52 Username/password configuration for access to admin interface.
53 .SH SIGNALS
54 .TP
55 .B SIGHUP
56 Reload the config from disk and re-open log file.
57 .TP
58 .BR SIGTERM ", " SIGINT
59 Stop process.  Tunnels and sessions are not terminated.  This signal
60 should be used to stop l2tpns on a cluster node where there are other
61 machines to continue handling traffic.
62 .TP
63 .B SIGQUIT
64 Shut down tunnels and sessions, exit process when complete.
65 .SH SEE ALSO
66 .BR startup-config (5),
67 .BR nsctl (8)
68 .SH AUTHOR
69 This manual page was written by Jonathan McDowell <noodles@earth.li>,
70 for the Debian GNU/Linux system (but may be used by others).