LDP/LDP/howto/docbook/Motorola-Surfboard-Modem.xml

<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<article id="Motorola-Surfboard-Modem">

<!-- - - - - - - - - - - - -  H e a d e r - - - - - - - - - - - - - -  -->

<articleinfo>

<!-- - - - - - - - - - - - -   T i t l e  - - - - - - - - - - - - - -  -->

<title>Motorola Surfboard 4100 + 4200 Series USB Cable Modem mini-HOWTO</title>
<author><firstname>Howard</firstname>
	<surname>Shane</surname>
	<affiliation>
		<address>
			<email>hshane[AT]austin.rr.com</email>
		</address>
	</affiliation>
</author>


<!--  - - - - - - - - - -  R e v i s i o n  H i s t o r y  - - - - - -  -->


<revhistory id="revhistory">
	<revision>
         <revnumber>1.0</revnumber>
         <date>2003-05-15</date>
         <authorinitials>tmm</authorinitials>
         <revremark>Initial release, reviewed by LDP</revremark>
      	</revision>

<!--  - - - - - - - - - E a r l i e r  R e v i s i o n  - - - - - -  -->

      <revision>
         <revnumber>0.02</revnumber>
         <date>2003-04-10</date>
         <authorinitials>jhs</authorinitials>
          <revremark>Completed draft.</revremark>
      </revision>
</revhistory>


<!-- - - - - - - - - - - - -  A b s t r a c t  - - - - - - - - - - - - - -->


<abstract>
	
<para>
This document was written to assist the Linux user in setting up the
Motorola Surfboard 4000 series of cable modems. 
</para>
</abstract>

</articleinfo>


<!-- - - - - - - - - -  H e a d e r  E n d  - - - - - - - - - - - - - -  -->
<!-- - - - - - - - - - -  S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect1 id="intro">
<title>Introduction</title>
<indexterm><primary>>disk!introduction</primary></indexterm>

<para>
This document was written to assist the Linux user in setting up the
Motorola Surfboard 4100 and 4200 series cable modems, and includes information on configuring
a DHCP client, enabling the device with or without USB support and troubleshooting.
</para>
<indexterm>
	<primary>Surfboard</primary>
	<secondary>Motorola</secondary>
</indexterm>

<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect2 id="copyright">
<title>Copyright Information</title>

<para>
This document is Copyright 2003 by Howard Shane.
</para>
<para>
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or 
any later version published by the Free Software Foundation with no Invariant
Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license
can be found in <xref linkend="appendix"/>.  
</para>
</sect2>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect2 id="disclaimer">
<title>Disclaimer</title>

<para>
No liability for the contents of this document can be accepted.
Use the concepts, examples and other content entirely at your own risk.
As this is a new edition, there may be technical or other inaccuracies that
may result in the loss of irreplaceable data. In any case, proceed with caution, and realize that although errors are highly unlikely, the author can accept no responsibility for them.
</para>

<para>
All copyrights are held by their 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.
</para>

<para>
Naming of particular products or brands should not be seen 
as endorsements.
</para>

</sect2>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect2 id="newversions">
<title>New Versions</title>
	<indexterm>
	<primary>(your index root)!news on</primary>
	</indexterm>

<para>
This is the initial release.
</para>

<para>
The latest version number of this document can be found <ulink url="http://www.hshanemd.net/docs/HOWTOS/SurfBoard/">here</ulink>.
</para>
</sect2>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect2 id="credits">
<title>Credits</title>

<para>
I would like to thank Brad Hards, the primary author of the Linux CDCEther kernel driver for graciously volunteering several useful bits of information.
</para>

<para>
Also, I would like to thank Marla, who has cheerily tolerated the time I've spent sifting through documentation and endless typing while completing this and other projects. Without you I'm lost.
</para>
</sect2>

<sect2 id="feedback">
<title>Feedback</title>
<para>
Please send any additions or comments pertaining to this document to the following email address: <email>hshane[AT]austin.rr.com</email>. If you have an earlier (e.g., 3000 series) or later (e.g. 5000) series Surfboard and have it working in linux, please contact me with any model-specific setup information so we can update this document!
</para>
</sect2>

