]> git.ipfire.org Git - ipfire-3.x.git/blob - ppp/patches/0016-rp-pppoe-add-manpage-for-pppoe-discovery.patch
ppp: Update to 2.4.6.
[ipfire-3.x.git] / ppp / patches / 0016-rp-pppoe-add-manpage-for-pppoe-discovery.patch
1 From a30efa2cc99a5b6ab220de04cbcc7db38888a17a Mon Sep 17 00:00:00 2001
2 From: Michal Sekletar <msekleta@redhat.com>
3 Date: Mon, 7 Apr 2014 14:29:45 +0200
4 Subject: [PATCH 16/25] rp-pppoe: add manpage for pppoe-discovery
5
6 ---
7 pppd/plugins/rp-pppoe/Makefile.linux | 2 +
8 pppd/plugins/rp-pppoe/pppoe-discovery.8 | 86 +++++++++++++++++++++++++++++++++
9 2 files changed, 88 insertions(+)
10 create mode 100644 pppd/plugins/rp-pppoe/pppoe-discovery.8
11
12 diff --git a/pppd/plugins/rp-pppoe/Makefile.linux b/pppd/plugins/rp-pppoe/Makefile.linux
13 index 3cd9101..9918091 100644
14 --- a/pppd/plugins/rp-pppoe/Makefile.linux
15 +++ b/pppd/plugins/rp-pppoe/Makefile.linux
16 @@ -16,6 +16,7 @@
17
18 DESTDIR = $(INSTROOT)@DESTDIR@
19 BINDIR = $(DESTDIR)/sbin
20 +MANDIR = $(DESTDIR)/share/man/man8
21 LIBDIR = $(DESTDIR)/lib/$(shell gcc -print-multi-os-directory 2> /dev/null)/pppd/$(PPPDVERSION)
22
23 PPPDVERSION = $(shell awk -F '"' '/VERSION/ { print $$2; }' ../../patchlevel.h)
24 @@ -46,6 +47,7 @@ install: all
25 $(INSTALL) -c -m 4550 rp-pppoe.so $(LIBDIR)
26 $(INSTALL) -d -m 755 $(BINDIR)
27 $(INSTALL) -c -m 555 pppoe-discovery $(BINDIR)
28 + $(INSTALL) -c -m 444 pppoe-discovery.8 $(MANDIR)
29
30 clean:
31 rm -f *.o *.so pppoe-discovery
32 diff --git a/pppd/plugins/rp-pppoe/pppoe-discovery.8 b/pppd/plugins/rp-pppoe/pppoe-discovery.8
33 new file mode 100644
34 index 0000000..d0a93db
35 --- /dev/null
36 +++ b/pppd/plugins/rp-pppoe/pppoe-discovery.8
37 @@ -0,0 +1,86 @@
38 +.\" pppoe-discovery.8 written by
39 +.\" Ben Hutchings <ben@decadentplace.org.uk>, based on pppoe.8.
40 +.\" Licenced under the GPL version 2 or later.
41 +.TH PPPOE-DISCOVERY 8
42 +.SH NAME
43 +pppoe\-discovery \- perform PPPoE discovery
44 +.SH SYNOPSIS
45 +.B pppoe\-discovery
46 +[
47 +.I options
48 +]
49 +.br
50 +.BR pppoe\-discovery " { " \-V " | " \-h " }"
51 +.SH DESCRIPTION
52 +.LP
53 +\fBpppoe\-discovery\fR performs the same discovery process as
54 +\fBpppoe\fR, but does not initiate a session.
55 +It sends a PADI packet and then prints the names of access
56 +concentrators in each PADO packet it receives.
57 +.SH OPTIONS
58 +.TP
59 +.BI \-I " interface"
60 +.RS
61 +The \fB\-I\fR option specifies the Ethernet interface to use.
62 +Under Linux, it is typically eth0 or eth1.
63 +The interface should be \(lqup\(rq before you start
64 +\fBpppoe\-discovery\fR, but should \fInot\fR be configured to have an
65 +IP address.
66 +The default interface is eth0.
67 +.RE
68 +.TP
69 +.BI \-D " file_name"
70 +.RS
71 +The \fB\-D\fR option causes every packet to be dumped to the specified
72 +\fIfile_name\fR.
73 +This is intended for debugging only.
74 +.RE
75 +.TP
76 +.B \-U
77 +.RS
78 +Causes \fBpppoe\-discovery\fR to use the Host-Uniq tag in its discovery
79 +packets.
80 +This lets you run multiple instances of \fBpppoe\-discovery\fR and/or
81 +\fBpppoe\fR without having their discovery packets interfere with one
82 +another.
83 +You must supply this option to \fIall\fR instances that you intend to
84 +run simultaneously.
85 +.RE
86 +.TP
87 +.BI \-S " service_name"
88 +.RS
89 +Specifies the desired service name.
90 +\fBpppoe\-discovery\fR will only accept access concentrators which can
91 +provide the specified service.
92 +In most cases, you should \fInot\fR specify this option.
93 +Use it only if you know that there are multiple access concentrators
94 +or know that you need a specific service name.
95 +.RE
96 +.TP
97 +.BI \-C " ac_name"
98 +.RS
99 +Specifies the desired access concentrator name.
100 +\fBpppoe\-discovery\fR will only accept the specified access
101 +concentrator.
102 +In most cases, you should \fInot\fR specify this option.
103 +Use it only if you know that there are multiple access concentrators.
104 +If both the \fB\-S\fR and \fB\-C\fR options are specified, they must
105 +\fIboth\fR match.
106 +.RE
107 +.TP
108 +.B \-A
109 +.RS
110 +This option is accepted for compatibility with \fBpppoe\fR, but has no
111 +effect.
112 +.RE
113 +.TP
114 +.BR \-V " | " \-h
115 +.RS
116 +Either of these options causes \fBpppoe\-discovery\fR to print its
117 +version number and usage information, then exit.
118 +.RE
119 +.SH AUTHORS
120 +\fBpppoe\-discovery\fR was written by Marco d'Itri <md@linux.it>,
121 +based on \fBpppoe\fR by David F. Skoll <dfs@roaringpenguin.com>.
122 +.SH SEE ALSO
123 +pppoe(8), pppoe-sniff(8)
124 --
125 1.8.3.1
126