SPEECH FILING SYSTEM V3.30

INSTALLATION NOTES

July 1998

-------------------------------------------------------------
Contents

1.    Binary distribution - DOS/DJGPP Version 1
2.    Binary distribution - DOS/DJGPP Version 2
3.    Binary distribution - WIN32
4.    Binary distribution - SunOS
5.    Source distribution - DOS
6.    Source distribution - WIN32
7.    Source distribution - Unix

--------------------------------------------------------------
1.    Binary distribution - DOS/DJGPP Version 1

      These are the installation instructions for the Binary
      distribution built with version 1 of the DJGPP port of the
      GNU C compiler to DOS.  This version will work in non-DPMI
      environments (i.e. basic DOS, not under Windows).  For
      Windows-95 users, the binary distribution built with
      version 2 of the compiler should be preferred.

1.1   You need the following from the FTP site
      pitch.phon.ucl.ac.uk/pub/sfs

           msdos1/sfs330bn.zip
           demo/sfsdemo.zip

      Ensure you copy these in BINARY mode.

1.2   Create a directory, e.g. C:\SFS and unzip these:

           c:\> mkdir sfs
           c:\> cd sfs
           c:\sfs> pkunzip -d *.zip

1.3   Put the sfs\bin directory onto your path:

           c:\sfs> set PATH=c:\sfs\bin;%PATH%

      It is best to do this in your AUTOEXEC.BAT file.

1.4   Create an environment variable, SFSBASE, pointing to the
      SFS base directory:

           c:\sfs> set SFSBASE=c:\sfs

      It is best to do this in your AUTOEXEC.BAT file

1.5   If your display screen is standard VGA or is VESA
      compatible, you can use the standard SuperVGA driver
      supplied with the run-time support program GO32.EXE (part
      of the DJGPP environment).

      If your screen is not VESA compatible, you need to find and
      install other drivers from the GRX103 distribution that may
      be found in DJGPP version 1.  Then you will need to setup
      a GO32 environment variable.  See the instructions in the
      GRX distribution.

1.6   Set up environment variables for SFS to determine the
      graphics resolution, the printer type and the sound
      interface.

      Create an environment variable, GTERM, which sets the
      resolution of the display.  For example:

           c:\sfs> set GTERM=vga-16

      would set the resolution to standard VGA.  Other
      possibilities are:

           vga-256         640x480x256 colours
           svga-16         800x600x16 colours
           svga-256        800x600x256 colours
           xvga-16         1024x768x16 colours
           xvga-256        1024x768x256 colours

      Create an environment variable, GPRINT, which specifies the
      printing device.  Currently only postscript printers are
      supported:

           c:\sfs> set GPRINT=printer
      or
           c:\sfs> set GPRINT=LPT1

      Create an environment variable, DAC, which specifies the
      replay device.  The only generally available sound cards
      supported are SoundBlaster-8 and SoundBlaster-16:

           c:\sfs> set DAC=sb8
      or
           c:\sfs> set DAC=sb16

      Create an environment variable, ADC, which specifies the
      recording device.  The only generally available sound card
      supported is the SoundBlaster-16:

           c:\sfs> set ADC=sb16

      Other information about the SoundBlaster card is picked up
      from the BLASTER environment variable.

      It is best to set these variables in your AUTOEXEC.BAT file.

1.7   Create a temporary directory for GO32 to do memory paging,
      and create an environment variable which points to it:

           c:\sfs> mkdir tmp
           c:\sfs> set GO32TMP=c:\sfs\tmp

1.8   Test the distribution by running the SFSDEMO.BAT file in
      the demo subdirectory.

1.9   Set up the files bin\sfsman.bat and bin\sfsap.bat to
      perform SFS manual page search and SFS apropos search using
      tools such as find, grep, more, list, etc on your system. 
      Examples may be found in man\sfsman.bat and man\sfsap.bat.

--------------------------------------------------------------
2.    Binary distribution - DOS/DJGPP Version 2

      These are the installation instructions for the Binary
      distribution built with version 2 of the DJGPP port of the
      GNU C compiler to DOS.  This version will only work in DPMI
      environments (i.e. in a DOS box under Windows 3.1/95). 
      Ensure that the DOS environment is supplied with as much
      extended (XMS) memory as possible in the Windows
      configuration.

2.1   You need the following from the FTP site
      pitch.phon.ucl.ac.uk/pub/sfs

           msdos2/sfs330bn.zip
           demo/sfsdemo.zip

      Ensure you copy these in BINARY mode.

2.2   Create a directory, e.g. C:\SFS and unzip these:

           c:\sfs> pkunzip -d *.zip

