pppd/plugins/pppoe/pppoe-discovery.8

   1 .\" pppoe-discovery.8 written by
   2 .\" Ben Hutchings <ben@decadentplace.org.uk>, based on pppoe.8.
   3 .\" Licenced under the GPL version 2 or later.
   4 .TH PPPOE-DISCOVERY 8
   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 This option is mandatory.
  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.
  43 This lets you run multiple instances of \fBpppoe\-discovery\fR and/or
  44 \fBpppoe\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 .RE
  49 .TP
  50 .BI \-S " service_name"
  51 .RS
  52 Specifies the desired service name.
  53 \fBpppoe\-discovery\fR will only accept access concentrators which can
  54 provide the specified service.
  55 In most cases, you should \fInot\fR specify this option.
  56 Use it only if you know that there are multiple access concentrators
  57 or know that you need a specific service name.
  58 .RE
  59 .TP
  60 .BI \-C " ac_name"
  61 .RS
  62 Specifies the desired access concentrator name.
  63 \fBpppoe\-discovery\fR will only accept the specified access
  64 concentrator.
  65 In most cases, you should \fInot\fR specify this option.
  66 Use it only if you know that there are multiple access concentrators.
  67 If both the \fB\-S\fR and \fB\-C\fR options are specified, they must
  68 \fIboth\fR match.
  69 .RE
  70 .TP
  71 .B \-A
  72 .RS
  73 This option is accepted for compatibility with \fBpppoe\fR, but has no
  74 effect.
  75 .RE
  76 .TP
  77 .BR \-V " | " \-h
  78 .RS
  79 Either of these options causes \fBpppoe\-discovery\fR to print its
  80 version number and usage information, then exit.
  81 .RE
  82 .SH AUTHORS
  83 \fBpppoe\-discovery\fR was written by Marco d'Itri <md@linux.it>,
  84 based on \fBpppoe\fR by David F. Skoll <dfs@roaringpenguin.com>.
  85 .SH SEE ALSO
  86 pppoe(8), pppoe-sniff(8)