src/gromacs/onlinehelp/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 #ifndef GMX_ONLINEHELP_WMAN_H
  36 #define GMX_ONLINEHELP_WMAN_H
  37
  38 #include "readinp.h"
  39 #include "gromacs/fileio/filenm.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 void write_man(const char *mantp, const char *program,
  46                int nldesc, const char **desc,
  47                int nfile, t_filenm *fnm,
  48                int npargs, t_pargs *pa,
  49                int nbug, const char **bugs);
  50
  51 char *fileopt(unsigned long flag, char buf[]);
  52 /* Return a string describing the file type in flag.
  53  * flag should the flag field of a filenm struct.
  54  * You have to provide a buffer and buffer length in which
  55  * the result will be written. The returned pointer is just
  56  * a pointer to this buffer.
  57  */
  58
  59 char *check_nroff(const char *s);
  60 char *check_html(const char *s);
  61 char *check_tty(const char *s);
  62
  63 #ifdef __cplusplus
  64 }
  65 #endif
  66
  67 #endif