WELCOME TO BUP!!!

	Copyright (C) 2003, 2004 Jason R. Looker
	Department of Mathematics and Statistics
	The University of Melbourne
	Victoria 3010
	AUSTRALIA
	E-mail: j.looker@ms.unimelb.edu.au

  See the COPYING file for copyright and warranty details.

  If you are upgrading bup, see the CHANGELOG file for 
  upgrading instructions.


* BUP SYSTEM REQUIREMENTS AND INSTALLATION INSTRUCTIONS


* SYSTEM REQUIREMENTS

1) bup requires a Linux/Unix/Mac OS X style operating system with 
BASH version 2.0 or newer. Type 

	bash --version

to find out which version of BASH is on your system. 

NOTE: bup can be run from within any shell. 

2) tar, gzip and ssh are obviously needed.


* INSTALLATION INSTRUCTIONS

The installation of any shell script involves five steps: 

1) locating the path of the interpreter; 
2) choosing a directory to store the script; 
3) making the script executable; 
4) moving the script to the directory where it's to be stored;
5) updating the command hash table.

If you are familiar with installing shell scripts, then you should
only need to read step 2) of the below instructions. Otherwise read
on ... 

To begin, change directories to the bup directory: 

	cd ~/downloads_directory/Bup_Dir

1) LOCATING THE PATH OF THE INTERPRETER
The first line of bup tells your shell to interpret  
bup in BASH. Currently the first line of bup reads

#! /bin/bash

however, BASH may not be in the /bin directory on your
system. To work out where BASH is on your system, type

	which bash

If you see 

/bin/bash

then you DO NOT need to alter bup. If you don't see 
this, then you will need to change the first line of bup 
to the appropriate location. For example, if bash is located at

/usr/local/bin/bash

then the first line of bup needs to be changed to

#! /usr/local/bin/bash 

2) CHOOSING A DIRECTORY TO STORE THE SCRIPT
bup should be placed in a directory named "bin". There are
essentially two choices:

i) Install bup in ~/bin. If you choose this option then you will
be the only user able to run bup.

ii) Install bup in one of the "usual" locations such as
/usr/local/bin. If you choose this option, then bup can support
multiple users.

I recommend you install bup into /usr/local/bin for the
following reasons:

- if you are not the only user of your computer or you do not own
  your computer, then someone else may want to use bup in the
  future;
- /usr/local/bin should appear before ~/bin in your PATH, so bup
  will start up (marginally) quicker;
- /usr is owned by root, this will minimize the chance of any accidental 
  changes to bup.

Since /usr is owned by root, you will not be able to make any
changes to the contents of /usr unless you are an "administrator"
of your computer. If you do not have administrator status, then you
will have to install bup into ~/bin.

BEFORE PROCEEDING, CHECK THAT THE DIRECTORY IN WHICH YOU INTEND TO 
INSTALL BUP IS CURRENTLY IN YOUR SEARCH PATH. Type 

	echo $PATH

to check. If it is not, then see the PATH file for instructions on
how to add a directory to your PATH.

3) MAKING THE SCRIPT EXECUTABLE
To make bup executable, type

	chmod a+x bup

4) MOVING THE SCRIPT 
Copy bup to the directory in which it's to be stored, for example, 
if you wish to install bup into /usr/local/bin, then type

	sudo cp -i bup /usr/local/bin/bup

NOTE: if you are installing bup into ~/bin, then omit the sudo 
command.

NOTE: you will need to enter your password and you will need
"administrator" status to successfully complete the sudo command.
If you do not have administrator status then you must install
bup into ~/bin. 

5) UPDATING THE COMMAND HASH TABLE
There are two methods of updating the command hash table:

i) Use a command. The command you use depends on what your default
shell is. Type

	echo $SHELL

to find out which shell you are using. If you are using the Bourne
shell or BASH, type 

 	hash bup_path

where bup_path is bup's full path. If you are using CSH or
TCSH, type 

	rehash

NOTE: the (re)hash command must be executed in each terminal that was
launched before you installed bup.

ii) Close all terminals (if it is safe to do so). This is often much 
easier than the first option.

bup is now installed.

FINALLY, create a directory on the remote file server to store your 
backed up files, for example

	ssh username@remote_host 'mkdir ~/bup_dir'

This will create a directory named bup_dir in your home 
directory on remote_host.

THAT'S IT! The first time bup is run, it will automatically 
ask to be configured. Just follow the prompts ...

* FOR MORE INFORMATION ON BUP 

Type

	bup -h

for the help file.


        ______________________________________________