<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect2 id="conventions">
<title>Conventions Used in this Document</title>

<para>
The following conventions are used in this document and are outlined here for those who may not yet have a complete understanding of how to access and control the underlying operating system in Linux, which is almost always the bash shell.
</para>

<para>
First, filenames are referenced in a paragraph like so: <filename>/path/file</filename>
</para>

<para>
Commands in Linux are executed (or 'called') at the command prompt, otherwise known as the 'command line.' If you are in the non-graphical (text-based) environment you will usually be presented the bash shell prompt which is a dollar sign: 
</para>

<para>
<screen>$</screen>
</para>

<para>
...or the hash mark: 
</para>

<para>
<screen>#</screen>
</para>

<para>
...if you have logged in as root or have acquired root, or 'superuser' privileges. You can also access the bash shell in the X window system, otherwise known as X or X11, with an <ulink url="http://invisible-island.net/xterm/">xterm</ulink> or similar X-terminal-emulator. Commands to be performed at the bash prompt, but referenced in a paragraph of this document, usually look like this: <command>do this now</command>
</para>

<para>
Commands and/or the resulting output of commands may also be outlined with screen output in their own paragraph or heading:
</para>

<para>
<screen>$ date
Sun Jul 27 22:37:11 CDT 2003</screen>
</para>

<para>When a command is written in front of the bash prompt (e.g. <command>$ date</command> above), it is assumed the [Return] or [Enter] key has been depressed after the command, possibly followed by the output on a new line (e.g., as in the date in the above example).
</para>
 </sect2>
</sect1>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect1 id="prerequisites">
<title>Prerequisites</title>
<sect2 id="networking">
	<title>Networking and Operating System Support</title>

<para>
The Motorola Surfboard 4100 and 4200 Cable Modem series are common devices provided by cable Internet services. They are easily configurable for use under Linux. For more information about the device not related to Linux configuration, please see the manufacturer's website <ulink url="http://broadband.motorola.com/noflash/surfboard.html">here.</ulink>
</para>

<para>
There are two requirements for using a Motorola Surfboard 4100 and 4200 series USB cable modem (hereafter referred to as a 'Surfboard'). The first is the appropriate networking support for the device in your kernel; note that most base installs of Linux distributions come TCP/IP and ethernet enabled 'out of the box,' so there is probably very little most readers will need to do other than be sure their ethernet card is working. If you know that your ethernet card is supported and working you can move on to <xref linkend="modem"/>. For those who like to compile their own kernels (see the <ulink url="http://www.tldp.org/HOWTO/Kernel-HOWTO.html">Kernel HOWTO</ulink> for more information), the following options are required to get the cable modem to work: 
</para>

<para>
Under 'Networking options':
<itemizedlist>
	<listitem>

	<para>
	TCP/IP Networking
	</para>
	</listitem>
</itemizedlist>
</para>
<para>along with ONE of the following: 
<itemizedlist>
	<listitem>
	
	<para>
	Network Device Support: Ethernet (10 or 100Mbit) Support and your ethernet card driver
	</para>
	</listitem>
	<listitem>
	
	<para>
	USB Support + USB CDCEther driver support 
	</para>
	</listitem>
</itemizedlist>
</para>

<para>
PPP support is not required per se, as the modem is itself a PPP link.
</para>
<para>
Note that there are two possible interfaces on the modem to connect your computer. One is through ethernet and is probably the default a cable provider will attempt to use when setting up the Surfboard. The other is to use the USB interface. The former of these is arguably easiest; the only requirements other than the above is that you have an ethernet card installed which is open, i.e. that you can connect to the modem ethernet jack using ordinary 10BaseT/100BaseT ethernet cable. If you are uncertain about anything in the last sentence I recommend you read the <ulink url="http://www.tldp.org/HOWTO/Ethernet-HOWTO.html">Ethernet HOWTO</ulink> for proper configuration of your ethernet card. 
</para>

