Latest modification 1 May 1993 by T.W.Tan
Latest modification 3 March 1993 by T.W.Tan
Latest modification 3 February 1993 by T.W.Tan
27 December 1992 by T.W.Tan
----------------------------------------------------------------------------

                              HYBROW version 1.3
                          Copyright (c) December 1992
                                     by
                         Derek K.B.Kiong and T.W. Tan
                       National University of Singapore


HYBROW is a Unix program for directory browsing, software interfacing 
and hypertext.  It is written in the C language and has been tested on
the following platforms: Ultrix version 4.2, SunOS, AIX, CONVEX and SGI.

It has been designed primarily for biocomputing software and network
information retrieval but the program is general enough to be used for other
types of software.

This program is obtained by anonymous FTP to nuscc.nus.sg using binary mode
transfer of the file /pub/biocomp/hybrow.tar.Z or later updates.

1. Save this file as hybrow.tar.Z in the desired directory, eg.
   /usr/local/hybrow

2. Uncompress and untar the file
   %  uncompress hybrow.tar.Z
   %  tar -xvf hybrow.tar

3. You will now have the following 30 files in your directory.


Please read these
-rw-r--r--  1 rp900323     6015 Dec 27 18:22 INSTALLATION
-rw-r--r--  1 rp900323     4706 Dec 27 18:22 README

The Source Code
-rw-r--r--  1 rp900323      854 Dec 27 18:22 Makefile
-rw-r--r--  1 rp900323     3415 Dec 27 18:22 main.c
-rw-r--r--  1 rp900323    19057 Dec 27 18:22 hybrow.c
-rw-r--r--  1 rp900323    10086 Dec 27 18:22 mx.c
-rw-r--r--  1 rp900323      948 Dec 27 18:22 screen.c
-rw-r--r--  1 rp900323     1499 Dec 27 18:22 searchpath.c
-rw-r--r--  1 rp900323     1684 Dec 27 18:22 def.h
-rw-r--r--  1 rp900323                       ngopher.c

Files HYBROW needs
-rw-r--r--  1 rp900323     1004 Dec 27 18:22 help
-rw-r--r--  1 rp900323     1298 Dec 27 18:22 help.brow
-rw-r--r--  1 rp900323      957 Dec 27 18:22 info.brow
-rw-r--r--  1 rp900323      252 Dec 27 18:23 .hybrowrc
-rw-r--r--  1 rp900323    12510 Dec 27 18:22 start

Tutorial and associated files and directory
-rw-r--r--  1 rp900323     5800 Dec 27 18:22 customization_help
-rw-r--r--  1 rp900323     1022 Dec 27 18:22 menutemplate
-rw-r--r--  1 rp900323     1124 Dec 27 18:22 sample
-rw-r--r--  1 rp900323     1450 Dec 27 18:22 sample01
-rw-r--r--  1 rp900323      198 Dec 27 18:22 sampledict
-rw-r--r--  1 rp900323      289 Dec 27 18:22 sampleheader
-rw-r--r--  1 rp900323      519 Dec 27 18:22 sampletext
-rw-r--r--  1 rp900323    12480 Dec 28 12:19 tutorial
-rw-r--r--  1 rp900323     5218 Dec 28 09:48 tutorial1
-rw-r--r--  1 rp900323      656 Dec 28 09:48 tutorial2
drwxr-xr-x  2 rp900323      512 Dec 27 18:25 glossary
	-rw-r--r--  1 rp900323       31 Dec 27 18:25 word1
	-rw-r--r--  1 rp900323       29 Dec 27 18:25 word2
	-rw-r--r--  1 rp900323       29 Dec 27 18:25 word3

Tutorial executables
-rwxr-xr-x  1 rp900323      108 Dec 27 18:22 indexer
-rwxr-xr-x  1 rp900323      350 Dec 27 18:22 xdict
-rwxr-xr-x  1 rp900323      251 Dec 27 18:22 xgloss


To install this program, 