2.3   Put the sfs\bin directory onto your path:

           c:\sfs> set PATH=c:\sfs\bin;%PATH%

      It is best to do this in your AUTOEXEC.BAT file.

2.4   Create an environment variable, SFSBASE, pointing to the
      SFS base directory:

           c:\sfs> set SFSBASE=c:\sfs

      It is best to do this in your AUTOEXEC.BAT file

2.5   If your display screen is standard VGA or is VESA
      compatible, you can use the standard SuperVGA driver
      supplied.  Otherwise you can find other drivers in the
      GRX20 distribution that comes with DJGPP version 2.  You
      will need to install these following the instructions in
      the GRX distribution.

2.6   Set up environment variables for SFS to determine the
      graphics resolution, the printer type and the sound
      interface.

      Create an environment variable, GTERM, which sets the
      resolution of the display.  For example:

           c:\sfs> set GTERM=vga-16

      would set the resolution to standard VGA.  Other
      possibilities are:

           vga-256         640x480x256 colours
           svga-16         800x600x16 colours
           svga-256        800x600x256 colours
           xvga-16         1024x768x16 colours
           xvga-256        1024x768x256 colours

      Create an environment variable, GPRINT, which specifies the
      printing device.  Currently only postscript printers are
      supported:

           c:\sfs> set GPRINT=LPT1

      Create an environment variable, DAC, which specifies the
      replay device.  The only generally available sound cards
      supported are SoundBlaster-8 and SoundBlaster-16:

           c:\sfs> set DAC=sb8
      or
           c:\sfs> set DAC=sb16

      Create an environment variable, ADC, which specifies the
      recording device.  The only generally available sound card
      supported is the SoundBlaster-16:

           c:\sfs> set ADC=sb16

      Other information about the SoundBlaster card is picked up
      from the BLASTER environment variable.

      It is best to set these variables in your AUTOEXEC.BAT file.

2.7   Create a temporary directory for memory paging, and create
      an environment variable which points to it.  For example:

           c:\sfs> mkdir tmp
           c:\sfs> set TMPDIR=c:\sfs\tmp

2.8   Test the distribution by running the SFSDEMO.BAT file in
      the demo subdirectory.

2.9   Set up the files bin\sfsman.bat and bin\sfsap.bat to
      perform SFS manual page search and SFS apropos search using
      tools such as find, grep, more, list, etc on your system. 
      Examples may be found in man\sfsman.bat and man\sfsap.bat.

----------------------------------------------------------------
3.    Binary distribution - WIN32

      These are the installation instructions for the Binary
      distribution built with Microsoft Visual C Vs 4. This
      version will only work in WIN32 environments (i.e. in a DOS
      box under Windows 95/98/NT).  Note that the software is
      still mainly controlled from the console, and the use of
      the WIN32 API is only for graphics, audio and printing. 
      The WIN32 version is not a Windows GUI version of SFS.

3.1   You need the following from the FTP site
      pitch.phon.ucl.ac.uk/pub/sfs

           win32/sfs330bn.zip
           demo/sfsdemo.zip

      Ensure you copy these in BINARY mode.

3.2   Create a directory, e.g. C:\SFS and unzip these:

           c:\sfs> pkunzip -d *.zip

3.3   Put the sfs\bin directory onto your path:

           c:\sfs> set PATH=c:\sfs\bin;%PATH%

      It is best to do this in your AUTOEXEC.BAT file.

3.4   Create an environment variable, SFSBASE, pointing to the
      SFS base directory:

           c:\sfs> set SFSBASE=c:\sfs

      It is best to do this in your AUTOEXEC.BAT file

3.5   Set up environment variables for SFS to determine the
      graphics resolution, the printer type and the sound
      interface.

      Create an environment variable, GTERM, which sets the type
      of display.  For the WIN32 version, this should be:

           c:\sfs> set GTERM=win32

      To set the default window size for graphics, set the GSIZE
      environment variable to <width>x<height>, for example:

           c:\sfs> set GSIZE=500x400

      Create an environment variable, GPRINT, which specifies the
      printing device.  Both the WIN32 printing API and a direct
      postscript driver are provided.  If you have a postscript
      printer, use:

           c:\sfs> set GPRINT=LPT1

      Otherwise, use the WIN32 driver with:

           c:\sfs> set GPRINT=winprint

      Create an environment variable, DAC, which specifies the
      replay device.  For the WIN32 version this can only be the
      WIN32 API multimedia interface:

           c:\sfs> set DAC=win32

      Create an environment variable, ADC, which specifies the
      recording device.  For the WIN32 version this can only be
      the WIN32 API multimedia interface:

           c:\sfs> set ADC=win32

      It is best to set these variables in your AUTOEXEC.BAT file.

