- Add startup-config(5) manpage [FIXME].
- Revise nsctl to allow arbitrary strings/args to be passed to plugins.
This commit is contained in:
parent
9f5e93e3cd
commit
bf0a00f106
17 changed files with 796 additions and 415 deletions
64
Docs/l2tpns.8
Normal file
64
Docs/l2tpns.8
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
.\" -*- nroff -*-
|
||||
.de Id
|
||||
.ds Dt \\$4 \\$5
|
||||
..
|
||||
.Id $Id: l2tpns.8,v 1.1 2004/11/17 08:23:35 bodea Exp $
|
||||
.TH L2TPNS 8 "\*(Dt" L2TPNS "System Management Commands"
|
||||
.SH NAME
|
||||
l2tpns \- L2TP LNS daemon
|
||||
.SH SYNOPSIS
|
||||
.B l2tpns
|
||||
.RB [ \-d ]
|
||||
.RB [ \-v ]
|
||||
.RB [ \-c
|
||||
.IR file ]
|
||||
.RB [ \-h
|
||||
.IR hostname ]
|
||||
.SH DESCRIPTION
|
||||
This manual page documents briefly the
|
||||
.B l2tpns
|
||||
command.
|
||||
.PP
|
||||
.B l2tpns
|
||||
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,
|
||||
.B l2tpns
|
||||
may be controlled by telnetting to port 23 on the machine running the
|
||||
daemon and with the
|
||||
.B nsctl
|
||||
utility.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B \-d
|
||||
Detach from terminal and fork into the background. By default l2tpns
|
||||
will stay in the foreground.
|
||||
.TP
|
||||
.B \-v
|
||||
Increase verbosity for debugging. Can be used multiple times.
|
||||
.TP
|
||||
.BI "\-c " file
|
||||
Specify configuration file.
|
||||
.TP
|
||||
.BI "\-h " hostname
|
||||
Force hostname to
|
||||
.IR hostname .
|
||||
.SH FILES
|
||||
.TP
|
||||
.I /etc/l2tpns/startup-config
|
||||
The default configuration file.
|
||||
.TP
|
||||
.I /etc/l2tpns/ip_pool
|
||||
IP address pool configuration.
|
||||
.TP
|
||||
.I /etc/l2tpns/users
|
||||
Username/password configuration for access to admin interface.
|
||||
.SH SEE ALSO
|
||||
.BR startup-config (5),
|
||||
and
|
||||
.BR nsctl (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).
|
||||
67
Docs/nsctl.8
Normal file
67
Docs/nsctl.8
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
.\" -*- nroff -*-
|
||||
.de Id
|
||||
.ds Dt \\$4 \\$5
|
||||
..
|
||||
.Id $Id: nsctl.8,v 1.1 2004/11/17 08:23:35 bodea Exp $
|
||||
.TH NSCTL 8 "\*(Dt" L2TPNS "System Management Commands"
|
||||
.SH NAME
|
||||
nsctl \- Issue commands to l2tpns plugins
|
||||
.SH SYNOPSIS
|
||||
.B nsctl
|
||||
.RB [ \-d ]
|
||||
.RB [ \-h
|
||||
.IR host [: port ]]
|
||||
.RB [ \-t
|
||||
.IR timeout ]
|
||||
.I command
|
||||
.RI [ arg " ...]"
|
||||
.SH DESCRIPTION
|
||||
.B nsctl
|
||||
is part of the
|
||||
.B l2tpns
|
||||
package. It allows the system administrator to send manage plugin
|
||||
features of a running l2tpns process.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.B \-d
|
||||
Enable debugging output.
|
||||
.TP
|
||||
.B \-h \fIhost\fR[:\fIport\fR]
|
||||
The host running
|
||||
.B l2tpns
|
||||
that should receive the message. By default the message is sent to
|
||||
UDP port 1702 on
|
||||
.BR localhost .
|
||||
.TP
|
||||
.B \-t \fItimeout\fR
|
||||
Timeout in seconds to wait for a response from the server.
|
||||
.SH COMMANDS
|
||||
The first argument specifies the command to send to
|
||||
.B l2tpns .
|
||||
The following commands are as defined:
|
||||
.TP
|
||||
.BI "load_plugin " plugin
|
||||
Load the named
|
||||
.IR plugin .
|
||||
.TP
|
||||
.BI "unload_plugin " plugin
|
||||
Unload the named
|
||||
.IR plugin .
|
||||
.TP
|
||||
.B help
|
||||
Each loaded plugin is queried for what commands it supports and the
|
||||
synopsis for each is output.
|
||||
.PP
|
||||
Any other value of
|
||||
.I command
|
||||
(and
|
||||
.I args
|
||||
if any)
|
||||
are sent to
|
||||
.B l2tpns
|
||||
as-is, to be passed to each plugin in turn (and possibly acted upon).
|
||||
.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).
|
||||
Loading…
Add table
Add a link
Reference in a new issue