The Wonder Shaper		1.1a.x1
bert hubert <ahu@ds9a.nl>
http://lartc.org/wondershaper
(c) Copyright 2002 
Licenced under the GPL - see 'COPYING'

Modifications for x branch by andi payn <payn@myrealbox.com>.

See README.wshaper for details on the main code, and on how to figure
out the settings that will work for you.

See README.wshaperx for details on wshaperx confguration and usage.

-------------------
BEFORE INSTALLATION
-------------------

Most likely, you've downloaded this package because your ISP has badly
configured your broadband connection, and every time you upload,
downloads slow to a crawl. (Possibly the problem is a badly-designed
router, a stupid network admin, a roommate sharing his internet
connection via WinGate on a misoptimized Win98 box, etc., but the
issue is the same.) If so, you should seriously consider asking,
begging, wheedling, threatening, or anything else to get them to fix
the problem--and, if possible, consider changing your internet
connection to get around it.

Assuming that you haven't been able to change the phone company's mind
(or get your company's netadmin fired or upgrade your roommate to
linux or whatever)--or that that isn't your reason for wanting traffic
shaping--the next step is to read README.wshaper, and ideally look
around lartc.org, to make sure you know what you're getting into, and
that you know how to gather the information you'll need to tweak the
traffic shaper's settings. Then you're ready to install.

---------------------
INSTALLATION FROM RPM
---------------------

0. The usual:

   rpm -Uvh wshaperx-1.1a-x1-1mdk.PLATFORM.rpm

1. Read /usr/share/doc/wshaperx-1.1a-x1/README.wshaper carefully to
   figure out how to determine the right settings, and README.wshaperx
   (in the same place) to figure out where to put those settings.

2. Edit /etc/wshaperx.conf. Experiment until you're sure you have it
   right. Then test some more to make sure. The same numbers that work
   at 3am may not be as good at 7pm.

3. If you want automatic link-up/link-down invocation (e.g., for
   pppoe), edit /etc/wshaperx.conf again to turn on the "AUTO" flag.

4. If you want automatic init/shutdown invocation (e.g., for always-on):

   chkconfig --levels 345 wshaperx on

-------------------------
INSTALLATION FROM TARBALL
-------------------------

0. The usual:

   tar xvjf wshaperx-1.1a-x1.tar.bz2 && cd wshaperx-1.1a-x1

1. As root:

   install -m755 wshaperx /usr/sbin/
   install -m644 wshaperx.conf /etc/

2. Read README.wshaper carefully to figure out how to determine the
   right settings, and README.wshaperx to figure out where to put
   those settings.

3. Edit /etc/wshaperx.conf. Experiment until you're sure you have it
   right. Then test some more to make sure. The same numbers that work
   at 3am may not be as good at 7pm.

4. If you want automatic link-up/link-down invocation (e.g., for pppoe):

   install -m755 wshaperx.ifup /etc/sysconfig/network-scripts/ifup.d/wshaperx
   install -m755 wshaperx.ifdown
           /etc/sysconfig/network-scripts/ifdown.d/wshaperx

   You may need to modify these files, or place them somewhere else,
   or force your system to call them for you, but this works for
   Mandrake 9.x.

   Then edit /etc/wshaperx.conf again to turn on the "AUTO" flag.

5. If you want automatic init/shutdown invocation (e.g., for always-on):

   install -m755 wshaperx.init /etc/rc.d/init.d/wshaperx
   chkconfig --levels 345 wshaperx on

   You may need to modify this file, or place it somewhere else, or do
   something different to enable it, but this works for Mandrake 9.x
