include/wman.h

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