3.6   Test the distribution by running the SFSDEMO.BAT file in
      the demo subdirectory.

3.7   Set up the files bin\sfsman.bat and bin\sfsap.bat to
      perform SFS manual page search and SFS apropos search using
      tools such as find, grep, more, list, etc on your system. 
      Examples may be found in man\sfsman.bat and man\sfsap.bat.

--------------------------------------------------------------
4.    Binary distribution - SunOS

      These are the installation instructions for the Binary
      distribution built with the GNU C compiler for Sun SPARC
      machines running SunOS 4.1.x.

4.1   You need the following from the FTP site
      pitch.phon.ucl.ac.uk/pub/sfs

           sunos/sfs330bn.tar.gz
           demo/sfsdemo.tar.gz

      Ensure you copy these in BINARY mode.

4.2   Create a directory, e.g. /app/sfs and unzip and detar
      these.  For example:

           % mkdir /app/sfs
           % cd /app/sfs
           % gunzip -c ~/sfs330bn.tar.gz | tar xvf -
           % rm ~/sfs310bn.tar.gz
           % gunzip -c ~/sfsdemo.tar.gz | tar xvf -
           % rm ~/sfsdemo.tar.gz
      
4.3   Put the sfs/bin directory onto your path in your login
      command file.

            setenv PATH /app/sfs/bin:$PATH

4.4   Create an environment variable, SFSBASE, pointing to the
      SFS base directory:

           % setenv SFSBASE /app/sfs

      It is best to do this in your login command file.

4.5   Set up environment variables for SFS to determine the
      graphics device and the sound interface.

      Create an environment variable, GTERM, which sets the
      display type.  For example:

           % setenv GTERM xterm

      This is suitable for the X11 windowing system.  For other
      terminal types, refer to the documentation.

      Create an environment variable, DAC, which specifies the
      replay device.  The only generally available replay systems
      supported are the Sun 8-bit and 16-bit audio devices:

           % setenv DAC sun8
      or
           % setenv DAC sun16

      Audio may also be piped into a script provided by you with
      the setting:

           % setenv DAC pipe

      The script $SFSBASE/bin/dacpipe is called with arguments:
      sample-rate (Hz), Sample-rate (kHz), Number of frames.

      Create an environment variable, ADC, which specifies the
      recording device.  The only generally available recording
      system supported (in SFS 3.3) is the Sun 16-bit audio
      device:

           % setenv ADC sun16

      Other settings for DAC and ADC may be found in the SFS
      documentation.

4.6   Create an environment variable, GPRINT, which specifies the
      printing device, and set up the shell script bin/postscript
      to direct output to your available printers.  Currently
      only postscript printers are supported.

      By default, printed graphics are directed to the standard
      input of the shell script bin/postscript, with a single
      argument: '0'.  The GPRINT variable can be used to select:

           1. between different printers
           2. between landscape and portrait format
           3. between A4 and A5 sized presentation
           4. between printed postscript/saved postscript and EPS

      This is performed in three stages: firstly GPRINT is set to
      a particular string, secondly the string is mapped to a
      number in the file data/digmap, thirdly the numeric
      parameter is passed to the script bin/postscript.

      The relevant section of the data/digmap file looks similar
      to this.  The first letter means Postscript, the number is
      the numeric code, and the final string is the setting of
      the GPRINT variable.

           p 0 printer 
           p 100 postscript
           p 0 ps-qms
           p 0 qms
           p 0 qms1
           p 1 postport
           p 1 ps-qms-port
           p 1 qms1-port
           p 2 ps-hp
           p 2 hp1
           p 3 ps-hp-port
           p 3 hp1-port
           p 100 stdout
           p 50 qms1-a5
           p 52 hp1-a5
           p 250 eps
           p 251 eps-port

      The numeric coding works like this:

           Even codes            => landscape
           Odd codes             => portrait
           Codes in 0-49         => A4 printed
           Codes in 50-99        => A5 printed
           Codes in 100-149      => A4 saved to file
           Codes in 150-199      => A5 saved to file
           Codes in 200-249      => A4 saved as EPS file
           Codes in 250-299      => A5 saved as EPS file

      The bin/postscript file may then switch the input stream to
      one of a number of printers, e.g.:

           case $1 in
           0)    lp -s -dqms1;;
           1)    lp -s -dqms1;;
           2)    lp -s -dhp1;;
           3)    lp -s -dhp1;;
           4)    lp -s -dqms2;;
           5)    lp -s -dqms2;;
           100)  cat >capture.ps;;
           *)    lp;;
           esac

      Note the the A5 codes have 50 subtracted before being sent
      to the script.

      Create an environment variable, GPRINT, selecting your
      printer, for example:

           % setenv GPRINT hp1

