xref: /freebsd/usr.sbin/pppctl/pppctl.8 (revision 0de89efe5c443f213c7ea28773ef2dc6cf3af2ed)
1.\" $Id: pppctl.8,v 1.2 1997/07/28 22:17:46 brian Exp $
2.Dd 26 June 1997
3.Os FreeBSD
4.Dt PPPCTL 8
5.Sh NAME
6.Nm pppctl
7.Nd
8PPP control program
9.Sh SYNOPSIS
10.Nm
11.Op Fl v
12.Op Fl t Ar n
13.Op Fl p Ar passwd
14.Ar [host:]Port | LocalSocket
15.Ar command
16.Op Ar ;command
17.Ar ...
18.Sh DESCRIPTION
19This program provides command line control of the
20.Nm ppp
21daemon.  Its primary use is to facilitate simple scripts that
22control a running daemon.
23
24.Nm Pppctl
25expects at least two arguments.  The first is interpreted as the
26socket on which the
27.Nm ppp
28daemon is listening.  If the socket contains a leading '/', it
29is taken as an AF_LOCAL socket.  If it contains a colon, it is
30treated as a host:port pair, otherwise it is treated as just a
31port specification on the local machine (127.0.0.1).  Both the
32host and port may be specified numerically if you wish to avoid
33a DNS lookup or don't have an entry for the given port in
34.Pa /etc/services .
35
36.Pp
37All remaining arguments are concatenated to form the command(s) that
38will be sent to the
39.Nm ppp
40daemon.  If any semi-colon characters are found, they are treated
41as command delimiters, allowing more than one command in a given
42"session".  For example;
43
44  pppctl 3000 set timeout 300\\; show timeout
45
46Don't forget to escape or quote the ';' as it is a special character
47for most shells.
48
49The following command line options are available:
50.Bl -tag -width Ds
51.It Fl v
52Display all data sent to and received from the
53.Nm ppp
54daemon.  Normally,
55.Nm pppctl
56displays only non-prompt lines received.
57.It Fl t Ar n
58Use a timeout of
59.Ar n
60instead of the default 2 seconds.  This may be required if you
61wish to control a daemon over a slow (or even a dialup) link.
62.It Fl p Ar passwd
63Specify the password required by the
64.Nm ppp
65daemon.  If this switch is not used,
66.Nm
67will prompt for a password once it has successfully connected to
68.Nm ppp
69(assuming, of course, that one is required).
70.El
71
72.Sh SEE ALSO
73.Xr services 5 ,
74.Xr ppp 8
75
76.Sh HISTORY
77The
78.Nm
79command first appeared in FreeBSD 2.2.5.
80