1 /* GNUPLOT - help.h */
2 
3 /*[
4  * Copyright 1986 - 1993, 1998, 2004   Thomas Williams, Colin Kelley
5  *
6  * Permission to use, copy, and distribute this software and its
7  * documentation for any purpose with or without fee is hereby granted,
8  * provided that the above copyright notice appear in all copies and
9  * that both that copyright notice and this permission notice appear
10  * in supporting documentation.
11  *
12  * Permission to modify the software is granted, but not the right to
13  * distribute the complete modified source code.  Modifications are to
14  * be distributed as patches to the released version.  Permission to
15  * distribute binaries produced by compiling modified sources is granted,
16  * provided you
17  *   1. distribute the corresponding source modifications from the
18  *    released version in the form of a patch file along with the binaries,
19  *   2. add special version identification to distinguish your version
20  *    in addition to the base release version number,
21  *   3. provide your name and address as the primary contact for the
22  *    support of your modified version, and
23  *   4. retain our contact information in regard to use of the base
24  *    software.
25  * Permission to distribute the released version of the source code along
26  * with corresponding source modifications in the form of a patch file is
27  * granted with same provisions 2 through 4 for binary distributions.
28  *
29  * This software is provided "as is" without express or implied warranty
30  * to the extent permitted by applicable law.
31 ]*/
32 
33 
34 #ifndef GNUPLOT_HELP_H
35 # define GNUPLOT_HELP_H
36 
37 #include "gp_types.h"
38 
39 /* Exit status returned by help() */
40 #define	H_FOUND		0	/* found the keyword */
41 #define	H_NOTFOUND	1	/* didn't find the keyword */
42 #define	H_ERROR		(-1)	/* didn't find the help file */
43 
44 /* Prototypes from file "help.c" */
45 
46 int  help(char *keyword, char *path, TBOOLEAN *subtopics);
47 void FreeHelp(void);
48 void StartOutput(void);
49 void OutLine(const char *line);
50 void EndOutput(void);
51 
52 #endif /* GNUPLOT_HELP_H */
53