<para>I have used my own 4100 model with each interface, and at least on my system there seems to be little difference in performance using an ethernet card or the USB port. The drawback of the ethernet method is that your network card will be tied up.
</para>
</sect2>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect2 id="modem">
<title>The Modem Device</title>
<para> First, plug in and turn on the Surfboard. Connect your ethernet card to the Surfboard with 10BaseT/100BaseT cable into the non-USB interface, if this was not already done for you. Be sure the modem isn't on standby mode by checking the LEDs; you should see some dancing green lights to confirm this. The standby button is on the top of the device on most models. Your cable internet provider should be able to tell remotely whether your modem is connected and functioning properly, which is helpful for differentiating between hardware and configuration problems on your end. They will also need the MAC (Media Access Control) hardware address of your modem to allow the device access to their network. If at any time you substitute one modem for another you will need to inform them so the MAC address can be updated and your access to the cable network restored.
</para>
<para> Once you connect for the first time, your modem will be assigned an IP address, which may remain the same or change periodically depending on the IP address turnover of your ISP's DHCP server, and how long you remain offline if you disconnect.  Should the IP address provided to the modem by your ISP ever have to be released, for whatever reason, you can do this by resetting the device. This involves inserting the tip of a sharp pencil or a pin into the small orifice on the input face. The only time this may be necessary is if you are having trouble with your connection and you are instructed to try this maneuver by your ISP's technical support staff. Only do this if you know what you're doing or are directed to do so by your ISP, as it's generally not a good idea to go around sticking metal objects into the various openings of electrical devices.
</para>
</sect2>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect2 id="DHCP">   
<title>The DHCP Client</title>
<sect3 id="DHCP-deb">
<title>Installation on a Debian System</title>

<para>
The Surfboard works fine out of the box under Debian once you
have installed and started the DHCP client package. As of this writing there are two user-space programs for this. In Woody (stable), there is the dhcp-client package, automatically installed as a part of the base packages as <filename>/sbin/dhclient</filename>. For Sarge (testing) and up, this has been replaced by the dhcpcd package. The latter has its configuration files under <filename>/etc/dhcpc</filename>, but nothing really needs to be modified if you are setting up only one ethernet card for the cable internet service.  The dhcpcd daemon is easily installed for those using testing branch as root, with <command>apt-get install dhcpcd </command>.
</para>
</sect3>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect3 id="DHCP-rpm">
<title>Installing on .rpm- or .tgz-Based Systems</title> 

<para>
For .rpm- or .tgz-based distributions, I offer the following link that walks you through the setup of a DHCP client, in the <ulink url="http://www.tldp.org/HOWTO/mini/DHCP/x74.html">DHCP mini-HOWTO</ulink>.
</para>

<para>
Just run <command> /sbin/dhclient </command> or whichever client you use to get a dynamic IP address.
</para>
</sect3>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect3 id="configuration">
<title>Checking your Configuration</title>

<para>
Once you are plugged into the system you are provided your own IP address,
which doesn't change unless you drop the lease (i.e. go offline) for a while. To confirm that the DHCP client is working and you have a new IP address, execute (as root) <command>ifconfig</command> without any other arguments, and you should see the following:
</para>

<para>
<screen>eth0	Link encap:Ethernet  HWaddr 00:D0:09:DE:D4:6F  
 	inet addr:66.190.XXX.XXX  Bcast:255.255.255.255  Mask:255.255.255.0
 	UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
	RX packets:2591777 errors:0 dropped:0 overruns:0 frame:0
 	TX packets:5589 errors:0 dropped:0 overruns:0 carrier:0
 	collisions:0 txqueuelen:100 
 	RX bytes:168673636 (160.8 MiB)  TX bytes:1752872 (1.6 MiB)
 	Interrupt:12 Base address:0xc400 
</screen>
</para>

<para>
<screen>lo	Link encap:Local Loopback  
	inet addr:127.0.0.1  Mask:255.0.0.0
	UP LOOPBACK RUNNING  MTU:16436  Metric:1
	RX packets:5168 errors:0 dropped:0 overruns:0 frame:0
	TX packets:5168 errors:0 dropped:0 overruns:0 carrier:0
	collisions:0 txqueuelen:0 
	RX bytes:1695104 (1.6 MiB)  TX bytes:1695104 (1.6 MiB)
