head	1.6;
access;
symbols;
locks; strict;
comment	@% @;


1.6
date	92.12.14.09.50.11;	author lacey;	state Exp;
branches;
next	1.5;

1.5
date	92.12.14.09.45.05;	author lacey;	state Exp;
branches;
next	1.4;

1.4
date	92.12.14.06.16.38;	author lacey;	state Exp;
branches;
next	1.3;

1.3
date	92.12.14.03.32.23;	author lacey;	state Exp;
branches;
next	1.2;

1.2
date	92.12.14.03.11.51;	author lacey;	state Exp;
branches;
next	1.1;

1.1
date	92.12.14.00.03.09;	author lacey;	state Exp;
branches;
next	;


desc
@@


1.6
log
@*** empty log message ***
@
text
@%
% Provide a description of the steps needed to 
% install the system.  This should include any
% details not mentioned in the introduction (i.e.
% environment setup, etc.)
%
\section{Installation Procedure}
\label{sec:install}

Before trying to install \xplan, please read sections \ref{hw-req} and
\ref{sw-req} which discuss the hardware and software requirements of
\xplan.  If your system does not meet these requirements, it is
possible that you will not be able to build \xplan\ without first making
modifications to it.

\subsection{Extract Files From Tar File}

Assuming you have not yet extracted \xplan\ from diskette, do the
following:

    Insert diskette in drive, and type:
\begin{verbatim}
    tar xvf /dev/rfd0
\end{verbatim}
rfd0 may not be the correct device for your machine --- check with
vendor documentation

At this point you should have the following directory structure:
\begin{verbatim}
    xplan/
       bin/
       projects/
       src/
\end{verbatim}

\subsection{Build \xplan}

Move into the xplan/src directory
\begin{verbatim}
    cd xplan/src
\end{verbatim}

To build the program, type:
\begin{verbatim}
    make
\end{verbatim}
to create an executable version of \xplan\ which will be placed in the
bin directory.

\subsection{Setting Up Your Work Environment}

Now you need to set up the help path, so the help text for \xplan\ will
be displayed when you use your help key.  An example help path might
be:
\begin{verbatim}
   setenv HELPPATH /usr/openwin/lib/help:/usr/lacey/xplan/src
\end{verbatim}
The one thing that is essential for \xplan\ is that you have your help
path pointing to the location of the .info files that are included in
the src directory as distributed.

If you plan on using \xplan\ a lot you might want to add the bin
directory to your PATH environment variable, too.

\subsection{Summary}

\xplan\ is now installed, and if your PATH is set up correctly you
should be able to run it by simply typing 'xplan' at the command
prompt from any directory.
@


1.5
log
@*** empty log message ***
@
text
@d47 1
a47 1
to create an executable version of xplan which will be placed in the
d58 1
a58 1
The one thing that is essential for \xplan\ is that you have your help
@


1.4
log
@*** empty log message ***
@
text
@d52 1
a52 1
Now you need to set up the help path, so the help text for xplan will
d58 1
a58 1
The one thing that is essential for xplan is that you have your help
d62 1
a62 1
If you plan on using xplan a lot you might want to add the bin
d67 1
a67 1
xplan is now installed, and if your PATH is set up correctly you
@


1.3
log
@*** empty log message ***
@
text
@a15 2
\xplan\ INSTALLATION PROCEDURE (last updated December 12, 1992)

d22 1
a22 1

d24 1
a24 1

@


1.2
log
@*** empty log message ***
@
text
@d10 1
a10 1
Before trying to install xplan, please read sections \ref{hw-req} and
d12 2
a13 2
xplan.  If your system does not meet these requirements, it is
possible that you will not be able to build xplan without first making
d16 1
a16 1
XPLAN INSTALLATION PROCEDURE (last updated December 12, 1992)
d20 1
a20 1
Assuming you have not yet extracted xplan from diskette, do the
d31 1
a31 1

d36 1
d38 1
a38 1
\subsection{Build xplan}
d41 1
a41 1

d43 1
d46 1
a46 1

d48 1
a48 1

d57 1
a57 1

d59 1
a59 1

@


1.1
log
@Initial revision
@
text
@d16 1
a16 12
xplan is distributed in a compressed tar file format, and can be
received from various anonymous ftp sites.  Once received, you should
run {\tt uncompress} on the tar file to de-compress it.  Then, {\tt
tar xvf filename} (where {\tt filename} is the name of the tar file)
should be used to un-tar the contents of the archive.  Once this has
been done, the user will have an {\tt xplan} directory in which the
source files will be located.  Next the user should enter the {\tt
xplan} directory and run {\tt make} to build the program.  If any
compilation errors occur (which might happen if the user is trying to
build the program in an environment different than the one it was
developed in) the user will have to determine what the problem is and
take action to correct it.
d18 1
a18 3
At this point the program has been installed and should run without
error.  To begin xplan, the user types {\tt xplan} at the command
prompt.
d20 50
@
