-----BEGIN PGP SIGNED MESSAGE-----

==========================================================================
README for Kernel Scripts Release 2.1.40.                 Date: 05/28/1997
==========================================================================

Contents:

I. Overview.
   
   A. About the author.
   B. Why I wrote these scripts.
   C. Requirements.
   D. Information on version numbers.
   E. Kernel compilation.
   F. Main goal of Kernel Scripts.

II. Setup.
   
   A. What these scripts do.
   B. Obtaining newer versions.
   C. Information for installing newer versions.
   D. Unpacking and installing.
   E. RPM Stuff.
   F. Setting-up variables.

III. The Scripts (and what they do).
   
   A. configure.
   B. backup.
   C. cleanup.
   D. compile.
   E. patchk.

IV. Feedback.
   
   A. Script ideas or bugs.
   B. Praise.
   C. Criticism.

V. My Theories.
   
   A. Big magnetic field.

VI. Other Legal Crap.


=========================================================================


I. Overview

   A. About the author.

   Author of this README and the scripts that come with this package is
   Ryan McGuire (rmcguire@usa.net). I have lots of experience with Linux
   and various other operating systems. E-Mail me if you need help with
   this package or other problems you have with Linux. My PGP public key
   is include with this package.

   B. Why I wrote these scripts.

   I felt like writing them ;). If you want a more detailed explanation
   (I don't see why), just e-mail me.

   C. Requirements.

   To use these scripts you MUST have GNU's Bash shell (I would suggest
   getting version 2.0), GNU's Tar, and GNU's Zip (gzip). You NEED the
   Linux kernel sources. You can run these scripts without the kernel
   sources but it wouldn't do much good. You MUST have all of the scripts
   in the same directory (i.e. the 'backup' script needs the the 'cleanup'
   script, it will look for in the current directory, if in cannot find
   it, the script will terminate).

   You MUST also be logged in as "root" to run these scripts.

   D. Information on version numbers.

   Releases are based on the current Linux kernel versions. This is Kernel
   Scripts version '2.1.40', so this means this version was released when
   the current Linux kernel (development) version was '2.1.40'. It's much
   easier this way.

   E. Kernel compilation.

   This is not the place to discuss how to compile the kernel. Please
   look at the 'Kernel-HOWTO' by Brian Ward first before you try to use
   these scripts.

   F. Main goal of Kernel Scripts.

   The main goal is to make peoples lives easier and also hope that Linus
   Torvalds will make these scripts apart of the Linux Kernel source
   tree (hint, hint). Or an endorsement will do fine ;).


II. Setup.

   A. What these scripts do.

   These scripts are used to make compiling and and other functions easier.
   Here are descriptions of each script (if you cannot tell by the name):

   configure: Configure kernel scripts.
      backup: This will backup the Linux kernel.
     cleanup: Cleanup the directories after the kernel has been compiled.
     compile: Compile the kernel.
      patchk: Patch the kernel.

   B. Obtaining newer versions.

   New versions of KScripts will be found at sunsite.unc.edu. In the
   /pub/Linux/kernel directory. Type 'backup --version' to get the current
   version of KScripts you have.

   C. Information on installing newer versions.
   
   If you want to install a new version of Kernel Scripts, then you MUST
   rerun the 'configure' script. In newer releases there maybe newer
   options that are not defined in the old config file. Also this scripts
   does not (yet) support using the old config file for default answers. 

   D. Unpacking and installing.

   If you need information on how to uncompress the Kernel Scripts
   package, how could you be reading this README file?!?!?!?!
   To install these scripts, run the 'configure' script. This will
   configure and install the scripts. Please DO NOT delete the README or
   the COPYING because you might need them in the future. It will also
   make me feel better.

   E. RPM Stuff.

   Hmmm.... Well since many people use RedHat, I guess I need to make a
   RPM version for these scripts. I need to learn how to make one first
   (any help from the peanut gallery?).

   F. Setting-up variables.

   These scripts use nifty little things called 'environment variables'
   (or thats what I call them). To set up them up you MUST run the
   'configure' script. This will ask you a bunch of question that you
   will need to answer. Most of the questions are 'yes/no' questions. You
   cannot type 'y' for yes or 'n' for no. I did not setup this scripts to
   accept those type of answers.

   All of you answers are put into a config file (.ksconfig). You could
   edit this manually if you wanted to.