</screen>
</para>

<para>
...which shows the system loopback device, <filename>/dev/lo</filename>, and also <filename>/dev/eth0</filename>, your ethernet card and the Surfboard, having successfully acquired an IP address (or 'inet addr') provided by the cable internet service provider.</para>
</sect3>
</sect2>
</sect1>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect1 id="usb">
<title>Using the USB interface instead of an ethernet card</title>


<!-- - - - - - - - - - -  S u b s e c t i o n  - - - - - - - - - - - - - -  -->


<sect2> 
<title>USB CDCEther</title>

<para>
If you wish to use the USB interface to accept data you will need USB subsystem support in your kernel, whether USB-ohci, USB-ehci, or whichever USB host controller driver type your system prefers. For a more in-depth discussion of this, I direct you to the <ulink url="http://www.linux-usb.org/">Linux-USB project site</ulink>.
</para>

<para>
Assuming you have USB subsystem support, to find out if your kernel supports the CDCEther (Communications Device Class Ethernet) driver as a module, in a shell, issue the command <command>lsmod</command> as root.
</para>

<para>
You should see output similar to the following, though a number of entries have been edited, and you shouldn't worry too much if you don't see the exact entries displayed here:
</para>

<para>
<screen>
CDCEther               11040   0  (unused)
usb-ohci               17888   0  (unused)
usbcore                56768   1  [scanner CDCEther usb-ohci]
</screen>
</para>

<para>
If you don't see CDCEther listed among the modules try loading the module directly:
</para>  

<para>
<screen> #  modprobe CDCEther </screen>
</para>

<para>
If all goes well you should see the following message in your system log files, or with <command>dmesg</command>:
</para>  

<para>
<screen>
Mar  2 11:00:52 K7 kernel: CDCEther.c: 0.98.6 7 Jan 2002 Brad Hards and another
Mar  2 11:00:52 K7 kernel: usb.c: registered new driver CDCEther
</screen>
</para>

<para>
If you don't have it compiled as a module, check the output of <command>dmesg </command> (you may need to pipe it through 'less' or 'more' like so: <command>dmesg | less</command>); if the driver loads as a module you will see a message similar to the above at boo- up. If not, and you want to use the USB conduit of this device, you will need to recompile your kernel to support it. You will need the 2.4.3 kernel or later. For detailed instructions on recompiling your kernel, I direct you to <ulink url="http://www.tldp.org/HOWTO/Kernel-HOWTO.html">the Kernel-HOWTO</ulink>. The options shown next will need to be selected. As an aside, you should be aware that compiling things as modules, rather than statically within the kernel, gives you a greater degree of control and greatly simplifies troubleshooting.
</para>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect3 id="kernel">
<title>Kernel Requirements</title>

<para>
In addition to the 'TCP/IP networking' listed in <xref linkend="prerequisites"/>, the following should be compiled in your kernel in the 'USB support' menu (assuming you are using <command>menuconfig</command>):</para>
<para>
<itemizedlist>
	<listitem>

	<para>
	USB support
	</para>
	</listitem>
	<listitem>
	
	<para>
	USB Communication Class Ethernet device support
	</para>
	</listitem>       
</itemizedlist>
</para>
</sect3>

<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect3 id="device-iface">
<title>Grabbing the Correct Interface</title>

<para> 
Now we have to select the correct ethernet interface (<filename>/dev/ethX</filename>) to be the receipient of the DHCP service. If you run <command>ifconfig</command> as root you get a list of open devices:
</para>

<para>
<screen>eth0 Link encap:Ethernet HWaddr 00:D0:09:DE:D4:6F
	inet addr:192.168.1.1
	Bcast:192.168.1.255 Mask:255.255.255.0
	BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
	RX packets:0 errors:0 dropped:0 overruns:0 frame:0
	TX packets:0 errors:0 dropped:0 overruns:0 carrier:0 
	collisions:0 txqueuelen:100
	RX bytes:0 (0.0 b) TX bytes:0 (0.0 b) Interrupt:12 Base address:0xc400
