| 1 |
.\" pppoe-discovery.8 written by |
| 2 |
.\" Ben Hutchings <[email protected]>, based on pppoe.8. |
| 3 |
.\" Licenced under the GPL version 2 or later. |
| 4 |
.TH PPPOE-DISCOVERY 8 "12 January 2019" |
| 5 |
.SH NAME |
| 6 |
pppoe\-discovery \- perform PPPoE discovery |
| 7 |
.SH SYNOPSIS |
| 8 |
.B pppoe\-discovery |
| 9 |
[ |
| 10 |
.I options |
| 11 |
] |
| 12 |
.br |
| 13 |
.BR pppoe\-discovery " { " \-V " | " \-h " }" |
| 14 |
.SH DESCRIPTION |
| 15 |
.LP |
| 16 |
\fBpppoe\-discovery\fR performs the same discovery process as |
| 17 |
\fBpppoe\fR, but does not initiate a session. |
| 18 |
It sends a PADI packet and then prints the names of access |
| 19 |
concentrators in each PADO packet it receives. |
| 20 |
.SH OPTIONS |
| 21 |
.TP |
| 22 |
.BI \-I " interface" |
| 23 |
.RS |
| 24 |
The \fB\-I\fR option specifies the Ethernet interface to use. |
| 25 |
Under Linux, it is typically eth0 or eth1. |
| 26 |
The interface should be \(lqup\(rq before you start |
| 27 |
\fBpppoe\-discovery\fR, but should \fInot\fR be configured to have an |
| 28 |
IP address. |
| 29 |
The default interface is eth0. |
| 30 |
.RE |
| 31 |
.TP |
| 32 |
.BI \-D " file_name" |
| 33 |
.RS |
| 34 |
The \fB\-D\fR option causes every packet to be dumped to the specified |
| 35 |
\fIfile_name\fR. |
| 36 |
This is intended for debugging only. |
| 37 |
.RE |
| 38 |
.TP |
| 39 |
.B \-U |
| 40 |
.RS |
| 41 |
Causes \fBpppoe\-discovery\fR to use the Host-Uniq tag in its discovery |
| 42 |
packets. The value of the tag is derived from the process's PID number. |
| 43 |
This lets you run multiple instances of \fBpppoe\-discovery\fR and/or |
| 44 |
\fBpppd\fR without having their discovery packets interfere with one |
| 45 |
another. |
| 46 |
You must supply this option to \fIall\fR instances that you intend to |
| 47 |
run simultaneously. |
| 48 |
This option is mutually exclusive with \fB\-W\fR. |
| 49 |
.RE |
| 50 |
.TP |
| 51 |
.BI \-W " value" |
| 52 |
.RS |
| 53 |
Causes \fBpppoe\-discovery\fR to use the Host-Uniq tag in its discovery |
| 54 |
packets. The value of the tag is taken from the option argument, |
| 55 |
encoded as a string of hexadecimal digits. |
| 56 |
This lets you run multiple instances of \fBpppoe\-discovery\fR and/or |
| 57 |
\fBpppd\fR without having their discovery packets interfere with one |
| 58 |
another. |
| 59 |
You must supply this option to \fIall\fR instances that you intend to |
| 60 |
run simultaneously. |
| 61 |
This option is mutually exclusive with \fB\-U\fR. |
| 62 |
.RE |
| 63 |
.TP |
| 64 |
.BI \-S " service_name" |
| 65 |
.RS |
| 66 |
Specifies the desired service name. |
| 67 |
\fBpppoe\-discovery\fR will only accept access concentrators which can |
| 68 |
provide the specified service. |
| 69 |
In most cases, you should \fInot\fR specify this option. |
| 70 |
Use it only if you know that there are multiple access concentrators |
| 71 |
or know that you need a specific service name. |
| 72 |
.RE |
| 73 |
.TP |
| 74 |
.BI \-C " ac_name" |
| 75 |
.RS |
| 76 |
Specifies the desired access concentrator name. |
| 77 |
\fBpppoe\-discovery\fR will only accept the specified access |
| 78 |
concentrator. |
| 79 |
In most cases, you should \fInot\fR specify this option. |
| 80 |
Use it only if you know that there are multiple access concentrators. |
| 81 |
If both the \fB\-S\fR and \fB\-C\fR options are specified, they must |
| 82 |
\fIboth\fR match. |
| 83 |
.RE |
| 84 |
.TP |
| 85 |
.B \-Q |
| 86 |
.RS |
| 87 |
Causes \fBpppoe\-discovery\fR to avoid printing discovered access |
| 88 |
concentrator names. |
| 89 |
This can be useful in scripts, which can use the exit code of the |
| 90 |
program to determine whether any matching access concentrators were |
| 91 |
discovered. |
| 92 |
.RE |
| 93 |
.TP |
| 94 |
.BI \-t " timeout" |
| 95 |
.RS |
| 96 |
Changes the discovery timeout for PADI requests, in seconds. |
| 97 |
The default value is 5 seconds. |
| 98 |
.RE |
| 99 |
.TP |
| 100 |
.BI \-a " attempts" |
| 101 |
.RS |
| 102 |
Changes the number of PADI discovery attempts made. |
| 103 |
By default, 3 attempts are made to discover access concentrators before |
| 104 |
giving up. |
| 105 |
.RE |
| 106 |
.TP |
| 107 |
.BR \-V " | " \-h |
| 108 |
.RS |
| 109 |
Either of these options causes \fBpppoe\-discovery\fR to print its |
| 110 |
version number and usage information, then exit. |
| 111 |
.RE |
| 112 |
.SH AUTHORS |
| 113 |
\fBpppoe\-discovery\fR was written by Marco d'Itri <[email protected]>, |
| 114 |
based on \fBpppoe\fR by David F. Skoll <[email protected]>. |
| 115 |
.SH SEE ALSO |
| 116 |
pppoe(8), pppoe-sniff(8) |