install.tme

speech signal process tools

.pp
Where XXXX is the name of your tape device.
.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.
.sh 2 "DS3100"
.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 TK50 Tape Cartridge"
.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.
.sh 2 "Convex"
.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.
.sh 1 "Editing the Install Script"
.pp
There are several variable assignments that must be checked by the installer.
They are the system type, the location of the \fItarget\fR directory, and
the data acquisition device names.
.pp
The variable \fBMACH\fR should be set to indicate the machine type.  It
is either M5500 for a 68010 Masscomp, M5600 for a 68020 Masscomp,
SUN3 for a Sun\-3, SUN4 for a Sun\-4, SUN386i for a Sun\-386i, 
HP for an HP 300 or HP 800 series,
CONVEX for a Convex C-1 or C-2, or DS3100 for a DecStation 3100.  
No other machine types are supported by this release.
The default value should be the same as the tape is labeled for, but if
you ordered for several machine types, it won't be right for all of
them.
In any event, check the \fBMACH\fR variable in the
install script.
.pp
The variable \fBSPSDIR\fR
is the location of the \fItarget\fR directory.   It is set to the full path
of the desired \fItarget\fR directory.   The default value (as shipped) is
\fI/usr/esps\fR.  The install script will try to create this directory if it
does not exist.  Be sure that the user-id running the install script
can write into the directory in which the \fItarget\fR directory will be
created.  If not (for example if it is /usr) have the super-user create
it first and then \fIchown\fR of it to the ESPS installer's user-id.
.pp 
The other installation variables that might need adjustment are the file access modes.   
These default to access by everyone on the system.  
If you desire to limit access to to a particular group you can set the 
access mode as desired.   The group used will be that of the installer.  
(For full access, the last digit of the mode should be the same as the 
next to last digit (eg. 0755 or 0644).  To limit access to the group,
the last digit should be zero (eg. 0750 or 0640).
.pp
The install script contains a listing at the beginning of all
variables that can be defined and their default values.
Note that the install script is a \fIsh\fR(1) script, and there can be
no spaces around the equal sign (=) in variable assignment statements.
.sh 2 "Data Acquisition Devices on Masscomp (Concurrent)"
.pp
The variables \fBDADEV\fR, \fBADDEV\fR, and \fBCLKDEV\fR are set to the
name of the digital-to-analog converter, the analog-to-digital converter,
and the clock device.   The d/a and a/d device are the full path
names of the device.  For example \fI/dev/dacp0/daf0\fR.
The clock device is the full path of the clock, excluding the trailing
device number.  For example \fI/dev/dacp0/clk\fR.
The default values are \fI/dev/dacp0/daf0\fR for \fBDADEV\fR, 
\fI/dev/dacp0/adf0\fR for \fBADDEV\fR, and \fI/dev/dacp0/clk\fR for 
\fBCLKDEV\fR.   
.pp
\fBMAXDA\fR and \fBMAXAD\fR are set to the maximum (absolute) value
obtained from your analog-to-digital equipment, or that can be sent to
your digital-to-analog equipment.  The default value is for a 12 bit
twos-compliment device (2047).   This value affects scaling that is done
within the \fIplay\fR program.   It is not used by any of the signal
processing programs.
.sh 2 "Specifying Window Systems"
.pp
If you are on a Masscomp system, you have three options: SP-40 Graphics,
X Windows, or both.  All Masscomp systems with graphics terminals have
at least one of these window systems.  Determine which you have and set
the variables \fBXWIN\fR and \fBSP40\fR to yes or no depending on
whether you have these.  If you do not have Masscomp graphics terminals,
we suggest that you set \fBSP40\fR to \fIYES\fR and \fBXWIN\fR to
\fINO\fR.
.pp
For HP and DS3100 systems, we assume that X windows is present.   
.pp
For Sun systems, this version of the kit only supports building ESPS for
the Sunview window system.  A patch kit is available to convert the
installed ESPS (or a binary distribution) to X windows.   If it was not
on your distribution media and you need it, contact Entropic.
.sh 1 "ATT vs UCB Universe for Masscomp (Concurrent)"
.pp
ESPS is to be compiled under the \fIucb\fR universe.  Since the library
will be built under \fIucb\fR in most cases, user programs will also
have to be compiled under \fIucb\fR.  Please be sure that your user's
understand this.   Before running the install script, be sure you are in
the \fIucb\fR universe by giving the command:
.br
.ta 4i
.ft CW
.nf
% universe ucb
.ft LR
.fi
.sh 1 "Run the Install Script"
.pp
After you have checked and reset any installation variables you simply
run the script.   It is a good idea to capture the standard error and
standard output from the install script into a log file.
The following example assumes that you are using the cshell( \fIcsh\fR).
.br
.ft CW
.nf
% cd
% cd esps/general
% install  >& log &
.fi
.ft LR
.pp
To watch the log file during while the install script runs do:
.br
.nf
.ft CW
% tail -f log
.fi
.ft LR
.pp
This will run the install script and save all output in the file named
\fIlog\fR.   You can monitor the progress of the install by using
\fItail -f\fR.  (\fITail\fR shows the last few lines of a file.  The -f
option causes it to print additional lines as they are added to the
file.  Note that \fItail\fR with the -f option does not ever exit.  It
has no way of knowing that the file being watched will not have any
additional text added to it.   If you are watching the install with
\fItail\fR, you must kill it with control-C, or whatever your
\s-1UNIX\s+1 interrupt character is, when you see the message indicating
the end of the ESPS install script.)   When the install script completes
it will print the message:
.ft CW
ESPS general part of installation done (followed by the data/time).
.ft LR
.pp
If something goes wrong and you need to stop the installation process,
just use the \s-1UNIX\s+1 \fIkill\fR command to kill the process.  You
can supply the process number(s) printed after the install command, or
the \fIcsh\fR job number supplied by the \fIjob\fR command.
.br
.nf
.ft CW
% jobs
 [1]  +Running   install  >& log
% kill %1
.fi
.ft LR
.sh 1 "Checking the Results"
.pp
The install script produces a large amount of output (the log file will
be about 100K bytes).   Many of the messages from \fImake\fR might look
like errors, but they are normal.   Each error message from \fImake\fR in the
install log, should be followed by a message from \fImake\fR saying that
it is ignoring the error.   All of these are expected.   Any unexpected
errors will not be ignored and will cause the \fImake\fR to stop.
A few C programs produce warnings about
unreachable statements, depending on some installation variables.  These
can be ignored.
.pp
There might be a few messages at the end from \fIawk\fR that look like
errors, but they aren't.   They are from a script that builds the
database for \fIeman -k\fR.  If some optional components are not there,
then some messages like the following will be produced: \fIcan't open mana/*.*\fR.
Ignore these.  
.pp
To quickly check the log file do:
.br
.nf
.ft CW
% egrep rror log | egrep -v ignored
.ft LR
.fi
.pp
There should be no errors that are not \fIignored\fR.
.br
.nf
.ft CW
% grep rror log
.ft LR
.fi
.pp
There will be several screens of error messages, but all should be
followed by the phrase 
.ft CW
(ignored).
.ft LR
.pp
Due to a some very long lines in the \fImake\fR output, the log file 
might not be acceptable input to a text editor such as \fIvi\fR.
.pp
The \fItarget\fR directory (/usr/esps by default) should look like
this: (this example assumes the default name)
.ft CW
.br
.nf
% cd /usr/esps
% ls -F
.TS
tab(;);
l l l l.
bin/;demo/;doc/;general@
lib/;man/;include/
.TE
.pp
The bin directory should contain about 110 programs.   The doc directory
will contain about 5 documents (all of which you have in
hardcopy form).  The lib directory will contain about 30 files,
including the ESPS library, \fIlibespsg.a\fR, the ESPS lint library,
some plot programs (that are called by other programs), default
parameter files, and an example
makefile, \fImakefile.ex\fR.  The symbolic link, \fIgeneral\fR, is a
link back to the \fIgeneral\fR directory in the \fIsource\fR directory.
.pp
There is also a demo directory.  This directory contains several
demo scripts.  There is a README file in that directory.  We strongly
suggest that you take the time to try these examples.  Not only do they
provide an introduction to some ESPS commands, but they serve as a check
on the installation.
.pp
We also suggest that you use \fIeman -k\fR (followed by a keyword to
search for) to familiarize yourself with the system.  See the \fIeman\fR
manual page for details.  
.sh 1 "Setting Up the ESPS User Environment"
.pp
If you did not install ESPS into /usr/esps, it is a good idea to have
the super user install a link from its actual location to /usr/esps.
For example, if you installed ESPS in
your directory \fIespsB\fR, you could have a super-user do the
following:  (lets assume your home directory is \fI/u/smith\fR)
.br
.ft CW
.nf
# cd /usr
# ln -s /u/smith/espsB esps
.fi
.ft LR
.pp
After this is done, all users on the system can find ESPS files under
/usr/esps.  This has the advantage, that a new version of ESPS can be
installed and tested without disturbing other users on the system.  When
the ESPS maintainer is ready to switch his users over to the new
version, he simply redefines the /usr/esps symbolic link.   See the
\fIln\fR(1) man page for more information on symbolic links.
.sh 2 "Search Paths"
.pp
In order to execute ESPS programs users must place the ESPS binary
directory on their default search path.   If ESPS is installed as
described above, that path would be /usr/esps/bin.  Make sure that all
of your potential users have this on their path.
.sh 2 "ESPS Compilation Environment"
.pp
The ESPS install script creates several programs to aid users who write
their own programs using the ESPS library.   \fIecc\fR invokes the C
compiler with the correct options to cause the ESPS include files and
library to be searched.  It can be used in cases where you would
normally use the \fIcc\fR command.  Additional \fIcc\fR options can be
specified with \fIecc\fR.   The program \fIemake\fR calls the Unix 
\fImake\fR command with the
correct environment defined.  For more information on this, see
reference [1] and the \fIemake\fR manual page.  A prototype makefile
suitable for use with \fIemake\fR is in the ESPS \fIlib\fR directory.
For Masscomp systems, be sure you are in the UCB universe when compiling
ESPS programs.
.sh 1 "Installing Individual Programs"
.pp
The install script, by default, changes to each ESPS source directory
and runs \fIemake\fR.  
If a list of source
directories are given on the \fIinstall\fR command line, then only these
will be made.   The names given, must be exactly the directory name
under esps/general/src.  Note that this is not always exactly the
same as the installed name of the program.   
.pp
You can also compile (or recompile if you've made some change) a
particular ESPS program by changing to its source directory and running
\fIemake install\fR.  For example to recompile and install \fIfft\fR you
would do:
.nf
.ft CW
% cd /usr/esps/general/src/fft
% emake install
.ft R
.fi
.pp
This will result in the makefile in that directory being run using the
environment saved in the \fIemake\fR script by the main installation
script.   For more about using \fIemake\fR and compiling ESPS programs
see reference [1].
.sh 1 "Machine Dependent Programs"
.pp
Almost all of the programs in this distribution work on all supported 
machines.  There are, however, a few cases where completely different
versions of programs are required on different machine types.  The correct
program will be compiled and installed depending on the value of the 
machine type variable \fBMACH\fR.   An example of such a program is
\fIrange\fR.
.sh 1 "A Word about the Speech I/O Programs"
.pp
The speech input and output programs, \fImcplay\fR and \fImcrecord\fR
use the C defines \fBADDEV\fR, \fBDADEV\fR, and \fBCLKDEV\fR to determine
the analog-to-digital device, the digital-to-analog device, and the data
acquisition clock.  These symbols are defined in the install script.
These programs are linked to \fIplay\fR and \fIrecord\fR.
.pp
If you have trouble with \fIplay\fR or \fIrecord\fR call Entropic for
help.
.sh 1 "In Case of Difficulty"
.pp
If you have questions about the installation process, or have
difficultly running the script please call Entropic for help.
.sp
.TS
center, tab(;);
L L.
Entropic Speech, Inc.
[phone];[e-mail] (uunet!epiwrl!esps)
Washington, DC.
.TE