release/src/router/rp-l2tp/man/l2tpd.8

   1 .\" $Id: l2tpd.8,v 1.1.48.1 2005/08/08 12:05:25 honor Exp $
   2 .\" LIC: GPL
   3 .TH L2TPD 8 "11 March 2002"
   4 .UC 4
   5 .SH NAME
   6 l2tpd \- user-space L2TP daemon.
   7 .SH SYNOPSIS
   8 .B l2tpd \fR[\fIoptions\fR]
   9
  10 .SH DESCRIPTION
  11 \fBl2tpd\fR is a user-space L2TP daemon.  L2TP is the Layer Two
  12 Tunneling Protocol described in RFC 2661.  It allows you to tunnel
  13 PPP sessions over a network or transport protocol (in this case, UDP.)
  14
  15 .SH OPTIONS
  16 .TP
  17 .B \-d \fInum\fR
  18 Sets the debug level to \fInum\fR.  Of interest mostly to
  19 \fBl2tpd\fR developers.  \fInum\fR is a bitmask; set it to
  20 65535 for maximum debugging information.
  21
  22 .TP
  23 .B \-f
  24 Do not fork.  Normally, \fBl2tpd\fR forks and puts itself in the
  25 background.  This option causes it to stay running in the foreground.
  26
  27 .SH L2TPD ARCHITECTURE
  28
  29 The \fBl2tpd\fR program itself contains \fIonly\fR code necessary
  30 for processing L2TP datagrams and maintaining L2TP tunnels and
  31 sessions.  It does \fInot\fR contain code for interacting with
  32 \fBpppd\fR or for users to control session establishment and teardown.
  33 These functions are performed by \fIhandlers\fR, which are
  34 shared-object libraries dynamically loaded at run-time.
  35 .PP
  36 The handlers currently distributed with \fBl2tpd\fR include:
  37 .TP
  38 .B sync-pppd.so
  39 A shared-library which interfaces with \fBpppd\fR and allows \fBl2tpd\fR
  40 to act as both an LAC and an LNS.
  41 .TP
  42 .B cmd.so
  43 A simple command-interpreter which listens on a UNIX-domain socket
  44 and allows you to start and stop L2TP sessions.
  45 .PP
  46 \fBl2tpd\fR is a single-threaded, event-driven program.  It should be
  47 fairly lightweight and efficient.
  48
  49 .SH L2TPD CONFIGURATION
  50 On startup, \fBl2tpd\fR reads the configuration file \fB/etc/l2tp/l2tp.conf\fR.
  51 This configuration file sets operating parameters, describes peers and loads
  52 and configures handlers.  See \fBl2tp.conf\fR(5) for configuration
  53 file details.
  54
  55 .SH FILES
  56 .TP
  57 .B /etc/l2tp/l2tp.conf
  58 Main configuration file.
  59 .TP
  60 .B /var/run/l2tpctrl
  61 Control socket for \fBcmd.so\fR handler.
  62
  63 .SH AUTHORS
  64 \fBl2tpd\fR was written by David F. Skoll <dfs@roaringpenguin.com>.
  65