include/wman.h

   1 /*
   2  *
   3  *                This source code is part of
   4  *
   5  *                 G   R   O   M   A   C   S
   6  *
   7  *          GROningen MAchine for Chemical Simulations
   8  *
   9  *                        VERSION 3.2.0
  10  * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
  11  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  12  * Copyright (c) 2001-2004, The GROMACS development team,
  13  * check out http://www.gromacs.org for more information.
  14
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * If you want to redistribute modifications, please consider that
  21  * scientific software is very special. Version control is crucial -
  22  * bugs must be traceable. We will be happy to consider code for
  23  * inclusion in the official distribution, but derived work must not
  24  * be called official GROMACS. Details are found in the README & COPYING
  25  * files - if they are missing, get the official version at www.gromacs.org.
  26  *
  27  * To help us fund GROMACS development, we humbly ask that you cite
  28  * the papers on the package - you can find them in the top README file.
  29  *
  30  * For more info, check our website at http://www.gromacs.org
  31  *
  32  * And Hey:
  33  * Gromacs Runs On Most of All Computer Systems
  34  */
  35
  36 #ifndef _wman_h
  37 #define _wman_h
  38
  39 #ifdef HAVE_CONFIG_H
  40 #include <config.h>
  41 #endif
  42
  43 #include "readinp.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 extern void write_java(FILE *out,const char *program,
  50                        int nldesc,const char **desc,
  51                        int nfile,t_filenm *fnm,
  52                        int npargs,t_pargs *pa,
  53                        int nbug,const char **bugs);
  54
  55 extern void write_man(FILE *out,const char *mantp,const char *program,
  56                       int nldesc,const char **desc,
  57                       int nfile,t_filenm *fnm,
  58                       int npargs,t_pargs *pa,
  59                       int nbug,const char **bugs,
  60                       bool bHidden);
  61
  62 extern char *fileopt(unsigned long flag,char buf[],int maxsize);
  63 /* Return a string describing the file type in flag.
  64  * flag should the flag field of a filenm struct.
  65  * You have to provide a buffer and buffer length in which
  66  * the result will be written. The returned pointer is just
  67  * a pointer to this buffer.
  68  */
  69
  70 extern char *check_tex(const char *s);
  71
  72 extern char *check_tty(const char *s);
  73
  74 /* FIXME: It should not be necessary to expose the struct */
  75 struct t_linkdata;
  76
  77 extern void
  78 print_tty_formatted(FILE *out, int nldesc, const char **desc, int indent,
  79                     struct t_linkdata *links, const char *program, bool bWiki);
  80
  81 #ifdef __cplusplus
  82 }
  83 #endif
  84
  85 #endif  /* _wman_h */
  86
  87