4.6   Test the distribution by running the sfsdemo.sh file in the
      demo subdirectory.

4.7   Create files bin/sfsman and bin/sfsap to perform SFS manual
      page search and SFS apropos search using tools such as man,
      grep, more, less, etc on your system.  Examples may be
      found in man/sfsman and man/sfsap.

--------------------------------------------------------------
5.    Source distribution - DOS

      These instructions refer to installation of SFS sources
      prior to recompilation or new program development.  These
      instructions refer to the DJGPP version 2 compiler only. 
      Similar instructions would apply to version 1.

5.1   Install the DJGPP version 2 port of the GNU C compiler. 
      Find your nearest centre for the SimTel achive and locate
      the SimTel/vendors/djgpp directory.  You will need the
      following files:

           v2/djdev200.zip
           v2gnu/bnu252b.zip
           v2gnu/bsn124b.zip
           v2gnu/gcc272b.zip
           v2gnu/mak373b.zip
           v2gnu/txi360b.zip
           v2tk/grx20.zip

      Be sure to download and read the README.1ST file from this
      source.  Install the DJGPP sources into their own
      directory:

           c:\> mkdir gnu
           c:\> cd gnu
           c:\gnu\> pkunzip -d \*.zip

      Put the GNU\BIN directory onto your path, and create an
      environment variable, DJGPP, to point to the general
      environment file:

           c:\gnu> set PATH=c:\gnu\bin;%PATH%
           c:\gnu> set DJGPP=c:\gnu\djgpp.env

5.2   Copy the GRX compatibility header files into the GRX
      include directory:

           c:\gnu> cd contrib\grx20\compat
           c:\gnu\contrib\grx20\compat> copy *.h ..\include

5.3   Obtain the following SFS source files from
      pitch.phon.ucl.ac.uk/pub/sfs

           msdos2/sfs330s1.zip
           msdos2/sfs330s2.zip
           demo/sfsdemo.zip

5.4   Create a directory to hold SFS and unzip the sources:

           c:\> mkdir sfs
           c:\> cd sfs
           c:\sfs> pkunzip -d sfs*.zip

5.5   Make directories to hold the executables and libraries:

           c:\sfs> mkdir bin
           c:\sfs> mkdir lib

5.6   Copy the support programs cp.exe and tee.exe from the SFS
      DOS directory to some directory on your path.  For example:

           c:\sfs\dos> copy *.exe c:\dos

5.7   Rebuild the libraries and executables:

           c:\sfs> dosmake2

      (DJGPP Version 1, would run dosmake1)

5.8   After compilation is complete, you may wish to include the
      SFS\INCLUDE directory in the C_INCLUDE_PATH setting inside
      DJGPP.ENV, and the SFS\LIB directory in the LIBRARY_PATH
      setting inside DJGPP.ENV.

      You should also put the SFS\BIN directory onto your PATH
      statement.

5.9   Set up environment variables for SFS to determine the
      graphics resolution, the printer type and the sound
      interface.
      
      See section 2.6.

5.10  Test the distribution by running the SFSDEMO.BAT file in
      the demo subdirectory.

5.11  Create files bin\sfsman.bat and bin\sfsap.bat to perform
      SFS manual page search and SFS apropos search using tools
      such as find, grep, more, list, etc on your system. 
      Examples may be found in man\sfsman.bat and man\sfsap.bat.

--------------------------------------------------------------
6.    Source distribution - WIN32

      These instructions refer to installation of SFS sources
      prior to recompilation or new program development.  These
      instructions refer to the Microsoft Visual C V4 compiler
      only.

6.1   Check that the Visual C compiler is installed correctly by
      compiling a test program.  The environent variables INCLUDE
      and LIB should point to the appropriate Microsoft
      Development tools directories.

6.2   Obtain the following SFS source files from
      pitch.phon.ucl.ac.uk/pub/sfs

           win32/sfs330s1.zip
           win32/sfs330s2.zip
           demo/sfsdemo.zip

6.3   Create a directory to hold SFS and unzip the sources:

           c:\> mkdir sfs
           c:\> cd sfs
           c:\sfs> pkunzip -d sfs*.zip

6.4   Make directories to hold the executables and libraries:

           c:\sfs> mkdir bin
           c:\sfs> mkdir lib

6.5   Copy the support programs cp.exe and tee.exe from the SFS
      DOS directory to some directory on your path.  For example:

           c:\sfs\dos> copy *.exe c:\dos

