                         UNIVERSITY OF UDINE - ITALY
                               Computer Center


                            CCUU_INDEXER  v.1.0-2




DESCRIPTION 

  Waiting for a VMS porting of Jughead...

  ...VMS Gopher Server is  able  to  search  for  a given string into files
  through your Gopher_Root; something like:

                $ search Gopher_root:[000000...]*.*.* string

  You  were  not  able  to  search through your Gopher Server's menu TITLES
  only. Now you can do it, with this utility (CCUU_INDEXER).


  Using  CCUU_INDEXER  you  can build an index of any Gopher Object defined
  into .LINKS files in your gopher root; in  such  a  database,  there's  a
  line  for  every  Gopher  Object  defined  in  every LINK file of a given
  GOPHER_ROOT; every line describes one object, using this structure:

                <type><name>[TAB]<path>[TAB]<host>[TAB]port

  Using  a proper search engine, you can now search for a given string into
  that database; output will  be  automatically  formatted  by  VMS  Gopher
  Server into a menu.

  CCUU_INDEXER010U2.ZIP   includes:  CCUUINDEX-BUILD.COM  1.0-3  (a  simple
  command procedure to examine every link  file  in  a  given  Gopher_Root,
  creating  a  CCUUINDEX database with the previously described structure),
  two SEARCH ENGINES (GTPUSEARCH (written in TPU)  &  GSEARCH  (written  in
  VAX  PASCAL),  some  *.SHELL  procedure  (interface  to VMS Search, GREP,
  GTPUSEARCH, GSEARCH), an Example .LINKS file (EXAMPLE.LINKS), and various
  documentation (plus unsupported tools). 

  CCUUINDEXER  has  been  developed  and  tested  using:  "VMSGOPHER SERVER
  1.2VMS-1 TRLN_O" with a VAX6320 running VMS 5.5-2 and Multinet V3.2  Rev.
  B.   And   it   works!   You   can   get   it  via  Anonymous  FTP  from:
  UDUNIV.CC.UNIUD.IT  [158.110.1.3]   in   subdirectory   [.GOPHER],   file
  CCUU_INDEXER010U2.ZIP;    you   can   also   get   it   via   Gopher   at
  'Gopher.Uniud.It' (same host):

  Interesting services/
      VMS Gopher Server - sources, information, servers/
        University of Udine - VMS Gopher software, tools, etc./
          Sw in aFTP root/


  For  some 'running' example of searching through a Gopher space using any
  CCUU-Indexer search engine, look via Gopher at 'Gopher.Uniud.It':

  Interesting services/
     Experimental Area (use it at your own risk!)/
        USING CCUU_Indexer/



INSTALLATION INSTRUCTION:

- create a subdirectory into your Gopher root; for example:
  
          $ CREATE/DIRECTORY GOPHER_ROOT:[_CCUU_INDEXER]

  then   restore   CCUU_INDEXER*.ZIP  file  inside  that  directory.  Three
  subdirectories ([.GSEARCH]  [.GTPUSEARCH]  and  [.OTHER_TOOLS])  will  be
  created.

- carefully  examine  CCUUINDEX-BUILD.COM; MODIFY IT to reflect your Gopher
  Server host name and port (search  for:  "Customize  these:"  using  your
  editor), and any other site modification from your 'GOPHER_CONFIG' file;

  NOTE:  CCUUINDEX-BUILD.COM will examine any .LINK file in the given root,
  using this default: "[000000...].%*;0" (this means: last version  of  any
  file  with  an  empty  file  name an a non-empty file type; starting from
  CCUU_INDEXER 1.0-1, you can modify this default passing a new default  to
  CCUUINDEX-BUILD.COM  within  P3  parameter.  See into CCUUINDEX-BUILD.COM
  for more documentation. 

  This  feature  is  useful if you use in your GOPHER_CONFIG file a "Link:"
  prefix different than default (see VMS Gopher Server Documentation).

- if   you   plan   to   use   GSEARCH   (the   Pascal   utility),   modify
  [.GSEARCH]GSEARCH.CLD to reflect the correct location  for  that  utility
  (into the IMAGE specification), then re-build GSEARCH; i.e.:

        $ SET DEFAULT [.GSEARCH]
        $ edit GSEARCH.CLD  (and modify IMAGE spec.)
        $ PASCAL GSEARCH
        $ LINK GSEARCH


- build  your  Index  using CCUUINDEX-BUILD.COM; for example:

                @CCUUINDEX_BUILD GOPHER_ROOT

  (this  should  create  a  CCUUINDEX_DB.DAT  file,  contaning an entry for
  every menu title defined in any "GOPHER_ROOT:[000000...].%*;" file)

  Warning: building an  index  could  be a *very* long operation (depending 
  from number  of  Gopher Objects and LINKfiles in your Gopher_root...), so
  be patient...

  NOTE:  CCUUINDEX_BUILD.COM  does  NOT  make any Gopher connection to your
  server; it will simply locally  scan  the  GOPHER_ROOT  (using  F$SEARCH)
  reading any link file.

  You can also scan more than a gopher root; for example:

          @CCUUINDEX_BUILD GOPHER_ROOT,GOPHER_ROOT2 MY_INDEX

  (this  should  create  a  file MY_INDEX.DAT, contaning an entry for every
  menu   title   defined   in   any    "GOPHER_ROOT:[000000...].%*;"    and
  "GOPHER_ROOT2:[000000...].%*;" file).

  Starting  from  CCUU_INDEXER  v.1.0-2,  you can also specify subdirectory
  trees; some valid example:

        @CCUUINDEX_BUILD GOPHER_ROOT,GOPHER_ROOT2:[TEST...] MY_INDEX
        @CCUUINDEX_BUILD GOPHER_ROOT:[000000],GOPHER_ROOT2:[TEST] MY_INDEX

  See into CCUUINDEX-BUILD.COM for more documentation. 

  NOTE  2:  only object EXPRESSELY DEFINED IN A LINKfile will be indexed by
  CCUU-Indexer; any other kind of  object  and  information  (simple  files
  into   a   directory,   lookaside   directories,  ACL-Resident  Lookaside
  Information, etc.) will be ignored.

  If  you  have  files  into  Gopher_Root not defined into a LinkFile, they
  will not be indexed by CCUU_Indexer (although the Gopher  Server  can  do
  it);  look  for  FORCE_DIRECTORY.COM  into  [.OTHER_TOOLS] if you want to
  manually add this files to  the  CCUU-index  (FORCE_DIRECTORY  is  simply
  experimental, unsupported - use it at your own risk). 

  NOTE  3:  *WARNING*:  strange  things  happen  with  the Gopher Server if
  incomplete tuples are present in a link file (e.g.  missing  'path=',  or
  'type=',  etc.):  this  can  lead  to  partially  inconsistent  directory
  listings. And the same problem can occur with CCUU_INDEXER  utility.  So:
  always  check  your  link-files  syntax  before  use them with the Gopher
  Server and/or the CCUU_Indexer utility.

- you  can  now  define a 'search' item in your Gopher menu to search for a
  given string into  the  newly  created  database  (see  an  example  into
  EXAMPLES.LINKS).

  PLEASE  NOTE: GREP.SHELL amd VMSSEARCH.SHELL matches the specified string
  using entire Gopher Object definitions (Name + Path + Host +  Port);  you
  should  use GSEARCH (if you've VAX PASCAL) or GTPUSEARCH to search string
  only in NAME= fields.

- rebuild  your  index periodically  (for  example: every night) to reflect
  changes to your Gopher Server's 


    ********************************************************************

                             D I S C L A I M E R

    CCUU_INDEXER  has  been  developed  by  F. Brunetta at University of
    Udine (Italy) - Computer Center.

    This  utility is  free  software; you can redistribute and modify it
    without restriction, provided that you  don't  incorporate  it  into
    proprietary programs. 

    You're  pleased  to  notify  any  substantial  modification  to this
    program mailing it to: Brunetta@CC.Uniud.It

    This  program is distributed in the hope that it will be useful, but
    WITHOUT  ANY  WARRANTY;  without  even  the  implied   warranty   of
    MERCHANTABILITY  or  FITNESS  FOR  A PARTICULAR PURPOSE. 
    ********************************************************************


Author's signature:

mmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmm
  Francesco Brunetta, OpenVMS System Manager,  University of Udine, Italy 
                          Phone nr.         +39 432 556705  
+---------------------+   E-mail: Internet: Brunetta@CC.Uniud.It (for everyone)
| The Lone Manager!   |                     Franco@CC.Uniud.It   (for friends)
+---------------------+           DECnet:   UDUNIV::FRANCO (37963::FRANCO)
                          Talk & Finger:    FRANCO@UDUNIV.CC.UNIUD.IT
WWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWWW

Bye!!!

