xref: /openbsd-src/usr.sbin/npppctl/npppctl.8 (revision 5e71945831dd7bc4bd71a42c2208b8839422304a)
1.\"	$OpenBSD: npppctl.8,v 1.6 2014/04/04 02:49:46 schwarze Exp $
2.\"
3.\" Copyright (c) 2012 Internet Initiative Japan Inc.
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: April 4 2014 $
18.Dt NPPPCTL 8
19.Os
20.Sh NAME
21.Nm npppctl
22.Nd control npppd
23.Sh SYNOPSIS
24.Nm
25.Op Fl n
26.Op Fl s Ar socket
27.Ar command
28.Op Ar argument ...
29.Sh DESCRIPTION
30The
31.Nm
32utility controls
33the
34.Xr npppd 8
35daemon.
36.Pp
37The options are as follows:
38.Bl -tag -width Ds
39.It Fl n
40Show IP addresses instead of their hostnames.
41.It Fl s Ar socket
42Use
43.Ar socket
44instead of the default
45.Pa /var/run/npppd.sock
46to communicate with
47.Xr npppd 8 .
48.El
49.Pp
50The following commands are available:
51.Bl -tag -width Ds
52.It Cm clear all | Ar filter ...
53Disconnect PPP sessions.
54If
55.Ar filter
56is specified, only matching PPP sessions are disconnected.
57If
58.Cm all
59is specified, all PPP sessions are disconnected.
60See
61.Cm session all
62for the types of
63.Ar filter .
64.It Cm monitor all | Ar filter ...
65Monitor start and stop of PPP sessions.
66If
67.Ar filter
68is specified, only matching PPP sessions are monitored.
69If
70.Cm all
71is specified, all PPP sessions are monitored.
72See
73.Cm session all
74for the types of
75.Ar filter .
76.It Cm session all Op Ar filter ...
77Show detailed information for PPP sessions.
78If
79.Ar filter
80is specified, only matching PPP sessions are shown;
81otherwise all PPP sessions are shown.
82The following filters are available:
83.Bl -tag -width Ds
84.It Cm address Ar ip_address
85Show or clear PPP sessions whose IP address match
86.Ar ip_address .
87.It Cm interface Ar interface_name
88Show or clear PPP sessions that use the interface specified by
89.Ar interface_name .
90.It Cm ppp-id Ar id
91Show or clear PPP sessions whose Ppp-Id match
92.Ar id .
93.It Cm protocol Ar protocol
94Show or clear PPP sessions that use the tunneling protocol specified by
95.Ar protocol .
96.It Cm realm Ar realm_name
97Show or clear PPP sessions whose realm match the specified
98.Ar realm_name .
99.It Cm username  Ar username
100Show or clear PPP sessions whose username match
101.Ar username .
102.El
103.It Cm session brief
104Show brief information for all PPP sessions.
105.It Cm session packets
106Show I/O statistics for all PPP sessions.
107.El
108.\" .Sh ENVIRONMENT
109.\" .Sh FILES
110.\" .Sh EXAMPLES
111.\" .Sh DIAGNOSTICS
112.\" .Sh SEE ALSO
113.\" .Xr npppd 8
114.\" .Sh STANDARDS
115.Sh HISTORY
116The
117.Nm
118program first appeared in
119.Ox
1205.3.
121.Sh AUTHORS
122The
123.Nm
124program was written by Internet Initiative Japan Inc.
125.\" .Sh CAVEATS
126.\" .Sh BUGS
127