PCTel HSP MicroModem Configuration mini-HOWTO
Sayamindu Dasgupta
unmadindu_NO_SPAM_@Softhome.net
Jan Stifter
j.stifter_NO_SPAM_@medres.ch
| Revision History | ||
|---|---|---|
| Revision 2.0 | 2002-03-30 | |
| Made changes in the drivers section, other corrections | ||
| Revision History | ||
|---|---|---|
| Revision 1.10 | 2001-12-04 | |
| Cleaning up of sgml by Greg Ferguson, Relicensed under the GFDL, minor corrections | ||
| Revision History | ||
|---|---|---|
| Revision 1.00 | Nov 26th 2001 | |
| First Release | ||
- Table of Contents
- 1. Introduction
- 1.1. Copyright Information
- 1.2. Disclaimer
- 1.3. New Versions
- 1.4. Credits
- 1.5. Feedback
- 1.6. Translations
- 1.7. Conventions used in this document
- 2. Purpose of the mini-HOWTO
- 3. Where to get the drivers
- 4. Choosing a suitable driver
- 5. Compiling and installing the drivers
- 6. Testing the drivers
- 7. A few other points that must be noted.
- 8. FAQ/Troubleshooting
- 9. Appendix
1. Introduction
1.1. Copyright Information
Copyright (c) 2002 Sayamindu Dasgupta, Jan Stifter. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version 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".
1.2. Disclaimer
The methods described in this document might damage your data or your PC or both. The authors will not be responsible for any damage that might arise out of the use of this document. Use this document ENTIRELY at your own risk.
All copyrights are held by their respective owners, unless specifically noted otherwise. Use of a term in this document should not be regarded as affecting the validity of any trademark or service mark.
Naming of particular products or brands should not be seen as endorsements.
You are strongly recommended to take a backup of your system before major installation and backups at regular intervals.
1.3. New Versions
The latest version of this mini-HOWTO will always be made available in my homepage (many thanks to Peaceful Action for hosting my homepage) in a variety of formats:
1.4. Credits
I am extremely grateful to the howtos_NO_SPAM@kcircle.com list members for their support, especially to USM Bish.
The members of the discuss@linmodems.org list have been very helpful too, specially in the initial phase of the howto-writing. I am also extremely grateful to Phil Richard Burchill, Rajesh Fowkar, KV Pham and Andrew Kar (akar) for their valuable suggestions.
The sgml-stuff has been done with the help of the template written by Stein Gjoen, Gregory Leblanc and Greg Ferguson. I am also indebted to Greg Ferguson for cleaning up the mess i had made with Docbook:).
1.5. Feedback
If you have any comments, criticisms, ideas, additions, corrections, then please do mail them to <unmadindu_NO_SPAM_@Softhome.net>. But for technical queries, we suggest that you ask at the discuss@linmodems.org mailing list.
NOTE: Please do not mail me with your problems. You will NOT get any answer. For answers ask at discuss@linmodems.org
1.7. Conventions used in this document
We have used a number of special formatting to indicate warning messages, commands, filenames, computer outputs etc.
- Bash commands
bash$ ls
- Warnings
WARNING
- Filename/Directory
/usr/src/linux/
- Applications
application
- Computer Output
no such file or directory
- Codes/scripts
#! /bin/bash
- Large Computer Outputs
logfile begins
2. Purpose of the mini-HOWTO
The purpose of this document is to guide you to make your PCTel HSP MicroModem work in linux.
First let me explain what is so "special" about these PCTel modems that made me write this guide.These modems fall in a special class of hardware, specifically made for M$-Windows systems, and have device drivers which are specific for M$-Windows ...These modems are also called "Winmodems" and are one of the most troublesome pieces of hardwares for Linux. Most of the winmodems do not work with linux (the manufacturers use patented technologies and so drivers for these modems cannot be developed as Open Source). For a few of these winmodems, drivers have been developed
The PCTel modems belong to this category and fall under linmodems.
NOTE: Though I am referring PCTel modems here, actually PCTel only manufactures the chips for these modems, so if you have say, XXX modem and you get a
00:09.0 Communication controller: PCTel Inc HSP MicroModem 56 (rev 01)
when you issue the bash$ lspci command, then do not worry, you have what we call a PCTel linmodem.
3. Where to get the drivers
Now let me come to the next obvious question, that is; Where are the drivers??
Well, if you are impatient, and if you have a 2.4x series kernel then go to
http://www.medres.ch/~jstifter/pctel/, and if you are stuck with the older 2.2.x kernels, go to http://modems.dewback.cl (the exact link for the file it self is http://modems.dewback.cl/pctel-2.2.tar.gz )
But there are a number of drivers in both the sites, and you will definitely feel confused..so read on.
4. Choosing a suitable driver
The driver version that you will have to use depends on the kernel version you have. To know your kernel version, you will have to issue the command
uname -r
If you see something like 2.2.x, go to http://modems.dewback.cl and download the pctel 2.2x drivers from the PCTel section of that site.
If you see something like 2.4x, go to http://www.medres.ch/~jstifter/pctel/ and download the pctel 0.9.0 (pctel-0.9.0.tar.gz) drivers from that site.
| NOTE: There has been some complaints of system instability while using the pctel 0.9.0 drivers, if you experience problems, then download the pctel 0.8.6 drivers from http://www.medres.ch/~jstifter/pctel/. |
| Also note that only the pctel 0.9.0 drivers have support for the new AMR modems. |
5. Compiling and installing the drivers
The first requisite for installation is that you have a kernel source in /usr/src/linux/ (see section 7.6) and it must be configured, that is, you should have done a bash$ make configure and bash$ make dep on it.
While doing these make sure that you have the source for your running kernel...for example, if you are running kernel 2.4.8 and if you have the source for kernel 2.4.9 in /usr/src/linux/, then the drivers would not work.
Moreover, you must configure the kernel with isapnp and pnp support and see to the fact that you don't have a smp/uniprocessor mismatch ( that is, running uniprocessor kernel but having a kernel source with smp support in /usr/src/linux). Also, you will need a kernel which supports loadable modules.
And of course, you need to have gcc installed, check it by issuing the command bash$ gcc -v . If you do not get any errors, the everything is all right
5.1. Installing the 2.2x drivers.
Login as root.
Make sure that you have a 2.2.x kernel with the command bash$ uname -r
Check whether the downloaded files are in your current directory with the
bash$ ls
command. Then unpack the downloaded files with the command
bash$ tar -xzvf pctel-2.2.tar.gz
Once you have unpacked, you will be left with a ~/pctel directory.
Move into that directory with the command
bash$ cd pctel/
There is an (install.sh) installation script that makes the job easier from now on.
Make this script executable with the command
bash$ chmod +x install.sh
Then, just run the script
bash$ ./install.sh
You will see a number of messages fly by as the appropriate device files/nodes are made in the /dev/ directory, the driver files are unpacked and then compiled and loaded into the memory.
Once the process is complete without any error messages (if you get any errors, proceed to the Troubleshooting section), you will find that a new directory called lib/ has been created under directory ~/pctel/. This ~/pctel/lib/ directory contains the drivers/modules that can be loaded into the kernel.
If you move into the ~/pctel/lib/ directory with
bash$ cd ~/pctel/lib/
and do a bash$ ls, you will find two files there, one called pctel.o and the other ptserial.o
These are the two modules that are to be loaded to make the modem work.
To load the modules, you will have to issue the commands
bash$ insmod pctel.o
bash$ insmod ptserial.o
from the ~/pctel/lib/ directory.
(The install.sh script automatically does this, so you don't need to do the insmod part after running the script, but once you reboot, you will have to load the modules by
bash$ cd `your pctel directory`/lib/
bash$ insmod pctel.o
bash$ insmod ptserial.o )
5.2. Installing the pctel-0.9.0 driver
Make sure that you have kernel 2.4.0 or greater by the command
bash$ uname -r
Unpack the downloaded files with the commands
bash$ tar -xzvf 0.9.0.tar
Now you will have a pctel-0.9.0 directory
cd into that with the command
bash$ cd pctel-0.9.0/
Now comes the complicated part.
To proceed further you will have to know what chip set your modem has.See section 9.4 for more information on this.
Once you have got the name of the chip set, just type one of the following commands (depending on the chip set)
If you have a PCT 789 chip set,
bash$ ./configure --with-hal=pct789
If you have a CM8738 chip set,
bash$ ./configure -with-hal=cm8738
If you have a chip set integrated with an Intel 810 chip set based motherboard from Intel,
bash$ ./configure --with-hal=i810
If you have a chip set integrated in a motherboard from SIS,
bash$ ./configure --with-hal=sis
If you have a chip set integrated with an VIA 686a chip set based motherboard ,
bash$ ./configure --with-hal=via686a
The configure script will run and a number of messages will fly past. Check for any error messages that may fly past. When you have the prompt again, (and if you have not got any errors), compile the drivers with the command
bash$ make
Then if you do not get any error messages, install the drivers with the command
bash$ make install
(You will have to be logged in as root for performing the last step)
Then just load the drivers with the commands
bash$ insmod pctel
bash$ insmod ptserial
NOTE: These commands can be issued from any directory as the insmod program will automatically find the drivers pctel.o and ptserial.o in /lib/modules/`your kernel version`/misc/ )
| NOTE: Please note that the pctel-0.9.0 drivers are comparatively new, and there has been some complaints of lock ups and system unstabilty while using these drivers. If you experience stabilty problems while using these drivers, please, please revert back to the pctel-0.8.6 drivers. However, if you have an AMR modem, then you will have to use the 0.9.0 drivers. |
5.3. Installing the pctel-0.8.6 driver
| Use this driver only if you experience problems with the pctel-0.9.0 drivers |
Make sure that you have kernel 2.4.0 or greater by the command
bash$ uname -r
Unpack the downloaded files with the commands
bash$ tar -xzvf 0.8.6.tar
Now you will have a pctel-0.8.6 directory
cd into that with the command
bash$ cd pctel-0.8.6/
Now comes the complicated part.
To proceed further you will have to know what chip set your modem has.See section 9.4 for more information on this.
Once you have got the name of the chip set, just type one of the following commands (depending on the chip set)
If you have a PCT 789 chip set,
bash$ ./configure --with-hal=pct789
If you have a CM8738 chip set,
bash$ ./configure -with-hal=cm8738
If you have a chip set integrated with an Intel 810 chip set based motherboard from Intel,
bash$ ./configure --with-hal=i810intel
If you have a chip set integrated with an Intel 810 chip set based motherboard from SIS,
bash$ ./configure --with-hal=i810sis
If you have a chip set integrated with an VIA 686a chip set based motherboard ,
bash$ ./configure --with-hal=via686a
The configure script will run and a number of messages will fly past. Check for any error messages that may fly past. When you have the prompt again, (and if you have not got any errors), compile the drivers with the command
bash$ make
Then if you do not get any error messages, install the drivers with the command
bash$ make install
(You will have to be logged in as root for performing the last step)
Then just load the drivers with the commands
bash$ insmod pctel
bash$ insmod ptserial
(these too, like in the case of the pctel-0.9.0 drivers, can be issued from any directory as the insmod program will automatically find the drivers pctel.o and ptserial.o in /lib/modules/`your kernel version`/misc/ )
6. Testing the drivers
There is only one way to check whether the drivers are working or not. You will have to see if your modem is recognized or not. The driver makes a node for your modem at /dev/ttyS15 , no matter what com port it may be in in M$DOS/M$ Windows. /dev/ttyS15 is symlinked to /dev/modem and as most programs search for a modem at /dev/modem first, you will not have to fiddle with the settings/configs of those programs. The program that I use to test my modem in linux is minicom. If you have minicom installed, what you have to do is type
bash$ minicom
in a shell prompt or in a terminal emulator window. If everything is all right, you will see a Initializing modem message for a few seconds and then a screen with a blinking cursor. Just type in ATZ in that screen and hit the enter key. If you see a OK message, then, congratulations, your modem is working in linux. Type in ATI 3 and hit enter and you will see a PCtel HSP56 MicroModem output. If you get a error message, proceed to the troubleshooting section. If everything is all right up to now, you can go ahead to configure your dialer software and connect to the internet.
7. A few other points that must be noted.
Here are a few more points you might find to be of interest/useful.
7.1. Loading the modules at automatically
Well, if you have the pctel.o and ptserial.o files in /lib/modules/`your kernel version`/misc/ , you can just add these lines to your /etc/modules.conf file
# for pctel modem alias char-major-62 ptserial below ptserial pctel # country code for pctel modem options ptserial country_code=1 |
Run
bash$ depmod -a
after modifying your /etc/modules.conf .
In this case, running ppp would automatically load these modules. You can also write up some shell-script and put them in your /usr/bin/ directory (I have a sample of such a script in the appendix section)
7.2. Country codes
The ptserial.o driver also lets you specify the country code, though for most situations, the default of USA is all right. If you still want to specify the country code, load the ptserial.o module with the command
bash$ insmod ptserial country_code=x
(where x is the country code you want) The list of country codes with the corresponding country names is listed below.
country_code country name 1 USA 2 FRANCE 3 GERMANY 4 ITALY 5 SWEDEN 6 UK 7 JAPAN 8 AUSTRALIA 9 SPAIN 10 TAIWAN 11 SINGAPORE 12 KOREA 13 SWITZERLAND 14 NORWAY 15 NETHERLANDS 16 BELGIUM 17 CANADA 18 IRELAND 19 PORTUGAL 20 POLAND 21 HUNGARY 22 FINLAND 23 DENMARK 24 AUSTRIA 25 S.AFRICA 26 CTR21 COUNTRIES 27 CHINA 28 MALAYSIA 29 LUXUMBURG 30 GREECE 31 ICELAND 32 NEW ZEALAND 33 BRAZIL |
7.3. Other options while loading the modules.
The other options that you may want to use while loading ptserial.o are:
For all HALs :
- irq: Force to using irq #.
- iobase: Force to use iobase for modem detection.
Only for I810/VAI686A HALs:
- iobase1: Force the iobase 1
NOTE: if you want to set iobase or iobase1, you should use
irq/iobase/iobase1 at same time.
Only for CM8738/PCT789 HALs:
- vendor_id: vendor ID of the modem
- device_id: device ID of the modem.
NOTE: vendor_id and device_id should be used at the same time,
but you cannot combinate this two options with
iobase, iobase prevail to (vendor/device)_id detection.
7.4. The sequence of loading/unloading the modules.
When you load the modules, you must load the pctel.o module at first
bash$ insmod pctel
and then the ptserial.o
bash$ insmod ptserial
While unloading, the sequence is reversed,
bash$ rmmod ptserial
bash$ rmmod pctel
7.5. Bugs in the pctel-0.9.0 and the 0.8.6 versions.
> There is a serious bug in the drivers for the kernel 2.4x The modem often seems to stop working/hang while dialing out, and you get nothing but a beeeeeeeeee... sound from the modem speaker and later, the dialer gives a message No Carrier and disconnects.
This problem has no real workaround , but sometimes unloading and reloading of the modules work. For that the commands will be (assuming that you have the modules in /lib/modules/'your kernel version`/misc/ )
bash$ rmmod ptserial
bash$ rmmod pctel
bash$ insmod pctel
bash$ insmod ptserial
NOTE:You must exit from your dialer before trying to unload the drivers, otherwise you will get a device or resource busy error.
When the problems become too acute, the only solution seems to be rebooting.
It has been also noticed that sometimes, this problem is ISP dependent, with the problem surfacing when using a particular ISP.
7.6. Directory of the kernel source files
> If you get an error saying /usr/src/linux/include/linux/modversions.h : no such file or directory, look in your /usr/src directory for the kernel source. The default location is /usr/src/linux/ but some distributions may install the files somewhere else.
If you find that the files are somewhere else, say in the directory, /usr/src/myspecialsource/ , do not try to move the files, just create a symbolic link with the command
bash$ ln -s /usr/src/myspecialdirectory/ /usr/src/linux/
NOTE: In case of the PCTel-0.8.6 drivers you can also specify the location of your kernel source by using the option
bash$ --with-kernel-includes=your kernel source directory
during running the configure script.
7.7. PnP BIOS issues
As most computers are designed for M$-Windows operating systems, the BIOS of the computer assumes that you have a what it calls a "PnP OS installed". This may cause trouble with these types of modems in linux (specially if you have resource conflicts) and so the best bet is to change the option "PnP OS installed" to "No". To do these, you have to perform the following steps:
During startup, when you see "Memory Test" messages, CPU information, BIOS information, just press the DEL key (if that does not work, usually one of the Function (Fx) keys work..check your manual).
You will be presented with the BIOS configuration menu. Enter the "PNP/PCI Configuration" section and set the option for "PNP OS Installed" to "NO". Save the changes you have made, and then reboot.
NOTE: This is not applicable to all BIOSs, and you are advised to consult your PC documentation if you have a different kind of BIOS configuration menu.
7.8. AMR modems
There are certain PCTel chip set based internal modems that go into AMR slots instead of the normal PCI slots. They are usually identified as HSP MR by the bash$ lspci command. These modems are supported by the pctel-0.9.0 drivers only.
8. FAQ/Troubleshooting
Here is a set of common problems that you may face, along with their possible solutions.
8.1. Compiling Problems
- 8.1.1. I get a /usr/src/linux/include/linux/modversions.h : no such file or directory
- 8.1.2. I get a permission denied error while running bash$ make install
You need to have your kernel source installed under /usr/src/linux/
If you have the kernel source installed somewhere else, just make the appropriate symlink. (see section 7.6 for more information) If you have that installed under /usr/src/linux/ , run
bash$ make config
bash$ make dep
in /usr/src/linux/
You need to be logged in as root while doing bash$ make install
8.2. Problems while loading the modules.
- 8.2.1. I get unresolved symbols.... messages while loading the modules
- 8.2.2. I get an Operation not permitted error while trying to load the drivers
Firstly, check that you are loading ptserial.o only after loading pctel.o.
If that does not solve the problem, then probably you have compiled your modules for the wrong kernel version. Check your kernel version with the command
bash$ uname -r
and then verify if you have the right files in /usr/src/linux .
Moreover, if you have a running kernel for a uniprocessor machine and have kernel source in /usr/src/linux/ that is configured for smp support, then you will get unresolved symbols. A method to check whether you have a smp supporting source is by running bash$ make menuconfig in /usr/src/linux/ and seeing whether smp support is selected.
Another way to get rid of the unresolved symbols problem is to use the fixscript package from http://www.medres.ch/~jstifter/pctel/fixscript.gz
The procedure is to:
Unpack the downloaded file with
bash$ gzip -d fixscript.gz
Make it executable with
bash$ chmod +x fixscript
Run it with
bash$ ./fixscript old_module.o new_module.o
This will create the new module, which you can try to load with
bash$ insmod new_module.o
If fixscript reports an error like
objcopy: --redefine-sym: Symbol x is target of more than one redefinition
then, fixscript can not help you.
The best method is of course, to fix your kernel source and recompile the drivers.
Make sure that you do a
bash$ make clean
before recompiling.
You will have to be logged in as root to load the drivers, otherwise, you can also type in the
bash$ su
command and then load the drivers.
8.3. General modem based problems.
- 8.3.1. I get a /dev/modem no such device error.
- 8.3.2. My dialer gives a No Carrier error
- 8.3.3. I get a No Dialtone message.
- 8.3.4. I get a Modem Busy error.
First of all, check if you really have the drivers loaded. You can do this by the command
bash$ lsmod
This command lists all the modules that you have loaded, and if you see something like
Module Size Used by ptserial 47472 0 (unused) pctel 1211808 0 [ptserial] |
then, the modules are correctly loaded.
If not, just load them and retry.
Also check whether the file /dev/modem is symlinked to /dev/ttyS15
Remember, even if msdos or Microsoft Windows tells you that the modem is in com 3 or com 4, in linux the driver makes it appear in /dev/ttyS15 (the Microsoft equivalent of which will be com 16!!)
If you are in doubt, I suggest that you re-create the device files by the commands
bash$ rmmod ptserial
bash$ rmmod pctel
bash$ rm /dev/ttyS15 /dev/modem
bash$ mknod /dev/ttyS15 c 62 79
NOTE: the numbers after /devttyS15 are distribution specific, and the c 62 79 works for Red Hat Linux. If you have any other distribution, please check your documentations.
bash$ chgrp uucp /dev/ttyS15
bash$ chmod 666 /dev/ttyS15
bash$ ln -s /dev/ttyS15 /dev/modem
This is a bug with the drivers for the kernel 2.4x series
Refer to section 7.5 for more information.
This is usually solved by adding ATX3 to your modem init strings.
First of all, check if the drivers are loaded or not and then see, if any program is using the modem. If everything seems to be all right, try to find out the irq of your modem with the command
bash$ lspci -v
If the irq listed is obviously incorrect (like 0) (or does not tally with your M$-Windows configuration) then either use the setserial command
bash$ setserial /dev/ttyS15 irq * (where * is the irq of your modem)
or fiddle with the BIOS settings (see section 7.7)
8.4. I have a problem that is not listed in this section. What do I do?
The output of the command
bash$ tail /var/log/messages
will give you a lot of information if anything goes wrong The normal output should be something like this
PCTel device[00:09.0](0x48) found "PCTel Inc HSP MicroModem 56 (rev 01)", iobase=0xe400, irq=12. PCTel driver version 0.9.0 [5.05c-4.27.215 (09-14-2001)] (PCT789) (2002-01-31) with MANY_PORTS SHARE_IRQ SERIAL_PCI enabled. PCTel driver built on [Linux 2.4.18 i686 unknown "2.4.18 <132114>"] with gcc-2.96. ttyS15 at 0xe400 (irq = 12) is a PCTel |
Mail the output you get to the <discuss@linmodems.org> list( more on this in section 9.2.2), and wait for a reply.
9. Appendix
9.1. A sample script file to load the modules.
#! /bin/bash /sbin/insmod /lib/modules/`uname -r`/misc/pctel.o /sbin/insmod /lib/modules/`uname -r`/misc/ptserial.o # end file |
You can save this file as modemon and then isuue the commands
bash$ chmod 700 modemon
bash$ cp modemon /usr/bin/modemon
Now, whenever you type in the command bash$ modemon , the modules will get loaded automatically
9.2. Web Resources
There are a number of websites, mailing lists that may help you while you try to configure your modem.
9.2.1. Web sites
The unofficial pctel linux driver site at http://www.medres.ch/~jstifter/pctel/
The linmodem site (the mother page of all linmodem projets) at http://www.linmodems.org
A huge lists of lin/winmodems at http://www.idir.net/~gromitkc/winmodem.html
A list of AT commands from PCTel at http://www.pctel.com/atcommands_dev.htm
The linmodem-howto is available at http://www.linuxdoc.org/HOWTO/Linmodem-HOWTO.html.
9.2.2. Mailing lists
The most important mailing list for linmodems is
You can subscribe to that list by going to
http://www.linmodems.org or by sending a blank e-mail to <discuss-subscribe@linmodems.org> .
9.3. Other drivers that are available
I have seen a number of modem manufacturers (Dax, Zoltrix, Lectron, Tiacom etc) providing linux drivers for their modems that have PCTel chip sets.
Actually most (if not all) of these drivers are slightly modified form of the drivers at Jan's and the modems.dewback.cl site, and so, in most cases, there is no point in downloading them.
Moreover, in the early days of 2.4x kernels, Thomas Wright had made a PCTel driver and you can find it in his website at http://www.geocities.com/tom_in_rc/.
9.4. Identifying the chip set of the modem
Well, the best way to identify the chip set of your modem is to open up the cabinet of the machine., gently pull out the modem from it's slot (only if it is not integrated into your motherboard), and see the name printed on the black chip on the modem. (be very very careful while doing these, and make sure that all power supplies to the system is disconnected, and touch the ground/a metallic surface before handling any of the circuitry/wires in the machine). But sometimes, this is not possible and so you will have to adopt other methods.
The next best method is to run the command
bash$ lspci -n
This command will give you the numeric PCI id of your modem (you may have to run bash$ lspci to crosscheck the device id) and you will have to submit the number at http://www.yourvote.com/pci/ Here you may or may not get the exact name of the chip set you have.
If you do not get the name, you can go through the database at http://www.idir.net/~gromitkc/winmodem.html#drivers and search for an entry on your modem.
You can also ask at the local LUGs or ask your friends or even (a bad way, no doubt), ask the support personnel of your modem manufacturer.
9.5. GNU Free Documentation License
Version 1.1, March 2000
Copyright (C) 2000 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
0. PREAMBLE
The purpose of this License is to make a manual, textbook, or other written 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 that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you".
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. (For example, 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.
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 "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, whose contents can be viewed and edited directly and 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 has been designed to thwart or discourage subsequent modification by readers is not Transparent. 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 designed for human modification. Opaque formats include PostScript, PDF, 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 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.
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 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 publicly-accessible computer-network location containing a complete Transparent copy of the Document, free of added material, which the general network-using public has access to download anonymously at no charge using public-standard network protocols. 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.
4. MODIFICATIONS
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:
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.
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 less than five).
State on the Title page the name of the publisher of the Modified Version, as the publisher.
Preserve all the copyright notices of the Document.
Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
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.
Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice.
Include an unaltered copy of this License.
Preserve the section entitled "History", and 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.
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.
In any section entitled "Acknowledgements" or "Dedications", preserve the section's title, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
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.
Delete any section entitled "Endorsements". Such a section may not be included in the Modified Version.
Do not retitle any existing section as "Endorsements" or to conflict in title with any Invariant Section.
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.
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, does not as a whole count as a Modified Version of the Document, provided no compilation copyright is claimed for the compilation. Such a compilation is called an "aggregate", and this License does not apply to the other self-contained works thus compiled with the Document, on account of their being thus compiled, if they 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 quarter of the entire aggregate, the Document's Cover Texts may be placed on covers that surround only the Document within the aggregate. Otherwise they must appear on covers around the whole aggregate.
8. TRANSLATION
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 provided that you also include the original English version of this License. In case of a disagreement between the translation and the original English version of this License, the original English version will prevail.
9. TERMINATION
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.