alpine/help.h

   1 /*
   2  * $Id: help.h 769 2007-10-24 00:15:40Z hubert@u.washington.edu $
   3  *
   4  * ========================================================================
   5  * Copyright 2006-2007 University of Washington
   6  * Copyright 2013-2022 Eduardo Chappa
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * ========================================================================
  15  */
  16
  17 #ifndef PINE_HELP_INCLUDED
  18 #define PINE_HELP_INCLUDED
  19
  20
  21 #include "../pith/help.h"
  22
  23
  24 /*
  25  * Flags to help manage help display
  26  */
  27 #define HLPD_NONE          0
  28 #define HLPD_NEWWIN     0x01
  29 #define HLPD_SECONDWIN  0x02
  30 #define HLPD_SIMPLE     0x04
  31 #define HLPD_FROMHELP   0x08
  32
  33
  34 /* exported prototypes */
  35 int         url_local_helper(char *);
  36 int         url_local_config(char *);
  37 void        init_helper_getc(char **);
  38 int         helper_getc(char *);
  39 int         helper(HelpType, char *, int);
  40 void        review_messages(void);
  41 void        print_help(char **);
  42 #ifdef  _WINDOWS
  43 char       *pcpine_help(HelpType);
  44 #endif
  45 #ifdef  DEBUG
  46 void        dump_config(struct pine *, gf_io_t, int);
  47 void        dump_pine_struct(struct pine *, gf_io_t);
  48 #endif
  49
  50
  51 #endif /* PINE_HELP_INCLUDED */