WELCOME TO TeXuP FOR MAC OS X!!!

	Created by 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 texup, see the CHANGELOG file for 
  upgrading instructions.


* TEXUP SYSTEM REQUIREMENTS AND INSTALLATION INSTRUCTIONS


* SYSTEM REQUIREMENTS
 
1) texup needs Mac OS X 10.2 or newer. It may run on older versions 
of OS X but I can't guarantee it.

2) texup also requires BASH version 2.0 or newer. Type 

	bash --version

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

Note that texup can be run from within any shell. 

3) Obviously you need pdflatex installed on your system. 


* INSTALLATION INSTRUCTIONS

To install and use texup you need to be familiar with basic Unix 
commands. See

http://www.osxfaq.com/Tutorials/LearningCenter/index.ws

for a Mac OS X Unix tutorial. The Terminal application is 
also required to install and use texup. 

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 texup directory: 

	cd ~/downloads_directory/TeXuP_MacOSXDir

1) LOCATING THE PATH OF THE INTERPRETER
The first line of texup tells your shell to interpret  
texup in BASH. Currently the first line of texup 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 texup. If you don't see 
this, then you will need to change the first line of texup 
to the appropriate location. For example, if bash is located at

/usr/local/bin/bash

then the first line of texup needs to be changed to

#! /usr/local/bin/bash 

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

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

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

I recommend you install texup 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 texup in the
  future;
- /usr/local/bin should appear before ~/bin in your PATH, so texup
  will start up (marginally) quicker;
- /usr is owned by root, this will minimize the chance of any accidental 
  changes to texup.

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 texup into ~/bin.

BEFORE PROCEEDING, CHECK THAT THE DIRECTORY IN WHICH YOU INTEND TO 
INSTALL TEXUP 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 texup executable, type

	chmod a+x texup

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

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

NOTE: if you are installing texup 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
texup 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 texup_path

where texup_path is texup'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 texup.

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

texup is now installed.


* INSTALLING THE STARTUP SCRIPT

texup needs a script added to the startup file of EACH user to 
optimize texup's output numbering system. The script is shell dependent. 
If your default shell is CSH or TCSH, then add the contents of the file 
TeXuP.login to your ~/.login script. If your default shell is BASH,
then add the contents of the file TeXuP.bash_profile to 
~/.bash_profile OR ~/.bash_login OR ~/.profile (in that order).
Bourne shell (SH) users, add the contents of the file TeXuP.profile 
to your ~/.profile script.

An easy way to add texup's script to your startup file is, for
example, in CSH (TCSH):

	cat TeXuP.login >> ~/.login


* THAT'S IT!!! For more information, type 

	texup -h 

for the help file.


        ______________________________________________