</screen>
</para>

<para>
<screen>lo Link encap:Local Loopback
	inet addr:127.0.0.1 Mask:255.0.0.0
	UP LOOPBACK RUNNING MTU:16436 Metric:1
	RX packets:5168 errors:0 dropped:0 overruns:0 frame:0
	TX packets:5168 errors:0 dropped:0 overruns:0 carrier:0
	collisions:0 txqueuelen:0 
	RX bytes:1695104 (1.6 MiB)  TX bytes:1695104 (1.6 MiB)
</screen>
</para>

<para>...where eth0 is a standard NIC, pre-configured to the IP address 192.168.1.1.
</para>

<para>
Note the HWaddr field, or hardware address, on the first line. This is the same as the MAC, or Media Access Control address, and is how we will specify the interface for each action. If you are running a Debian system, you can alter the <filename>/etc/network/interfaces</filename> file to look like this:
</para>

<para>
<screen>
	# /etc/network/interfaces -- configuration file for ifup(8), ifdown(8)
	# The loopback interface
	auto lo
	iface lo inet loopback
	auto eth0
 	iface eth0 inet static
	address 192.168.1.1
	netmask 255.255.255.0
	network 192.168.1.0
	hwaddress ether 00:D0:09:DE:D4:6F
	
	auto eth1
	iface eth1 inet dhcp
	hwaddress ether 00:04:BD:DE:42:0B
</screen>
</para>

<para>
The <command>auto eth0</command> and <command>auto eth1</command> are required to have the interfaces configured at bootup. Note that some versions of dhcp clients by default always grab eth0 for the dhcpc interface.
So even after doing all the above, unless you specifically run <command>/sbin/dhcpcd-bin eth1</command>
it won't work. The easy way to do this at boot-up is to make an init script to load the dhcp address to the correct interface. For most distributions, such a script is in <filename class="directory">/etc/rc.d</filename> or a similar location. If you have an <filename>rc.local</filename> script, as in Slackware, you can simply add <command>/sbin/dhclient</command> to the end of the file. If you have a model rc.d script (such as <filename>/etc/init.d/skeleton</filename> in Debian) you can convert that to such a purpose. Whatever the case (either at the command line manually or appended to an init script), the command to run is as follows:
</para>

<para>
<screen># ifconfig ethX hw ether 00:D0:09:DE:D4:6F up </screen></para>
<para>You can confirm it worked by calling <command>ifconfig</command> without options after your next reboot.
</para>

</sect3>
</sect2>
</sect1>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<sect1 id="troubleshooting">
<title>Troubleshooting</title>

<para>
Q: I get kicked offline about once every 4 days, for no apparent reason, and get the following error, or something similar, in the kernel log: 
</para>

<para>
<screen>
Feb 20 10:05:12 K7 kernel: CDCEther.c: rx status -110
Feb 20 10:05:12 K7 kernel: CDCEther.c: no repsonse in BULK IN
Feb 20 10:05:12 K7 kernel: CDCEther.c: rx status -110
Feb 20 10:05:12 K7 kernel: CDCEther.c: no repsonse in BULK IN
Feb 20 10:05:12 K7 kernel: CDCEther.c: rx status -110
Feb 20 10:05:12 K7 kernel: CDCEther.c: no repsonse in BULK IN
Feb 20 10:05:12 K7 kernel: CDCEther.c: rx status -110
</screen>
</para>

<para>
A: There are a number of reasons this may be happening, and future updates to the CDCEther driver may solve some of them. A user on the Linux-USB-user mailing list noticed that on at least one occasion data sent to the modem from upstream by the cable provider has triggered it. Also, the modem itself is very sensitive to power interruptions and can lose the connection if this occurs. The fix is to run <command> ifdown ethX</command>, where <emphasis>ethX</emphasis> is the ethernet interface (eth0, eth1 etc.) to clear out any remaining settings that are hung, then remove the module with <command> rmmod CDCEther</command>, reinsert the CDCEther module and then <command>ifup ethX </command>. A reboot may be necessary if this doesn't fix the problem. If none of these work you probably have a real service interruption.
</para>