III. The Scripts (and what they do).

   A. configure.

   This script is need to configure Kernel Scripts. Just read the above
   section to find out more information on it. Like I said above, the
   questions are 'yes/no' questions. You can't type 'y' for yes or 'n'
   for no. I did not setup this scripts to accept those type of answers.
 
   PLEASE! Do not look inside of the configure script. It is really really
   really ugly (wow! that's pretty ugly). You think some of your
   siblings are ugly? Compared to the script, your siblings look like 
   Tori Amos. 
   
   B. backup.

   After you have the variables setup, you may run these scripts. The
   'backup' script will first run the 'cleanup' script. The 'cleanup'
   script will clean out the '*.o' files and other files that are not
   necessary. After the 'cleanup' script is finished the 'backup' script
   will backup Linux using 'tar' first. After 'tar' has finished, backup
   will run 'gzip -9' to compress the source tree even better. After that
   has finished, the 'backup' script will delete the old backup version
   of the Linux source tree and move the new one in its place.

   C. cleanup.

   The 'cleanup' script will clean out the '*.o' files and other files
   that are not necessary. You may choose the type of clean in the
   'variables' section of that script. If you have 'mrproprer' defined as
   the type of cleanup you want, the script will copy the configuration
   file (.config) to the temp dir and copy back (if you want) after the
   script is done.

   D. compile.

   The 'compile' script will compile the Linux kernel. It will compile the
   kernel using make whatever_variable_you_selected. Then if you want it
   it will reboot your system with the new kernel. There are some other
   variables that are not useful to mortals like me and you.
   This scripts also supports people who use Loadlin.

   E. patchk.

   This script will patch your old kernel with the new patch. Lets say you
   have kernel version 2.0.0 and the newest release is 2.0.1. So you
   would download the file patch-2.0.1.gz into the directory of your
   choice. This script will look in the directory you specified during
   configuration and move it to the directory below your Linux directory.
   There it will patch the kernel to version 2.0.1 and delete all of the
   '*.orig', '.*.orig', '.*.old' and '*.rej' files, unless you said no to
   that option.


IV. Feedback.

   A. Script ideas (ideas are good) or bugs (bugs are bad).

   If you have an idea (good) or a bug (bad), just send me a E-Mail 
   message and I will try to create (good) or fix (bad) it.
   I'm sure there are lots of things that are not correct in these
   scripts. This scripts were created on a very basic knowledge of the
   Bash Scripting Language.

   B. Praise (good)

   Send me compliments about these scripts. Please?

   C. Criticism. (bad)

   If you do not like these scripts and think they are the worst idea in
   the entire universe (besides the Mac(R)), well, keep your mouth
   shut and no harm will come to you! :)

   D. Contacting Me!

   You reach me via E-Mail at: 'rmcguire@usa.net' or visit my WWW page at:
   'http://www.geocities.com/SiliconValley/Way/3540'.


V. My Theories.

   A. Big magnetic field.

   I believe there is this big magnetic field that circles around Columbus
   (Ohio) and destroys all disks by making sector 0 bad. I have no good
   disks. Because all of them are bad at sector 0. My 1.44 MB disk drive is
   going and it is because of that stupid magnetic field.
   My CDROM was also destroyed. Well... I destroyed that myself but I
   am still blaming that field anyway.

   If you have any 1.44 MB disks, a 1.44MB disk drive, or a CDROM you
   don't need anymore send them to me. Thanks :)


VI. Other Legal Crap.

   This README and these scripts come WITHOUT ANY WARRANTY. You must
   distribute the 'COPYING' file with the Kernel Scripts, or use the one
   in the root directory of the Linux Kernel Source Tree.

   Mac(R) is a registered trademark of the Apple Corporation.
   Steve Jobs rules! I wonder whats NeXT ;).

   Most important: Don't believe 'My Theories'. It's only in there for
   laughs. 


-----BEGIN PGP SIGNATURE-----
Version: 2.6.2
Comment: http://www.geocities.com/SiliconValley/Way/3540

iQB1AwUBM4tZ3qihxvDcJVP5AQEz6QL/dfX2tOihDDXZZ0Rwhev0zkxQgV33dmsN
Be2GMbBOLjdNMsnhTnGet5W5wpolbUGh/3UETXCs2M+/0TMccmxSeU0JqR9AN1Ct
3IVVv9QEA+Yk+6TuNWQZkGZoT9fM8nFu
=RLbm
-----END PGP SIGNATURE-----
