OBJECT:
        manserver

AUTHOR:
        Softbyte

VERSION:
        V1.0

LAST UPDATE:
        Thu Jan 15 19:43:45 1998

SYNOPSIS:        
        used by the man command
        

DESCRIPTION:        
        The manserver serves as interface between the man command in std/player
        and the doc directory /doc. It maintains keyword and alias search for
        the documents.
        
        

PUBLIC FUNCTIONS


        varargs void CreateServer(int force)
        Creates all subserver *.c files in the subdirectory 'man'
        
        Parameter:
          int force
          if force is given the files are created regardless whether the
          do already exist

        varargs mixed *GetKeyword(string key,string section)
        Gets a keyword array from the database. Its format is
        ({ ({filename,line1,line2}), ... }). If line1 is <0 the whole
        file is meant otherwise only the part between line1..line2-1
        
        Parameter:
          string key
          The keyword which shall be searched
          string section
          An optional parameter which restricts the search only to the given
          section

        string *GetSections()
        Gets all possible section names
        
        Return Value:
          A string array holding the section names

        string *GetKeywords(string section)
        Gets all possible keywords of a given section
        
        Parameter:
          string section
          The section for which the keywords shall be returned
          
        Return Value:
          A string array holding all keywords

        int InitSection(string section)
        Reinitialises a given section to reread new man files
        
        Parameter:
          string section
          The section for which the keywords shall be returned
          
        Return Value:
          0: Failure, 1: Ok

        varargs string IndexFile(string fname,int verbose)
        Creates an index for the given filename and enters it into the
        database
        
        Parameter:
          string fname
          The filename of the manfile to be indexed
          int verbose
          An optional parameter which will produce some information about the
          indexing process
          
        Return Value:
          0: Ok, string: An error message
INHERITANCE
        manserver
        |-std/base