include/wman.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, by the GROMACS development team, led by
   8  * David van der Spoel, Berk Hess, Erik Lindahl, and including many
   9  * others, as listed in the AUTHORS file in the top-level source
  10  * directory and at http://www.gromacs.org.
  11  *
  12  * GROMACS is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public License
  14  * as published by the Free Software Foundation; either version 2.1
  15  * of the License, or (at your option) any later version.
  16  *
  17  * GROMACS is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with GROMACS; if not, see
  24  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
  25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  26  *
  27  * If you want to redistribute modifications to GROMACS, please
  28  * consider that scientific software is very special. Version
  29  * control is crucial - bugs must be traceable. We will be happy to
  30  * consider code for inclusion in the official distribution, but
  31  * derived work must not be called official GROMACS. Details are found
  32  * in the README & COPYING files - if they are missing, get the
  33  * official version at http://www.gromacs.org.
  34  *
  35  * To help us fund GROMACS development, we humbly ask that you cite
  36  * the research papers on the package. Check out http://www.gromacs.org.
  37  */
  38
  39 #ifndef _wman_h
  40 #define _wman_h
  41
  42
  43 #include "readinp.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 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 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                gmx_bool bHidden);
  61
  62 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 char *check_tex(const char *s);
  71
  72 char *check_tty(const char *s);
  73
  74 /* FIXME: It should not be necessary to expose the struct */
  75 struct t_linkdata;
  76
  77 void
  78 print_tty_formatted(FILE *out, int nldesc, const char **desc, int indent,
  79                     struct t_linkdata *links, const char *program, gmx_bool bWiki);
  80
  81 #ifdef __cplusplus
  82 }
  83 #endif
  84
  85 #endif  /* _wman_h */