Copyright (c) 2007 Dimitri Marinakis.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
[:stab:] You didn't know that €17 on top of your CONN-X subscription buys you a nice stand-alone ADSL/4-port Ethernet/WiFi router with web interface, did you? But then, you would miss all that fun!
These are generic instructions and pointers for setting up the
“Sagem F@st 800” DSL modem, version E4, included in ADSL
packs by the specific provider (OTEnet). The modem is used in the
PPPoA mode (Point-to-Point Protocol over ATM). Based on ADI/Ikanos
chips, it is the fourth member of the “Eagle” family (Eagle IV or
E4) and it is supported under GNU/Linux
[Although this modem is provided for use on PSTN or POTS lines, DSP software is also available for use on ISDN (RNIS) lines. The PPPoE protocol can also be used. Follow the instructions in Italic text inside square brackets.]
Packages are already available for the Debian and Ubuntu
distributions; look for
ADSL/DSL: Asymmetric / Digital Subscriber Link – (Asymmetric means that the receive/downlink and transmit/uplink speeds are different)
ATM: Asynchronous Transfer Mode – a connection oriented protocol using fixed-size cells, 53 bytes long.
CMV: Command Management Variables
DSLAM : Digital Subscriber Line Access Multiplexer
DSP: Digital Signal Processing (Processor)
ISDN: Integrated Services Digital Network
pilote: chauffeur :-) - driver
POTS: Plain Old Telephone Service
PPPoA: Point-to-Point Protocol over ATM
PPPoE: Point-to-Point Protocol over Ethernet
PSTN: Public Switched Telephone Network
RNIS: Réseau Numérique à Intégration de Services (ISDN)
14-Jun-2007 – ISDN, PPPoE
10-Jun-2007 – First release – tlgu.carmen.gr
Werner Almesberger's papers (ATM on Linux and low-end
Information specific to this application
Installation instructions (start
ueagle forum (brush up your
man pppd – Point-to-Point Protocol daemon configuration (a must read!)
man svn – Subversion, a version control system client
Links in all referenced pages
Modem installation guide
The usual disclaimer about misconfiguring your system beyond repair or oblueterating your work applies: Don't blame it on me. Do one thing at a time. Read and Learn. Write to tlgu, carmen gr, in case this document contains inaccuracies, errors or if you have some information that others can benefit from.
> lsusb Bus 001 Device 006: ID 1110:9041 Analog Devices Canada, Ltd (Allied Telesyn)
Actually, this ID appears after
driver is loaded. If the driver is not loaded, the respective
Bus 001 Device 007: ID 1110:9042 Analog Devices Canada, Ltd (Allied Telesyn)
This modem is based on the IKE-6488 (analogue front-end including ADC/DAC, equalizer and on-chip adaptive filters) with an IKE-6505 (digital back-end, including 8051 processor core, USB interface and modem engine). This chipset, dubbed Eagle IV, is capable of 8Mbps downlink and 800kbps uplink transfer rates, according to Ikanos (see References, Hardware, above).
To make the modem work, the following software items are needed, in addition to the nicely boxed hardware:
1. The Eagle IV backend firmware, DSP code and command management
eagleIV.fw, DSP4p.bin, CMV4p.bin.v2
[Notice the lower-case “p” which stands for POTS; “i” versions for ISDN are named DSP4i.bin and CMV4i.bin.v2]
ueagle-atm driver; loads the firmware, DSP
code (POTS or ISDN) and command variables.
pppoatm driver (should be included in your
You must be root (
for Ubuntu-like systems).
First, you should remove any (older) instances of already loaded/running driver modules that want to control our modem:
> lsmod | grep atm > lsmod | grep eagle
> modprobe -r eagle-usb > modprobe -r ueagle-atm
Add a line to
/etc/modprobe.d/blacklist in order to
prevent loading of the deprecated
> echo 'blacklist eagle-usb' >> /etc/modprobe.d/blacklist
(Yes, you may edit the file manually – the last line should read:
Download the latest driver version using
(subersion), and then build and install it. The following commands
will fetch the driver in a new directory called ueagle-atm, compile
and install the driver module. The kernel headers are needed
for driver compilation; if you don't have them (or the kernel source)
installed, do it now.
> svn co svn://svn.gna.org/svn/ueagleatm/trunk/ueagle-atm ueagle-atm > cd ueagle-atm > make > make install
Download the POTS firmware and copy them to the appropriate firmware directory
http://download.gna.org/ueagleatm/ikanos/ueagle4-data-1.0.tar.gz > tar xvzf ueagle4-data-1.0.tar.gz > mkdir -p /lib/firmware/ueagle-atm > cp ueagle4-data-1.0/* /lib/firmware/ueagle-atm
I did mention earlier that packages are already available for
Debian/Ubuntu and possibly for other distributions. You may prefer to
get those packages instead. The generic installation run on Ubuntu
7.04 and SuSE 10.3 without any problem. I had a couple of
issues with PCLinuxOS that were quickly resolved
(kernel/source organization was not as expected by the Makefile,
driver binary was expected in
[ ISDN firmware is available at
the DSP code file
must be renamed to
the driver and the CMV file named
needs to be translated to binary (see References - CMV, above)
For translating CMV files, the
utility must be used. Running it without options, yields:
> ./buildcmv buildcmv [OPTIONS] cmv-src.txt cmv-dst.bin OPTIONS: -i V input cmv text file version 1 for eagle 1,2,3, default 2 for eagle 4 -o V output cmv binary firmware version 1 for ueagle-atm revision < rXXX, default 2 for ueagle-atm revision >= rXXX
To properly translate the CMV file under consideration for Eagle IV, the syntax is:
> ./buildcmv -i 2 -o 2
Both the resulting file
well as the
DSP4i.bin file must be copied
buildcmv utility can be
> gcc buildcmv.c -o buildcmv
will create a shining new copy of this fine utility by Christian Casteyde, Fred. Ros and Matthieu Castet]
The modem is connected directly to the telephone line and a filter is inserted between the line and the telephone. A modem installation guide (with pictures :-) is available here.
The modem is configured by a CMV file. The included default file should work. More information about CMVs can be found in the References – CMV, above. You may safely skip the rest of this section.
If you want to experiment, the driver accepts the following parameters:
debug=0, 1 or 2 (off, on, verbose) altsetting=0,1,... 8 (0=bulk, 1=isoc slowest,... 8=isoc fastest) sync_wait=0 or 1 (wait for synchronization before starting ATM) cmv_file=file name with configuration and management variables annex=0, 1 or 2 (0=auto, 1=annex a (POTS), 2=annex b (ISDN)
The manual invocation of the driver for OTEnet/POTS line (Annex A) could be, for example,
> modprobe ueagle-atm annex=1
You may add
debug=2 to see how
commands are issued to the modem.
Add the following in
/etc/modprobe.conf.local to cater for the automatic
> echo 'options ueagle-atm annex=1' >> /etc/modprobe.conf
[For ISDN (Annex B), the command is
> echo 'options ueagle-atm annex=2' >> /etc/modprobe.conf
Plug in the modem to an available USB port. The modem will be
detected and control passed over to the
driver. The PWR indicator will go out momentarily and will then light
steadily. The ADSL indicator on the modem will start flashing and
then it will light steadily (40-60 seconds).
Following is the relevant output from dmesg (or tail /var/log/messages):
/xxxxxxxxxx/usbatm.c: usbatm_usb_init: driver version 1.10 [ueagle-atm] driver ueagle-svn $Id: ueagle-atm.c 350 2007-05-26 08:52:44Z swg $ loaded usb 1-2: [ueagle-atm] ADSL device founded vid (0X1110) pid (0X9041) Rev (0X3029): Eagle IV usb 1-2: reset full speed USB device using uhci_hcd and address 11 ueagle-atm 1-2:1.0: usbatm_usb_probe: trying driver ueagle-atm with vendor=1110, product=9041, ifnum 0 usb 1-2: [ueagle-atm] using iso mode ueagle-atm 1-2:1.0: usbatm_usb_probe: using 3021 byte buffer for rx channel 0xc865ceb0 ueagle-atm 1-2:1.0: usbatm_usb_probe: using 3392 byte buffer for tx channel 0xc865cefc usb 1-2: [ueagle-atm] (re)booting started usbcore: registered new interface driver ueagle-atm usb 1-2: [ueagle-atm] sending DSP page 0 usb 1-2: [ueagle-atm] ATU-R firmware version : a10050b usb 1-2: [ueagle-atm] sending DSP page 3 usb 1-2: [ueagle-atm] sending DSP page 4 usb 1-2: [ueagle-atm] Modem started, waiting synchronization usb 1-2: [ueagle-atm] sending DSP page 29 usb 1-2: [ueagle-atm] sending DSP page 5 usb 1-2: [ueagle-atm] sending DSP page 34 usb 1-2: [ueagle-atm] sending DSP page 31 usb 1-2: [ueagle-atm] sending DSP page 8 printk: 5000 messages suppressed. ATM dev 0: usbatm_rx_process: status -110 in frame 0 length 0 usb 1-2: [ueagle-atm] sending DSP page 33 usb 1-2: [ueagle-atm] sending DSP page 10 usb 1-2: [ueagle-atm] sending DSP page 11 usb 1-2: [ueagle-atm] sending DSP page 12 usb 1-2: [ueagle-atm] sending DSP page 15 printk: 5000 messages suppressed. ATM dev 0: usbatm_rx_process: status -110 in frame 0 length 0 usb 1-2: [ueagle-atm] sending DSP page 16 usb 1-2: [ueagle-atm] sending DSP page 23 usb 1-2: [ueagle-atm] sending DSP page 20 usb 1-2: [ueagle-atm] sending DSP page 26 usb 1-2: [ueagle-atm] sending DSP page 27 usb 1-2: [ueagle-atm] sending DSP page 25 usb 1-2: [ueagle-atm] modem operational
The modem is ready. You need to activate the connection by running the Point-to-Point Protocol Daemon (pppd) using a console or through a graphics application (e.g. kinternet).
Troubleshooting: If the ADSL indicator alternates between flashing and steady for more than a couple of minutes, it may mean that the driver has gone astray and that you may need to reboot your computer to straighten everything out (no way to unload a driver module gone to lunch). If you look at the messages, you will see a number of reboots:
usb 1-2: [ueagle-atm] (re)booting started
This amounts to copying the example files below, entering your user ID and password at the appropriate places and calling the point-to-point protocol daemon. If you want, you may experiment with the connection settings. Read the pppd manual (man pppd) and/or this brief explanation:
To establish a connection the point-to-point protocol daemon (pppd) is called, with the appropriate options. The options can be passed directly to pppd or read from a number of places: ~/.ppprc, /etc/ppp/options, /etc/ppp/peers/xxxx. In this example, options are read from a file in /etc/peers, called pppoa-otenet. It is important to note that pppd will go through all relevant files to complete its options. In order to make sure that the proper options are selected use dump or dryrun (and read the man page).
The command to invoke the daemon is
> pppd call pppoa-otenet
And the command to properly stop the daemon is
> kill -15 <pppd pid> (SIGTERM – see man 8 pppd)
(or CTRL/C if the daemon is still attached to a terminal – see example below)
When the daemon is invoked it will go through /etc/ppp/peers/pppoa-otenet and, given the chance, through /etc/ppp/options to look for its options. The pppoa-otenet script will establish a PPPoA connection for user email@example.com through 8.35 (VPI.VCI). The authentication method used is PAP (Password Authentication Protocol), which means that the password must be entered in the /etc/ppp/pap-secrets file.
For other systems using CHAP (Challenge Handshake Authentication Protocol), the password must be entered in the /etc/ppp/chap-secrets file, in the same manner. Also, compression negotiation may be disabled if it is not supported by the service provider's server (there are several compression options).
The IP address will be determined by the provider's server. The link will not disconnect and, in case of disconnection, will try to reconnect. The Maximum Transfer Unit (MTU) to be negotiated is set at maximum - 16384 bytes (will most probably be negotiated down to 1500 bytes).
As soon as the connection is initiated, the provider's Domain Name Servers (DNS) will be entered in /etc/ppp/resolv.conf
Following are the necessary /etc/ppp/pap-secrets and /etc/ppp/peers/pppoa-otenet scripts. Lines starting with a number sign (#) are comments. Modify as necessary for your application.
#---------------------------- /etc/ppp/pap-secrets --------------------- #hostname * password firstname.lastname@example.org * password #---------------------------- end of /etc/ppp/pap-secrets --------------- #----------------------- /etc/ppp/peers/pppoa-otenet ------------------ # 070610 dm # Uncomment dump option to see where the options are read from # and how the connection progresses #dump # Use this name to look for a password in the secrets files # User name for peer authentication (if different from name) user email@example.com # (Reference only, do not use) # SuSE uses passwordfd n (password file descriptor) to pass the password #plugin passwordfd.so # Look in /usr/lib/pppd/<pppd version e.g. 2.4.3>/ for pppoatm.so plugin plugin pppoatm.so 8.35 # Add default route to the system routing tables using the peer as gateway defaultroute # Local IP address to be supplied by the peer noipdefault # Disable address/control compression #noaccomp # Disable protocol field compression #nopcomp # Disable CCP (Compression Control Protocol) negotiation #noccp # Disable Van Jacobson style TCP/IP header compression #novj # Do not disconnect if idle idle 0 # Seconds to wait before re-initiating the link holdoff 4 # Try to reopen the connection if it is terminated persist # If it fails many times, however, terminate for good (0 is no limit, default 10) maxfail 20 # Request up to 2 Domain Name Server addresses # These will be passed to /etc/ppp/ip-up script as DNS1 and DNS2 and USEPEERDNS will be set to 1 # An /etc/ppp/resolv.conf file will be created with one or two name server addresses usepeerdns # Attempt to initiate connection, wait for LCP packet if no reply passive # Send LCP echo-request every n seconds to verify connection lcp-echo-interval 5 # If n LCP echo-requests are sent without a valid LCP echo-reply, peer is dead lcp-echo-failure 7 # Do not escape any control characters (for peer) asyncmap 0 # Detach (or not) from the controlling terminal in case of successful connection nodetach #updetach # Don't use IPX protocols noipx # Specify maximum sizes for MTU/MRU (despite the fact that it will eventually settle to 1500) mtu 16384 mru 16384 #----------------------- end of /etc/ppp/peers/pppoa-otenet -----------
Example run with the dump option. Note that /etc/ppp/ip-up and /etc/ppp/ip-down scripts are called on connection establishment and termination:
> pppd call pppoa-otenet Plugin pppoatm.so loaded. PPPoATM plugin_init PPPoATM setdevname_pppoatm - SUCCESS:8.35 pppd options in effect: nodetach # (from /etc/ppp/peers/pppoa-otenet) holdoff 4 # (from /etc/ppp/peers/pppoa-otenet) idle 0 # (from /etc/ppp/peers/pppoa-otenet) persist # (from /etc/ppp/peers/pppoa-otenet) maxfail 20 # (from /etc/ppp/peers/pppoa-otenet) dump # (from /etc/ppp/peers/pppoa-otenet) plugin pppoatm.so # (from /etc/ppp/peers/pppoa-otenet) noauth # (from /etc/ppp/options) user firstname.lastname@example.org # (from /etc/ppp/peers/pppoa-otenet) 8.35 # (from /etc/ppp/peers/pppoa-otenet) 8.35 # (from /etc/ppp/peers/pppoa-otenet) asyncmap 0 # (from /etc/ppp/peers/pppoa-otenet) mru 16384 # (from /etc/ppp/peers/pppoa-otenet) mtu 16384 # (from /etc/ppp/peers/pppoa-otenet) passive # (from /etc/ppp/peers/pppoa-otenet) lcp-echo-failure 7 # (from /etc/ppp/peers/pppoa-otenet) lcp-echo-interval 5 # (from /etc/ppp/peers/pppoa-otenet) noipdefault # (from /etc/ppp/peers/pppoa-otenet) defaultroute # (from /etc/ppp/peers/pppoa-otenet) usepeerdns # (from /etc/ppp/peers/pppoa-otenet) noipx # (from /etc/ppp/peers/pppoa-otenet) Using interface ppp0 Connect: ppp0 <--> 8.35 PAP authentication succeeded local IP address 126.96.36.199 remote IP address 188.8.131.52 primary DNS address 184.108.40.206 secondary DNS address 220.127.116.11
ifconfig at this point (on another terminal) will provide connection-specific information.
<CTRL/C> entered at the terminal where pppd is attached
Terminating on signal 2 Connect time 0.1 minutes. Sent 0 bytes, received 904 bytes. Connection terminated. Script /etc/ppp/ip-down finished (pid 23314), status = 0x0
Matthieu Castet and Benoit Audouard (ueagle-atm development team)
have posted utilities for monitoring the modem status and diagnosing
the modem installation:
ueaglestat and ueaglediag. Both
can be found at
For the command-line minded folk:
> cat /sys/bus/usb/drivers/ueagle-atm/*0/*
Remi Collet has written a script (petit service) that can start, stop and check the connection (see http://remi.collet.free.fr/files/ueagle-atm-1.3). His installation instructions may also prove useful (see References, Installation instructions).
> ueagle-atm-1.3 status ueagle-atm status display ------------------------------------------------------------- Vendor ID : 0x1110 Product ID : 0x9041 Rev: 0x3029(pots) USB Bus : 001 USB Device : 025 Dbg : 0 VID-CPE 0 Tx Rate 0 Kps Rx Rate 0 Kps Tx Atten 31 dB Rx Atten 42 dB Tx Margin 22 dB Rx Margin 22 dB Tx Blocks 0 Rx Blocks 0 Tx FEC 0 Rx FEC 0 Tx Error 0 Rx Error 0 Delin LOSS Flags 0000000010 Modem is operational
Point-to-Point Protocol over Ethernet is a couple of steps away.
Follow through, if you need to utilize this protocol (e.g. Forthnet).
You need to have the
br2684ctl program installed
(part of the
linux-atm package). The following
commands, along with the slightly modified pppd options file will do
> modprobe br2684 > br2684ctl -b -c 0 -e 0 -a 8.35 > ifconfig nas0 up > pppd call pppoe-eagle #----------------------- /etc/ppp/peers/pppoe-ueagle ------------------ # 070610 dm # Uncomment dump option to see where the options are read from # and how the connection progresses #dump # Use this name to look for a password in the secrets files # User name for peer authentication (if different from name) user email@example.com # (Reference only, do not use) # SuSE uses passwordfd n (password file descriptor) to pass the password #plugin passwordfd.so # Look in /usr/lib/pppd/<pppd version e.g. 2.4.3>/ for rp-pppoe.so plugin plugin rp-pppoe.so nas0 # Add default route to the system routing tables using the peer as gateway defaultroute # Local IP address to be supplied by the peer noipdefault # Disable address/control compression #noaccomp # Disable protocol field compression #nopcomp # Disable CCP (Compression Control Protocol) negotiation #noccp # Disable Van Jacobson style TCP/IP header compression #novj # Do not disconnect if idle idle 0 # Seconds to wait before re-initiating the link holdoff 4 # Try to reopen the connection if it is terminated persist # If it fails many times, however, terminate for good (0 is no limit, default 10) maxfail 20 # Request up to 2 Domain Name Server addresses # These will be passed to /etc/ppp/ip-up script as DNS1 and DNS2 and USEPEERDNS will be set to 1 # An /etc/ppp/resolv.conf file will be created with one or two name server addresses usepeerdns # Attempt to initiate connection, wait for LCP packet if no reply passive # Send LCP echo-request every n seconds to verify connection lcp-echo-interval 5 # If n LCP echo-requests are sent without a valid LCP echo-reply, peer is dead lcp-echo-failure 7 # Do not escape any control characters (for peer) asyncmap 0 # Detach (or not) from the controlling terminal in case of successful connection nodetach #updetach # Don't use IPX protocols noipx # Specify maximum sizes for MTU/MRU (despite the fact that it will eventually settle to 1500) mtu 16384 mru 16384 #----------------------- end of /etc/ppp/peers/pppoe-ueagle -----------
And this is a demo, calling the Forthnet provider:
> pppd call pppoe-ueagle Plugin rp-pppoe.so loaded. RP-PPPoE plugin version 3.3 compiled against pppd 2.4.4 pppd options in effect: nodetach # (from /etc/ppp/peers/pppoe-ueagle) holdoff 4 # (from /etc/ppp/peers/pppoe-ueagle) idle 0 # (from /etc/ppp/peers/pppoe-ueagle) persist # (from /etc/ppp/peers/pppoe-ueagle) maxfail 20 # (from /etc/ppp/peers/pppoe-ueagle) dump # (from /etc/ppp/peers/pppoe-ueagle) plugin rp-pppoe.so # (from /etc/ppp/peers/pppoe-ueagle) active-filter xxx # [don't know how to print value] # (from /etc/ppp/filters) noauth # (from /etc/ppp/options) user firstname.lastname@example.org # (from /etc/ppp/peers/pppoe-ueagle) nas0 # (from /etc/ppp/peers/pppoe-ueagle) nas0 # (from /etc/ppp/peers/pppoe-ueagle) asyncmap 0 # (from /etc/ppp/peers/pppoe-ueagle) mru 1492 # (from /etc/ppp/peers/pppoe-ueagle) mtu 1492 # (from /etc/ppp/peers/pppoe-ueagle) passive # (from /etc/ppp/peers/pppoe-ueagle) lcp-echo-failure 7 # (from /etc/ppp/peers/pppoe-ueagle) lcp-echo-interval 5 # (from /etc/ppp/peers/pppoe-ueagle) lcp-restart 2 # (from /etc/ppp/options) lcp-max-configure 60 # (from /etc/ppp/options) noipdefault # (from /etc/ppp/peers/pppoe-ueagle) defaultroute # (from /etc/ppp/peers/pppoe-ueagle) usepeerdns # (from /etc/ppp/peers/pppoe-ueagle) noipx # (from /etc/ppp/peers/pppoe-ueagle) Using interface ppp0 Connect: ppp0 <--> nas0 PAP authentication succeeded peer from calling number 00:99:99:99:99:FF authorized local IP address 18.104.22.168 remote IP address 22.214.171.124 primary DNS address 126.96.36.199 secondary DNS address 188.8.131.52 Script /etc/ppp/ip-up finished (pid 17346), status = 0x0
Don't forget to don a firewall! Happy surfing!
Version 1.2, November 2002
Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
1. APPLICABILITY AND DEFINITIONS
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
2. VERBATIM COPYING
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
3. COPYING IN QUANTITY
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
C. State on the Title page the name of the publisher of the Modified Version, as the publisher.
D. Preserve all the copyright notices of the Document.
E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
H. Include an unaltered copy of this License.
I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
M. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.
N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.
O. Preserve any Warranty Disclaimers.
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
5. COMBINING DOCUMENTS
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements."
6. COLLECTIONS OF DOCUMENTS
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
7. AGGREGATION WITH INDEPENDENT WORKS
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to copy, modify, sublicense or distribute the Document is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
10. FUTURE REVISIONS OF THIS LICENSE
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice
This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.