install.tme

speech signal process tools

.lo
.SJ "Installation Instructions for the ESPS Source Release"
.AU "Alan Parker"
.TM ETM-S-87-29 1.25 11/29/89
.*R 
ETM-S-86-14, Entropic Signal Processing System (ESPS) Programming Guidelines
.sh 1 Introduction
.pp
This document describes the installation procedure for ESPS Version 3.
Please read this document completely before attempting the
installation.    This release is intended for use on Masscomp
5000 or 6000 series computers running RTU 3.0 or greater,
Sun\-3, Sun\-4 or Sun\-386i workstations running Sun OS 3.2 or greater,
HP 800 and 300 series computers, DEC DecStation 3100 (called the
DS3100 here) workstations, and Convex computers.   The installation
script requires that a number of standard \s-1UNIX\s+1 utilities be
available and on the standard execution path, such as \fIgrep\fR,
\fIcc\fR, \fInroff\fR, \fIsed\fR, \fImake\fR, \fIdiffmk\fR and \fItest\fR.   
.pp
Earlier versions of ESPS required Fortran, but this release does not.
.pp
In the case of Sun386i some optional clusters are required to build
ESPS from this source kit.  You must have the development cluster
installed (both the base_devel and the sunview_devel part) and the
doc_prep cluster.
.sh 1 "Overview of Installation Process"
.pp
The installation is simple.   The tape or diskettes are read into a
clean directory (suggested name is esps).  This directory will become
the \fIsource\fR directory and can by located anywhere on the file
system, but it is suggested that it be in the login directory of the
local ESPS maintainer.
.pp
The installer may adjust a few installation variables in the script to
alter the default choices.   The installation script creates a
\fItarget\fR directory and installs all ESPS programs and related files
there.   If your system is low on file space, then the \fIsource\fR
directory can be removed.  However, if you can afford the space, having
the sources online is helpful, since they serve as example programs.
For convenience, the \fItarget\fR directory contains a symbolic link back
to the \fIsource\fR directory.  No ESPS programs require any of the
files under the \fIsource\fR directory after the installation script has
been properly run.
.sh 2 "ESPS's Place in the File System"
.pp
It is not necessary to be super-user while installing ESPS.  It is not
necessary (but it is possible) to put ESPS files into the standard
\s-1UNIX\s+1 directories such as /usr/lib, /usr/bin/, and /usr/include.
Whether you must have super-user access depends on where you want to
install ESPS.   The typical location for the \fItarget\fR directory is
/usr/esps.   There are two different ways to accomplish this.  One
is to have a super-user create the directory /usr/esps and then
change the owner of it to the user-id of the ESPS maintainer (the one
who read in the tape and is going to run the install script).  
The better option is to have the super-user create a symbolic link
\fI/usr/esps\fR which points to the true target directory location
(for example /home/esps), create this directory (make sure it is
writtable by the user-id running the install script), and then set the
target directory in the ESPS install script to \fI/usr/esps\fR.
.pp
If you have one of the \fIwaves+\fR products (other than for the
Sun386i) then you must have ESPS
rooted at \fI/usr/esps\fR.  
This will be requirement relaxed in a future release.
If you do not have \fIwaves+\fR then 
/usr/esps is only a convention and you can install ESPS anywhere
in your file system you desire.   All file paths are determined by the
installation script.
.pp
On a Sun386i, ESPS with \fIwaves+\fR must be rooted at \fI/files/esps\fR.   
Note that
it doesn't have to be directly installed there; it can be anywhere and
connected to \fI/files/esps\fR with a symbolic link.
.sh 2 "A Word About Access Modes"
.pp
There are installation parameters that determine the access modes of the files
when they are installed.    
The default is write access by owner (should
be the local ESPS maintainer) and read access by others.
If you desire to limit access to ESPS to a particular group, you can
reset the access mode installation variables accordingly.
There are installation parameters for the mode of the programs, manual
pages, and library files.
.sh 2 "File Space Required"
.pp
This release of ESPS requires about 9 Megabytes of file space to read in
the distribution media.   
This is 18,000 blocks on the Masscomp, HP, and DS3100, 
and 9,000 blocks on a Sun.
The target directory requires about 17 Megabytes 
on a Masscomp, about 26 Megabytes on a Sun3, HP or DS3100,
and about 19 Megabytes on a Sun4 (Sparc) after all programs are installed.
During installation, the \fIsource\fR directory will grow by about 
10 Megabytes
owing to the .o files being created during compilation.
After the installation script
has completed correctly, you can remove the 
.o files by doing \fIinstall -c\fR.  You can also remove the entire
\fIsource\fR directory if
you are low on file space and do not need easy access to the sources.
.sh 1 "Optional WAVES+ software"
.pp
The following section only applies to Sun systems (since the optional
\fIwaves+\fR software only runs on Suns at present).   
If you ordered \fIwaves+\fR
with ESPS, then it is included on the tape 
after the two ESPS directories (\fIgeneral\fR and \fIlocal.skel\fR).
The following table shows the directory names for the different
\fiwaves+\fR products, depending on the system type.
.TS
box,center,tab(;);
c c c
l l l.
Machine;Product Code;Directory on Tape
_
Sun 3;w+S3;waves.sun3_68881
;;waves.sun3_fpa
Sun 4;w+S4;waves.sun4
Sun 386i;w+S386i;waves.sun386
Any Sun;w+SRC;waves.src
.TE
.pp
Note that for Sun3, there may be two versions of the binary; one compiled
for the 68881 floating point chip and the other for the Sun3 FPA board.  Use
the one (or both) that is appropriate for your configuration.   (For
example, if you have a server with the floating point board (FPA), but
diskless nodes on it without FPAs, then you might want to build ESPS
twice, once with the FPA option on, and once with it off and install the
correct \fIwaves+\fR binary into them.  Then set up the paths on the
various machines, using symbolic links, so that each machine sees the
correct type of code.
If you ordered multiple types of \fIwaves+\fR, then all will be on the 
distribution media.   
.pp
Except for \fIwaves.src\fR, the \fIwaves+\fR distributions are in binary form, so 
they do not require compilation.  The
distribution directory contains a makefile that copies the files to the
correct locations within ESPS and sets the modes of the files.   The
\fIwaves+\fR binaries are put into the ESPS \fIbin\fR directory.   The 
\fIwaves+\fR
man pages are put into the ESPS \fIman/man1\fR directory.   Some other
related \fIwaves+\fR files, such as sample parameter files and colormaps, are
put into the ESPS directory \fIlib/waves\fR.
.pp
A variable in the install script, \fBWAVES\fR is set to y (for yes) or n
(for no) depending on whether \fIwaves+\fR is to be installed with ESPS.
If you ordered \fIwaves+\fR with ESPS and it is on the tape, then this
variable will be set for you.  (But you should check us!).   The
variable \fBWAVES_TYPE\fR is set to the name of the \fIwaves+\fR directory, as
described above.   For example, if your system type is a Sun4,
then you should set \fBWAVES\fR
to \fIy\fR and \fBWAVES_TYPE\fR to \fIwaves.sun4\fR.  
If you have the \fIwaves+\fR source directory, then set \fBWAVES\fR to y and
\fBWAVES_TYPE\fR to \fIwaves.src\fR.
.sh 1 "Window Systems"
.pp
ESPS supports three different windowing systems, Masscomp SP-40 graphics
(MC Windows), Sunview (also known as Suntools), and the X Window
System.   Masscomp systems can have either or both SP-40 and X
Windows.  In this version of ESPS Sun systems can only have Suntools.
HP systems are assumed to have X Windows.   If you are building ESPS
from source on a Masscomp, check the section of the install script where
the Masscomp defines are located and set the variables \fBSP40\fR and \fBXWIN\fR
correctly.
.sh 1 "Reading In The Distribution"
.pp
This first section is for
Masscomp systems.  If you are installing ESPS on a Sun or HP skip ahead to 
the appropriate section.
.sh 2 "Masscomp (Concurrent)"
.pp
There are two cases here.  One for an installation from 9 track tape and 
the other case for diskettes.   Follow the instructions in the next section 
for 9 track tape.  The following instructions assume that you want to 
read the distribution
into a new directory named \fIesps\fR in your home directory.   If you 
desire to read it into another directory, them modify these instructions
accordingly.
.pp
.pp
Skip ahead to "Reading a Set of Diskettes" if your 
installation is from diskettes.
.sh 3 "Reading a 9 Track Tape"
.pp
The tape drive is assigned and the tape (in tar format) is read in. 
Be sure you are in your home directory, create a directory named
\fIesps\fR and then change to it.  The tape will be read into this
directory.  The following commands do the trick:
.br
.ta 4i
.ft CW
.nf
% assign 1600	
% cd
% mkdir esps
% cd esps
% tar xvf /dev/rmt0 
.ft LR
.fi
.pp
After doing this you should have a directory named \fIesps\fR under your home
directory.   This directory should contain another directory named
\fIgeneral\fR and a file named \fIREADME\fR.   Check this \fIREADME\fR
file for any information that did not get put into this note.
.pp
Skip to the section titled "Editing the Install Script".
.sh 3 "Reading a Set of Diskettes"
.pp
Insert the first diskette into the diskette drive.  Be sure you are in
your home directory, create a directory named \fIesps\fR and then change
to it.  The diskettes will be read into this directory.  The following
commands do the trick:
.ft CW
.br
.nf
% cd
% mkdir esps
% cd esps
% tar xvf /dev/rflp
.ft LR
.fi
.pp
After \fItar\fR reads a complete diskette, it will print a message like:
.br
.ft CW
.nf
tar: errno returned 2, Cannot read input
tar: If you want to go on, type "yes" or a new pathname of a device/file
name when you are ready
.fi
.ft LR
.pp
When you get this message, remove the diskette and insert the next in
the set and type 
.ft CW
yes
.ft LR 
(followed by a return).   
You should not get this message when reading the last
diskette in the set.
.pp
After reading the diskettes you should have a 
directory named \fIesps\fR under your home
directory.   This directory should contain another directory named
\fIgeneral\fR and a file named \fIREADME\fR.   Check this \fIREADME\fR
file for any information that did not get put into this note.
.pp
If you have a problem reading the diskette, check the access mode of
/dev/rflp (the diskette drive).   You might need to have a super-user change the access mode
of /dev/rflp.
.pp
Skip to the section titled "Editing the Install Script".
.sh 2 "Sun with Cartridge Tape or 9 Track Tape"
.pp
The following instructions assume that you want to read the distribution
into a new directory named \fIesps\fR in your home directory.   If you 
desire to read it into another directory, them modify these instructions
accordingly.
.sh 3 "Reading a 9 Track Tape or Cartridge Tape"
.pp
The tape (in tar format) is read in. 
If the media is a 9 track tape, then 1600 bpi is used (unless you
requested something else).   If a cartridge is used, then the media is
written in high density mode (/dev/rst8 on many Suns).
Be sure you are in your home directory, create a directory named
\fIesps\fR and then change to it.  The tape will be read into this
directory.  
These instructions do not include the correct name for your tape drive,
since that varies from one Sun configuration to another.
The following commands do the trick:
.br
.ta 4i
.ft CW
.nf
% cd
% mkdir esps
% cd esps
% tar xvf /dev/XXXX (where XXXX is the name of your tape drive)
.ft LR
.fi
.pp
After doing this you should have a directory named \fIesps\fR under your home
directory.   This directory should contain another directory named
\fIgeneral\fR and a file named \fIREADME\fR.   Check this \fIREADME\fR
file for any information that did not get put into this note.
.pp
Skip to the section titled "Editing the Install Script".
.sh 2 "Sun 386i"
.pp
If the media is either 9 track tape or cartridge tape, follow the
instructions above for a Sun with Cartridge Tape or 9 Track Tape.
.pp
Otherwise the media will be high density 3.5 inch diskettes.   The Sun
\fIbar\fR utility is used to read the diskettes.  The ESPS source is on
one set of diskettes (about 5 diskettes) and any \fIwaves+\fR related
products will be separate \fIbar\fR files on their own sets of
diskettes.
.pp
To read in an ESPS distribution on diskettes, 
be sure you are in your home directory, create a directory named
\fIesps\fR and then change to it.  The diskettes will be read into this
directory.  
The following commands do the trick:
.br
.ta 4i
.ft CW
.nf
% cd
% mkdir esps
% cd esps
% bar xvf /dev/rfd0a 
.ft LR
.fi
.pp
After reading the first diskette, the program will prompt you to insert
the next diskette and type \fBy\fR.  Simply read in all diskettes in the
order that they are numbered on the label.  Be sure to keep the
individual products together.
.pp
After doing this you should have a directory named \fIesps\fR under your home
directory.   This directory should contain another directory named
\fIgeneral\fR and a file named \fIREADME\fR.   Check this \fIREADME\fR
file for any information that did not get put into this note.
.pp
If you ordered additional products, such as \fIwaves+\fR (in binary or
source), read them into this same directory using the same steps shown
above.
.pp
Skip to the section titled "Editing the Install Script".
.sh 2 "HP 300 or HP 800"
.pp
The following instructions assume that you want to read the distribution
into a new directory named \fIesps\fR in your home directory.   If you 
desire to read it into another directory, them modify these instructions
accordingly.
.sh 3 "Reading a 9 Track Tape"
.pp
The tape (in tar format) is read in. 
Be sure you are in your home directory, create a directory named
\fIesps\fR and then change to it.  The tape will be read into this
directory.  
Assuming that \fItar\fR uses the default tape drive,
(you might have to use the \fI-f\fR option on \fItar\fR)
the following commands do the trick:  
.br
.ta 4i
.ft CW
.nf
% cd
% mkdir esps
% cd esps
% tar xv
.ft LR
.fi
.pp
After doing this you should have a directory named \fIesps\fR under your home
directory.   This directory should contain another directory named
\fIgeneral\fR and a file named \fIREADME\fR.   Check this \fIREADME\fR
file for any information that did not get put into this note.
.pp
.sh 3 "Reading HP Cartridges"
.pp
If the distribution is supplied on 1/4 inch cartridges, then we have
used the HP utility \fItcio\fR to properly block the tape.  To read it
back in do:
.br
.ta 4i
.ft CW
.nf
% cd
% mkdir esps
% cd esps
% tcio -i /dev/XXXX | tar xvf -
.ft LR
.fi
.pp