pppd: Fix man page description of case when remote IP address isn't known
[ppp.git] / scripts / pon.1
1 .\" This manual is published under the GPL.
2 .\" All guidelines specified in the GPL apply here.
3 .\" To get an ascii file:
4 .\" groff -man -Tascii pon.1 > pon.txt
5 .\"
6 .TH PON 1 "July 2000" "Debian Project" "Debian PPPD"
7 .SH NAME
8 pon, poff, plog \- starts up, shuts down or lists the log of PPP connections
9 .SH SYNOPSIS
10 .B pon
11 [ isp\-name [ options ] ]
12 .br
13 .B poff
14 [ \-r ] [ \-d ] [ \-c ] [ \-a ] [ \-h ] [ isp\-name ]
15 .br
16 .B plog
17 [ arguments ]
18 .SH DESCRIPTION
19 This manual page describes the \fBpon\fP, \fBplog\fP and \fBpoff\fP
20 scripts, which allow users to control PPP connections.
21 ..
22 .SS pon
23 \fBpon\fP, invoked without arguments, runs the \fI/etc/ppp/ppp_on_boot\fP
24 file, if it exists and is executable. Otherwise, a PPP connection will be
25 started using configuration from \fI/etc/ppp/peers/provider\fP.
26 This is the default behaviour unless an \fBisp\-name\fP argument is given.
27 .PP
28 For instance, to use ISP configuration "myisp" run:
29 .IP
30 pon myisp
31 .PP
32 \fBpon\fP will then use the options file \fI/etc/ppp/peers/myisp\fP.
33 You can pass additional \fBoptions\fP after the ISP name, too.
34 \fBpon\fP can be used to run multiple, simultaneous PPP connections.
35 ..
36 .SS poff
37 \fBpoff\fP closes a PPP connection. If more than one PPP connection exists,
38 the one named in the argument to \fBpoff\fP will be killed, e.g.
39 .IP
40 poff myprovider2
41 .PP
42 will terminate the connection to myprovider2, and leave the PPP connections
43 to e.g. "myprovider1" or "myprovider3" up and running.
44 .PP
45 \fBpoff\fP takes the following command line options:
46 .RS
47 .TP
48 .B "\-r"
49 causes the connection to be redialed after it is dropped.
50 .TP
51 .B "\-d"
52 toggles the state of pppd's debug option.
53 .TP
54 .B "\-c"
55 causes
56 .BR pppd (8)
57 to renegotiate compression.
58 .TP
59 .B "\-a"
60 stops all running ppp connections. If the argument \fBisp\-name\fP
61 is given it will be ignored.
62 .TP
63 .B "\-h"
64 displays help information.
65 .TP
66 .B "\-v"
67 prints the version and exits.
68 .PP
69 If no argument is given, \fBpoff\fP will stop or signal pppd if and only
70 if there is exactly one running. If more than one connection is active,
71 it will exit with an error code of 1.
72 ..
73 .SS plog
74 \fBplog\fP shows you the last few lines of \fI/var/log/ppp.log\fP. If that
75 file doesn't exist, it shows you the last few lines of your
76 \fI/var/log/syslog\fP file, but excluding the lines not generated by pppd.
77 This script makes use of the
78 .BR tail (1)
79 command, so arguments that can be passed to
80 .BR tail (1)
81 can also be passed to \fBplog\fP.
82 .PP
83 Note: the \fBplog\fP script can only be used by root or another system
84 administrator in group "adm", due to security reasons. Also, to have all
85 pppd-generated information in one logfile, that plog can show, you need the
86 following line in your \fI/etc/syslog.conf\fP file:
87 .PP
88 local2.*                \-/var/log/ppp.log
89 .RE
90 .SH FILES
91 .TP
92 .I /etc/ppp/options
93 PPPd system options file.
94 .TP
95 .I /etc/ppp/pap\-secrets
96 System PAP passwords file.
97 .TP
98 .I /etc/ppp/chap\-secrets
99 System CHAP passwords file.
100 .TP
101 .I /etc/ppp/peers/
102 Directory holding the peer options files. The default file is called
103 \fIprovider\fP.
104 .TP
105 .I /etc/chatscripts/provider
106 The chat script invoked from the default \fI/etc/ppp/peers/provider\fP.
107 .TP
108 .I /var/log/ppp.log
109 The default PPP log file.
110 .SH AUTHORS
111 The p-commands were written by Christoph Lameter <clameter@debian.org>.
112 Updated and revised by Philip Hands <phil@hands.com>.
113 .br
114 This manual was written by Othmar Pasteka <othmar@tron.at>. Modified
115 by Rob Levin <lilo@openprojects.net>, with some extensions taken from
116 the old p-commands manual written by John Hasler <jhasler@debian.org>.
117 .SH "SEE ALSO"
118 .BR pppd (8),
119 .BR chat (8),
120 .BR tail (1).