4. Edit the file "Makefile" as follows
   a. change the value of HOME to your own directory.
   b. change the value of CC to the compiler you wish to use.
   c. for Ultrix add -DCURSESX to CFLAGS
      for SUNs and other environments without setenv, add -DSETENV
      to CFLAGS
      for SUNs with proto-compiler, add -DNOPROTO as well.
      for SGIs, add -DSGI -DUSG3TTY
      for AIX, add -D_BSD
      for CONVEX, add -DCONVEX

5. Edit the file "def.h" as follows
   a. Scroll through the file and pick up values you need to set.
      Examples include the DEFAULTEDITOR and DEFAULTPAGER variables
      and the GOPHERSERVER and GOPHERPORT values.

6. Exit to the unix prompt and enter the command
      %    make
   a. watch carefully to spot any errors during the compilation of the
      program.  If there are no serious warning or error messages,
      then the program should work.  If not, contact the authors (see below)
   b. If the program is successfully compiled, the following files should
      be present,  *.o  object files, and the executable, hybrow.

7. Edit the .hybrowrc variables file to change or set additional
      variables if you wish.

8. Enter the command
      hybrow 
   and check if you see the first menu, corresponding to the contents
   of the file "start".

   From the start menu, there will be hypertext instructions on how
   to get yourself started.

   Check also the variables file .hybrowrc is in the default start
      directory with the correct variables used in hybrow menus preset.
   Please make sure you change mode of the following shell scripts
      into unix executables or else you will not be able to see some
      examples in action

      % chmod +x xdict xgloss indexer

WARNING 1:

HYBROW works using the default editor as /usr/ucb/vi
and the default pager as /usr/local/bin/less

If you use a different editor or pager, make the changes in def.h
before you compile.
Note that the environmental variables $EDITOR and $PAGER are used
by HYBROW. Please make sure that these variables, if set, point to
the full path name of the text editor, eg /usr/ucb/vi, and not just vi,
because HYBROW does not search your $PATH for the commands.
If these two variables are not set, then the default in def.h are used.

WARNING 2:

On some systems, the .hybrowrc has to be exactly right, ie. there
must not be any stray lines at the beginning or at the end of the
file.  The end of the file must be properly terminated.  We have
observed this effect on the SGI platform (eg IRIX) whereas on DEC
and Suns, it doesn't seem to cause a problem. We have made a
more robust system by making HYBROW look for lines with "=";
so avoid using variable/path/file[A names with and "=" in them.


NOTE for SYSTEM MANAGERS:

1.  You will be able to monitor the usage of this program by checking the 
    file:  user_log.  Every execution of a program by the user will be logged
    in this file, PROVIDED that it is writeable to the user. So please execute   
    the command:

    %  chmod +w user_log

    (You may wish to change the name of this log file in the code:
     main.c)

2.  Please make sure you set up your variables in the .hybrowrc file
    in the start directory

3.  You may wish to change some values in the file  def.h
    eg. the help messages.

4.  The default editor may be reset using the environment variable
    EDITOR external to the program.

5.  The header information of the directory browse mode may be customised
    by editing the appropriate text in the file  mx.c

    Similarly, the name of the directory browser input file substitution
    variable name XIFILE may be changed by modifying mx.c


Acknowledgements
---------------- 

This program has been developed from the Unix port of HYTELNET by Earl Fogel
and Peter Scott, University of Saskatchewan. We thank Fredj Tekaia of the
Service d'Informatique Scientifique, Institut Pasteur, Paris for testing out
earlier versions of HYBROW on their Sun machine.  We thank Dr Alan Bleasby
for letting us test the program on the SEQNET Daresbury SGI (IRIX) machine.
We thank the director and staff of the Computer Centre, National University 
of Singapore for their support.

For answers, comments, criticisms and suggestions, please contact the
authors:

Dr Tin-Wee Tan                             Dr Derek Beng-Kee Kiong
Department of Biochemistry                 Dept of Information Systems and
National University of Singapore              Computer Science
Kent Ridge                                 National University of Singapore
SINGAPORE 0511                             Kent Ridge
Tel: (65)-7723678                          SINGAPORE 0511
Fax: (65)-7791453                          Tel: (65)-7722785
Internet: bchtantw@nuscc.nus.sg            Fax: (65)-7794580
Bitnet:   bchtantw@NUSVM                   Internet: isckbknuscc.nus.sg
