#!you

This is the readme file for David Nicol Consulting's MPRIME running
script.

License granted for free and general use and modification to
all GIMPS participants.  And feel free to modify these scripts
for use in other distributed projects --- just put my name in the
comments somewhere, okay?  David Nicol, the programmer from Kansas City.

The accompanying software has been debugged using xterm, vim, perl5,
slackware96 with FVWM95 window manager.


It requires ash (bash will do, or zsh, or sh)
It requires perl
It requires lynx 
and sendmail, and a (persistent or on-demand) internet connection.

how to install:

1: add a user mprime

   their home directory should by /usr/local/etc/mprime

2: unpack this tar file there, or move the files there.

3: download the database that mprime uses if you don't have it
   already; www.mersenne.org is the place to find it. And of course
   George Woltman's mprime software.  By using the .netrc file included
   with this distribution, you should be able to `su - mprime` after which
   `ftp ftp.mersenne.org` ought to not only go get the database but 
   automatically uncompress it.  `ftp -n ftp.mersenne.org` will bypass
   the .netrc script, the first time, in order to get the mprime.tar.gz
   file.  Be sure to set the mode to binary first.  To disable automatic
   downloading of a fresh database with each assignment, comment out the 
   ftp line in the mprime.sh script.


4: add this item to your rc.local script:

# mprimes project
su mprime -c /usr/local/etc/mprime/mprime.sh &

4a: if your machine requires its network connection to
   be initialised with some sort of script, edit
   mprime.sh and NewAssignment.pl to include your script, or uncomment
   the ppp_up and ppp_down lines if that is what
   your scripts are called.

5: make the mprime.sh script executable with chmod +x

6: forward the mprime user's email to you like so:
   cd /usr/local/etc/mprime; echo youremail@domain.name > .forward
   or add an entry in your /etc/aliases file and run `sendmail -i`

7: On a workstation with a full-time network connection, no
   editing of the scripts is required: when a task is finished
   the script automaticly emailis the results file to George Woltman
   , selects a new assignment, downloads a
   fresh database, and emails the newly selected assignment too.

8: run mprime.sh & or reboot your machine to make sure the rc.local
   thing worked. 


HISTORY:

Apr 18, 1997	initial version

Apr 28, 1997	changed George Woltman's preferred e-mail address

May 7, 1997 	added ppp_up/down guidelines
May 7, 1997 	added history section to README file

June 24, 1997   spelling, grammar

July 11, 1997   added .netrc file for automated download of ftp://ftp.mersenne.org/database.gz

Aug 29, 1997	tested safeguard against assignment file being unwritable in mprime.sh

Dec 02, 1997	revised NewAssignment.pl to reflect new layout of range.htm page
Dec 02, 1997	added TrimAssignment.pl in response to observed behavior of system

bug reports to David Nicol