9d79f56b15dd524085187d20534835dd03a2a7c9
[l2tpns.git] / nsctl.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 NSCTL 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 nsctl \- Issue commands to l2tpns plugins
20 .SH SYNOPSIS
21 .B nsctl \fI<host>\fP \fI<command>\fP [ \fIargs...\fP ]
22 .SH DESCRIPTION
23 nsctl is part of the l2tpns package. It allows the system administrator
24 to allow messages to be passed to l2tpns plugins.
25 .SH OPTIONS
26 .TP
27 .B <host>
28 The host running l2tpns that should receive the message.
29 .TP
30 .B <command>
31 The command to send. Currently one of \fIload_plugin\fP,
32 \fIunload_plugin\fP, \fIgarden\fP or \fIungarden\fP.
33 \fIgarden\fP/\fIungarden\fP enable or disable the walled garden plugin
34 for a particular user; they take a single argument which is the session
35 id to affect.
36 .SH SEE ALSO
37 .BR l2tpns(8)
38 .SH AUTHOR
39 This manual page was written by Jonathan McDowell <noodles@the.earth.li>,
40 for the Debian GNU/Linux system (but may be used by others).
41