src/gromacs/gmxana/gmx_options.c

   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.3.99_development_20071104
  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-2006, 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  * Groningen Machine for Chemical Simulation
  34  */
  35 #ifdef HAVE_CONFIG_H
  36 #include <config.h>
  37 #endif
  38
  39 #include "typedefs.h"
  40 #include "macros.h"
  41 #include "statutil.h"
  42
  43 /*
  44  * This program is needed to create the files:
  45  *   options.html
  46  *   options.tex
  47  * for the html and latex manuals.
  48  * It should be ran with the option: -hidden
  49  */
  50
  51 int
  52 gmx_options(int argc, char *argv[])
  53 {
  54     const char  *desc[] = {
  55         "GROMACS programs have some standard options,",
  56         "of which some are hidden by default:"
  57     };
  58
  59     const char  *bugs[] = {
  60         "If the configuration script found Motif or Lesstif on your system, "
  61         "you can use the graphical interface (if not, you will get an error):[BR]"
  62         "[TT]-X[tt] gmx_bool [TT]no[tt] Use dialog box GUI to edit command line options",
  63
  64         "When compiled on an SGI-IRIX system, all GROMACS programs have an "
  65         "additional option:[BR]"
  66         "[TT]-npri[tt] int [TT]0[tt] Set non blocking priority (try 128)",
  67
  68         "Optional files are not used unless the option is set, in contrast to "
  69         "non-optional files, where the default file name is used when the "
  70         "option is not set.",
  71
  72         "All GROMACS programs will accept file options without a file extension "
  73         "or filename being specified. In such cases the default filenames will "
  74         "be used. With multiple input file types, such as generic structure "
  75         "format, the directory will be searched for files of each type with the "
  76         "supplied or default name. When no such file is found, or with output "
  77         "files the first file type will be used.",
  78
  79         "All GROMACS programs with the exception of [TT]mdrun[tt] "
  80         "and [TT]eneconv[tt] check if the command line options "
  81         "are valid.  If this is not the case, the program will be halted.",
  82
  83         "Enumerated options (enum) should be used with one of the arguments "
  84         "listed in the option description, the argument may be abbreviated. "
  85         "The first match to the shortest argument in the list will be selected.",
  86
  87         "Vector options can be used with 1 or 3 parameters. When only one "
  88         "parameter is supplied the two others are also set to this value.",
  89
  90         "All GROMACS programs can read compressed or g-zipped files. There "
  91         "might be a problem with reading compressed [TT].xtc[tt], "
  92         "[TT].trr[tt] and [TT].trj[tt] files, but these will not compress "
  93         "very well anyway.",
  94
  95         "Most GROMACS programs can process a trajectory with fewer atoms than "
  96         "the run input or structure file, but only if the trajectory consists "
  97         "of the first n atoms of the run input or structure file.",
  98
  99         "Many GROMACS programs will accept the [TT]-tu[tt] option to set the "
 100         "time units to use in output files (e.g. for [TT]xmgr[tt] graphs or "
 101         "[TT]xpm[tt] matrices) and in all time options."
 102     };
 103
 104     output_env_t oenv = NULL;
 105     if (!parse_common_args(&argc, argv, 0,
 106                            0, NULL, 0, NULL, asize(desc), desc, asize(bugs), bugs, &oenv))
 107     {
 108         return 0;
 109     }
 110
 111     return 0;
 112 }