git.maemo.org Git - gnuplot/blob - src/help.h

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