src/tools/gmx_options.c

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