6.6   Rebuild the libraries and executables:

           c:\sfs> dosmake3

6.7   After compilation is complete, you may wish to include the
      SFS\INCLUDE directory in the INCLUDE path setting, and the
      SFS\LIB directory in the LIBRARY path.

      You should also put the SFS\BIN directory onto your PATH
      statement.

6.8   Set up environment variables for SFS to determine the
      graphics resolution, the printer type and the sound
      interface.
      
      See section 3.5

6.9   Test the distribution by running the SFSDEMO.BAT file in
      the demo subdirectory.

6.10  Create files bin\sfsman.bat and bin\sfsap.bat to perform
      SFS manual page search and SFS apropos search using tools
      such as find, grep, more, list, etc on your system. 
      Examples may be found in man\sfsman.bat and man\sfsap.bat.

--------------------------------------------------------------
7.    Source distribution - Unix

      These instructions refer to installation of SFS sources
      prior to recompilation or new program development on Unix
      systems.

7.1   Obtain the following SFS source files from
      pitch.phon.ucl.ac.uk/pub/sfs

           unix/sfs330s1.tar.gz
           unix/sfs330s2.tar.gz
           demo/sfsdemo.tar.gz

7.2   Unzip these into their own directory, e.g. /app/sfs, for
      example:

           % mkdir /app/sfs
           % cd /app/sfs
           % gunzip -c ~/sfs310s1.tar.gz | tar xvf -
           % gunzip -c ~/sfs310s2.tar.gz | tar xvf -
           % rm ~/sfs310s1.tar.gz
           % rm ~/sfs310s2.tar.gz
           % gunzip -c ~/sfsdemo.tar.gz | tar xvf -
           % rm ~/sfsdemo.tar.gz

7.3   Make a sfs/bin and a sfs/lib directory to store the
      executables and the libraries.

           % cd /app/sfs
           % mkdir bin lib

7.4   Put the sfs/bin directory onto your path in your login
      command file.

           % setenv PATH /app/sfs/bin:$PATH

7.5   Create an environment variable, SFSBASE, pointing to the
      SFS base directory:

           % setenv SFSBASE /app/sfs

      It is best to do this in your login command file.

7.6   Create a version of the SFS configuration file for your
      machine.  A number of prototype files are available for you
      to edit.  The configuration file may be found in

           include/SFSCONFG.h

      The following files may act as models:

           sfsconfg.sun    SPARC-10/SunOs
           sfsconfg.sol    SPARC-10/Solaris
           sfsconfg.hp     Hewlett-Packard 
           sfsconfg.lin    Linux

      For a typical Unix installation you will need to set up:

           1.    machine type
           2.    definition of a 32-bit integer
           3.    byte ordering
           4.    need for 64/32-bit alignment problem fix (yes for
                 RISC, no for x86 architectures)
           5.    SFS home directory
           6.    Support for X-Windows and postscript
           7.    Support for an audio input and output device

7.7   Create a top-level makefile suited to your machine.  A
      number of model makefiles are supplied.  The files

           makefile.sun    - makefile for SunOS/gcc
           makefile.sol    - makefile for Solaris/gcc
           makefile.lin    - makefile for Linux/gcc

      For a typical Unix installation you will need to set up:

           1.    home directory
           2.    compiler name and flags
           3.    make program name and flags
           4.    libraries to support graphics devices selected
           5.    libraries to support sound devices selected

7.8   Make the libraries and executables:

           % cd /app/sfs
           % make -f yourmakefile

7.9   Extract the manual pages from the sources:

           % make -f yourmakefile manpages

7.10  Set up environment variables for SFS to determine the
      graphics device, the printer type and the sound interface. 
      Also set up the shell scripts for printing and replay.

      See section 4.5.

7.11  Test the distribution by running the sfsdemo.sh file in the
      demo subdirectory.

7.12  Create files bin/sfsman and bin/sfsap to perform SFS manual
      page search and SFS apropos search using tools such as man,
      grep, more, less, etc on your system.  Examples may be
      found in man/sfsman and man/sfsap.

--------------------------------------------------------------
This software is copyright University College London 1987-1998. 
No part of the software may be sold, but copies may be made and
the software modified and distributed free of charge providing
the copyright of University College London continues to be
demonstrated.

This software bears no warranty or guarantee of any kind.

UCL and Mark Huckvale are unable to support this software. While
bug-fixes are welcome, requests for help may be ignored.

Mark Huckvale
Phonetics and Linguistics
University College London
Gower Street
London WC1E 6BT
SFS@phon.ucl.ac.uk