<para>
Q: I get the following messages on boot-up; are they errors?
</para>

<para>
<screen>
Can't use SetEthernetMulticastFilters request
Mar  2 11:00:52 K7 kernel: CDCEther.c: Ethernet information found at
device configuration.  Trying to use it anyway.
Mar  2 11:00:52 K7 kernel: CDCEther.c: Imperfect filtering support -
need sw hashing
</screen>
</para>

<para>
A: No. The multicast message is pertaining to Multicast support in the kernel, which is optional and not necessary for the proper functioning of this modem. The message about 'Ethernet Information' is a design bug in the modem and can be ignored. As for the 'Imperfect filtering support,' to quote Brad Hards:
</para>

<para>
<quote>
This is a bit difficult to explain - I assume that you know what multicasting is - when you join a multicast group, this can be handled by the networking device so that other multicast traffic doesn't cause interrupts. That is called 'perfect filtering.' However sometimes the number of multicast addresses exceeds the number of filters that you have. This leads to 'imperfect filtering,' which can cut down the number of interrupts, but you still need to do some work in the networking stack.  Then you get to the typical cable modem implementation, 
and there is not filtering at all. Every multicast packet goes to the host to be filtered. This doesn't normally matter though, because the cable modem is a point to point link.
</quote>
</para>

<para>
Q:  I'm still having problems, or I'm unusually curious...is there a way that I can get more information about what the device is up to?
</para>

<para>
A:  Yes, there is. The manufacturer hard-wired an http server for status and configuration purposes into the modem itself. It seems to have been designed for troubleshooting by cable tecnician staff, but you can access the 4100 and 4200 models by directing your web browser to <ulink url="http://192.168.100.1">http://192.168.100.1.</ulink> You will need to kill your firewall if you have one running prior to doing this. You can see statistics, logs and some other miscellaneous info at this address.
</para>

</sect1>


<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->


<appendix id="appendix">
<title>Gnu Free Documentation License</title>

<para>
Version 1.2, November 2002
</para>

<para>
Copyright (C) 2000,2001,2002  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.
</para>

<para>
0. PREAMBLE 
</para>

<para>
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. 
</para>

<para>
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

cense designed for free software.
</para>

<para>
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.
</para>

<para>
1. APPLICABILITY AND DEFINITIONS
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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".
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
2. VERBATIM COPYING
</para>

<para>
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.
</para>

<para>
You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
</para>

<para>
3. COPYING IN QUANTITY
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
4. MODIFICATIONS
</para>

<para>
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:
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
C. State on the Title page the name of the publisher of the
Modified Version, as the publisher.
</para>

<para>
D. Preserve all the copyright notices of the Document.
</para>

<para>
E. Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
</para>

<para>
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.
</para>

<para>
G. Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document's license notice.
</para>

<para>
H. Include an unaltered copy of this License.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
M. Delete any section Entitled "Endorsements".  Such a section
may not be included in the Modified Version.
</para>

<para>
N. Do not retitle any existing section to be Entitled "Endorsements"
or to conflict in title with any Invariant Section.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
5. COMBINING DOCUMENTS
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
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".
</para>

<para>
6. COLLECTIONS OF DOCUMENTS
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
7. AGGREGATION WITH INDEPENDENT WORKS
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
8. TRANSLATION
</para>

<para>
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.
</para>

<para>
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.
</para>

<para>
9. TERMINATION
</para>

<para>
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.
</para>

<para>
10. FUTURE REVISIONS OF THIS LICENSE
</para>

<para>
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/.
</para>

<para>
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.
</para>

<para>
ADDENDUM: How to use this License for your documents
</para>

<para>
To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
</para>

<para>
Copyright (c)  YEAR  YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
</para>

<para>
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
replace the "with...Texts." line with this:
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.
</para>

<para>
If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
</para>

</appendix>

<!-- - - - - - - - - - - S e c t i o n  B r e a k  - - - - - - - - - - - -->

</article>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:nil
sgml-parent-document:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->