1.\" $OpenBSD: npppctl.8,v 1.1 2012/01/18 03:13:04 yasuoka 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: January 18 2012 $ 18.Dt NPPPCTL 8 19.Os 20.Sh NAME 21.Nm npppctl 22.Nd control the npppd daemon 23.\" XXX .Xr npppd 8 24.Sh SYNOPSIS 25.Nm 26.Op Fl n 27.Op Fl r Ar rcvbuf_size 28.Op Fl s Ar socket 29.Op Fl t Ar timeout_sec 30.Ar command 31.Op Ar argument ... 32.Sh DESCRIPTION 33The 34.Nm 35utility controls 36the 37.\" XXX .Xr npppd 8 38npppd 39daemon. 40.Pp 41The options are as follows: 42.Bl -tag -width Ds 43.It Fl n 44Show IP addresses instead of their hostnames. 45.It Fl r Ar rcvbuf_size 46.Nm 47may fail if the receive buffer is not large enough for 48the requested information. 49Use 50.Ar rcvbuf_size 51to extend the receive buffer size instead of the default value of 131072. 52This must be greater than or equal to 2048. 53.It Fl s Ar socket 54Use 55.Ar socket 56instead of the default 57.Pa /var/run/npppd_ctl 58to communicate with 59.\" XXX .Xr npppd 8 . 60npppd. 61.It Fl t Ar timeout_sec 62Use 63.Ar timeout_sec 64as the I/O timeout timer value in seconds instead of the default value of 2. 65.El 66.Sh NPPPD CONTROL COMMANDS 67The following commands are available: 68.Bl -tag -width Ds 69.It Cm clear Ar all | filter ... 70Disconnect PPP sessions. 71If 72.Ar filter 73is specified, only matching PPP sessions are disconnected. 74If 75.Ar all 76is specified, all PPP sessions are disconnected. 77See 78.Cm session all 79for the types of 80.Ar filter . 81.It Cm session all Op Ar filter ... 82Show detailed information for PPP sessions. 83If 84.Ar filter 85is specified, only matching PPP sessions are shown; 86otherwise all PPP sessions are shown. 87The following filters are available: 88.Bl -tag -width Ds 89.It Cm address Ar ip_address 90Show or clear PPP sessions whose IP address match 91.Ar ip_address . 92.It Cm interface Ar interface_name 93Show or clear PPP sessions that use the interface specified by 94.Ar interface_name . 95.It Cm ppp-id Ar id 96Show or clear PPP sessions whose Ppp-Id match 97.Ar id . 98.It Cm protocol Ar protocol 99Show or clear PPP sessions that use the tunneling protocol specified by 100.Ar protocol . 101.It Cm realm Ar realm_name 102Show or clear PPP sessions whose realm match the specified 103.Ar realm_name . 104.It Cm username Ar username 105Show or clear PPP sessions whose username match 106.Ar username . 107.El 108.It Cm session brief 109Show brief information for all PPP sessions. 110.It Cm session packets 111Show I/O statistics for all PPP sessions. 112.El 113.\" The following requests should be uncommented and used where appropriate. 114.\" This next request is for sections 2, 3, and 9 function return values only. 115.\" .Sh RETURN VALUES 116.\" This next request is for sections 1, 6, 7 & 8 only. 117.\" .Sh ENVIRONMENT 118.\" .Sh FILES 119.\" .Sh EXAMPLES 120.\" This next request is for sections 1, 4, 6, and 8 only. 121.\" .Sh DIAGNOSTICS 122.\" The next request is for sections 2, 3, and 9 error and signal handling only. 123.\" .Sh ERRORS 124.\" .Sh SEE ALSO 125.\" .Xr npppd 8 126.\" .Sh STANDARDS 127.Sh HISTORY 128The 129.Nm 130program first appeared in 131.Ox 1325.1. 133.Sh AUTHORS 134The 135.Nm 136program was written by Internet Initiative Japan Inc. 137.\" .Sh CAVEATS 138.\" .Sh BUGS 139