-------------------------PROLOGUE---------------------------------------
--                                                                    -*
-- Unit name    :  HELP_UTILITY                         spec
-- Date created :  28 January 1985
-- Last update  :
--                                                                    -*
------------------------------------------------------------------------
--                                                                    -*
-- Abstract     : VAX like HELP Utility. There are three procedures:
----------------: 1) Initialize - reads the help file into a data structure
----------------: 2) Help_Me - the help driver
----------------: 3) Terminate_help - terminates the help utility
----------------:
----------------: A function is provided to check if help is active
--                                                                    -*
------------------------------------------------------------------------
--
-- Mnemonic     :
-- Name         :
-- Release date :
------------------ Revision history ------------------------------------
--
-- DATE  AUTHOR   HISTORY
--
--
--

--------------------END-PROLOGUE----------------------------------------
package Help_Utility is

    Illegal_Format_For_Help_File : exception;
    Help_File_Does_Not_Exist : exception;
    Cannot_Open_Help_File : exception;
    Help_File_Not_Initialized : exception;
    Nothing_To_Output : exception;

    procedure Initialize (Help_File_Name : in String);

    procedure Help_Me (Cli_Buffer : in String);

    procedure Get_Text_Line (Line : out String;
                             Char_Count : out Natural;
                             Is_Last : out Boolean);

    procedure Exit_Help;

    procedure Reset_Help;

    function Help_Is_Terminated return Boolean;

end Help_Utility;