Okapi-Pack

Centre For Interactive Systems Research
City University
London EC1V 0BH


Appendix A:   The OKAPI_ROOT directory.

The contents of <OKAPI_ROOT> (after the files have been extracted from the tar file) will be:


1. IndexLogs/

Logfiles of indexing runs.


2. OkapiLogs/

Logfiles of searches using the Okapi interface, "okapi".


3. bibfiles/

Converted database and indexes. The distribution comes with a converted, indexed cacm.sample database.

    cacm.sample.0.di
    cacm.sample.0.dlens
    cacm.sample.0.oi
    cacm.sample.0.pi
    cacm.sample.0.si
    cacm.sample.1.di
    cacm.sample.1.dlens
    cacm.sample.1.oi
    cacm.sample.1.pi
    cacm.sample.1.si
    cacm.sample.2.di
    cacm.sample.2.dlens
    cacm.sample.2.oi
    cacm.sample.2.pi
    cacm.sample.2.si
    cacm.sample.bib
    cacm.sample.bibdir


4. bin/


Table 4.1. Okapi Binaries.
convert_runtime Converts an Okapi exchange format file into an Okapi database.
ix1 First stage indexing program.
ixf Second stage indexing program.
i1+ Command line interface to the BSS


5. databases/


Table 5.1. Database Parameter Files.
cacm.sample Main parameter file for sample CACM database.
cacm.sample.field_types Field types parameter file for sample CACM database.
cacm.sample.search_groups Index types parameter file for sample CACM database.
db_avail List of databases and who has access to them.
gsl.cacm Sample gsl file for the CACM database
gsl.empty Empty GSL file. DO NOT remove this; it is needed for indexes that do not use one.
gsl.med Sample gsl file for the Medlars database
med.sample Main parameter file for sample Medlars database.
med.sample.field_types Field types parameter file for sample Medlars database.
med.sample.search_groups Index types parameter file for sample Medlars database.


6. datafiles/


Table 6.1. Okapi Exchange Format Files.
cacm.exch CACM source data in Okapi exchange format.
med.exch Medlars source data in Okapi exchange format.


7. docs/

Miscellaneous documentation, including two files read by the indexer application.


8. dot-files/


Table 8.1. Copies of the System Configuration Files.
dot.indexing_rc Copy of .indexing_rc
dot.okapi_db Copy of .okapi_db
dot.okapi_rc Copy of .okapi_rc
dot.cshrc Lines to be appended to your .cshrc file so that the environment variables are set up when you log on.


9. indexing/


Table 9.1. C/C++ and Tcl/Tk Source Files For The Indexing Program.
src/
    GLOB.h
    Makefile
    gui.cc
    indexing.c
    interface.cc
    inx-defs.h
    tclinit.cc
    utilities.c
tcl/
    interface.tcl
    procedures.tcl
    tclIndex


10. interface/


Table 10.1. C/C++ and Tcl/Tk source files for interface program.
bss_defs/
    bss.h
    bss_protos.h
    i0_defs.h
    site.h
    bss_defaults.h
    charclass.h
    para.h
    y.tab.h
    bss_errors.h
    defines.h
    parms.h
src/
    GLOB.h
    Makefile
    define.c
    defs.h
    display.c
    expand.c
    extract.c
    fileutils.c
    gui.cc
    header.c
    hitlist.c
    initialise.c
    interface.cc
    makerj.c
    remove.c
    restore.c
    search.c
    show.c
    sorts.c
    tclinit.cc
    utilities.c
    weighting.c
tcl/
    interface.tcl
    procedures.tcl
    tclIndex


11. lib/


Table 11.1. BSS library program.
 
    libi0+.a


12. using_the_bss


Table 12.1. Examples of the use of the BSS program.
awk_perl
    NOTHING YET.
c_examples
    Makefile
    README
    defs.h
    ok-test.c
    query_terms


13. System Configuration Files/

Indexer Configuration .indexing_rc
Interface Databases .okapi_db
Interface Configuration .okapi_rc


Okapi-Pack Main Menu Mail Okapi Support Registration

Last modified:   12th November 2001