xref: /freebsd/usr.sbin/pppctl/pppctl.8 (revision ce834215a70ff69e7e222827437116eee2f9ac6f)
1.\" $Id:$
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 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 consists entirely of numbers,
30it is interpreted as a TCP port number on localhost.  If it contains
31any characters, the first of which is not a '/' character, it is
32interpreted as an entry of type "tcp" from
33.Pa /etc/services .
34All remaining arguments are concatenated to form the command(s) that
35will be sent to the
36.Nm ppp
37daemon.  If any semi-colon characters are found, they are treated
38as command delimiters, allowing more than one command in a given
39"session".  For example;
40
41  pppctl 3000 set timeout 300\\; show timeout
42
43Don't forget to escape or quote the ';' as it is a special character
44for most shells.
45
46The following command line options are available:
47.Bl -tag -width Ds
48.It Fl v
49Display all data sent to and received from the
50.Nm ppp
51daemon.  Normally,
52.Nm pppctl
53displays only non-prompt lines received.
54.It Fl t Ar n
55Use a timeout of
56.Ar n
57instead of the default 2 seconds.  This may be required if you
58wish to control a daemon over a slow (or even a dialup) link.
59.It Fl p Ar passwd
60Specify the password required by the
61.Nm ppp
62daemon.  If this switch is not used,
63.Nm
64will prompt for a password once it has successfully connected to
65.Nm ppp
66(assuming, of course, that one is required).
67.El
68
69.Sh SEE ALSO
70.Xr ppp 8 ,
71.Xr services 5
72
73.Sh HISTORY
74The
75.Nm
76command first appeared in FreeBSD 2.2.5.
77