help.h File Reference

Include file for help functions. More...

#include "deprecated.h"

Go to the source code of this file.

Macros
#define	_HELP_H_DEPRECATED

Functions
void	blHelp (char *string, char *HelpFile)
void	blDoHelp (char *string, char *HelpFile)

Detailed Description

Include file for help functions.

Version

V1.3

Date

14.08.14

Copyright

(c) UCL / Dr. Andrew C. R. Martin 1993-2014

Author

Dr. Andrew C. R. Martin

Institute of Structural & Molecular Biology, University College London, Gower Street, London. WC1E 6BT.

andre.nosp@m.w@bi.nosp@m.oinf..nosp@m.org..nosp@m.uk andre.nosp@m.w.ma.nosp@m.rtin@.nosp@m.ucl..nosp@m.ac.uk

This code is NOT IN THE PUBLIC DOMAIN, but it may be copied according to the conditions laid out in the accompanying file COPYING.DOC.

The code may be modified as required, but any modifications must be documented so that the person responsible can be identified.

The code may not be sold commercially or included as part of a commercial product except as described in the file COPYING.DOC.

Description:

Usage:

Revision History:

• V1.1 07.07.14 Use bl prefix for functions By: CTP
• V1.2 31.07.14 Updated deprecation: Removed deprecated.h and added prototypes for renamed functions. By: CTP
• V1.3 14.08.14 Moved deprecated function prototypes to deprecated.h By: CTP

Definition in file help.h.

Macro Definition Documentation

#define _HELP_H_DEPRECATED

Definition at line 67 of file help.h.

Function Documentation

void blDoHelp	(	char *	string,
		char *	HelpFile
	)

Parameters

[in]	*string	String on which to give help, must include the word "help". If given on its own, sits in a loop prompting for help.
[in]	*HelpFile	The help file to search

Handles help facility. This is the normal entry point and should be supplied with the complete command including the word `help'.

e.g. DoHelp("help","foo.hlp"); or DoHelp("help bar","foo.hlp");

If help is the only word given, the routine will prompt with Help> and give help on each word typed until return is hit to exit help. If help followed by a keyword is given, help only on that topic will be supplied.

• 25.09.92 Original
• 28.09.92 Changed to call Help("Help")
• 02.10.92 Added GetKybdString() rather than gets()
• 04.01.94 Changed to fix problem with compilers which don't let you write to strings defined in double inverted commas and never assigned to a variable
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 317 of file help.c.

void blHelp	(	char *	string,
		char *	HelpFile
	)

Parameters

[in]	*string	Topic on which to provide help. If "help" or "?" then list all topics
[in]	*HelpFile	Name of help file, or "CLOSE" to close the help file

Generates help from a help file on the topic named by string. If this is `help' or `?', available topics will be listed.

Only one help file may be open at a time. Once a file is open, no check is made on the HelpFile string to check that you still require the same help file. You must first close the file before changing to a new file.

Calling: Help(NULL,"CLOSE") will close the help file.

The directory specified by the environment variable or assign specified by the #define HELPENV (normally HELPDIR) will be searched for the help file if not found in the local directory.

• 25.09.92 Original
• 28.09.92 Added HELP
• 29.09.92 Changed to file-based version
• 07.10.92 Added paging support
• 12.08.93 Correctly returns if help file not found
• 05.01.94 Handles getenv() call for Unix
• 11.03.94 Resets FirstCall to TRUE when file is closed
• 18.01.95 Calls OpenFile() rather than handling alternative directory internally. Consequently assign or envvar is called HELPDIR.
• 07.07.14 Use bl prefix for functions By: CTP

Definition at line 172 of file help.c.