src/contrib/options.c

   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.0
  11  *
  12  * Copyright (c) 1991-2001
  13  * BIOSON Research Institute, Dept. of Biophysical Chemistry
  14  * University of Groningen, The Netherlands
  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  * Do check out http://www.gromacs.org , or mail us at gromacs@gromacs.org .
  32  *
  33  * And Hey:
  34  * GROup of MAchos and Cynical Suckers
  35  */
  36
  37
  38 #include "typedefs.h"
  39 #include "macros.h"
  40 #include "statutil.h"
  41 #include "copyrite.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 main(int argc,char *argv[])
  52 {
  53   static char *desc[] = {
  54     "All GROMACS programs have 6 standard options,",
  55     "of which some are hidden by default:"
  56   };
  57
  58   static char *bugs[] = {
  59     "If the configuration script found Motif or Lesstif on your system, "
  60     "you can use the graphical interface (if not, you will get an error):[BR]"
  61     "[TT]-X[tt] bool [TT]no[tt] Use dialog box GUI to edit command line options",
  62
  63     "When compiled on an SGI-IRIX system, all GROMACS programs have an "
  64     "additional option:[BR]"
  65     "[TT]-npri[tt] int [TT]0[tt] Set non blocking priority (try 128)",
  66
  67     "Optional files are not used unless the option is set, in contrast to "
  68     "non optional files, where the default file name is used when the "
  69     "option is not set.",
  70
  71     "All GROMACS programs will accept file options without a file extension "
  72     "or filename being specified. In such cases the default filenames will "
  73     "be used. With multiple input file types, such as generic structure "
  74     "format, the directory will be searched for files of each type with the "
  75     "supplied or default name. When no such file is found, or with output "
  76     "files the first file type will be used.",
  77
  78     "All GROMACS programs with the exception of [TT]mdrun[tt], "
  79     "[TT]nmrun[tt] and [TT]eneconv[tt] check if the command line options "
  80     "are valid.  If this is not the case, the program will be halted.",
  81
  82     "Enumerated options (enum) should be used with one of the arguments "
  83     "listed in the option description, the argument may be abbreviated. "
  84     "The first match to the shortest argument in the list will be selected.",
  85
  86     "Vector options can be used with 1 or 3 parameters. When only one "
  87     "parameter is supplied the two others are also set to this value.",
  88
  89     "For many GROMACS programs, the time options can be supplied in different "
  90     "time units, depending on the setting of the [TT]-tu[tt] option.",
  91
  92     "All GROMACS programs can read compressed or g-zipped files. There "
  93     "might be a problem with reading compressed [TT].xtc[tt], "
  94     "[TT].trr[tt] and [TT].trj[tt] files, but these will not compress "
  95     "very well anyway.",
  96
  97     "Most GROMACS programs can process a trajectory with less atoms than "
  98     "the run input or structure file, but only if the trajectory consists "
  99     "of the first n atoms of the run input or structure file.",
 100
 101     "Many GROMACS programs will accept the [TT]-tu[tt] option to set the "
 102     "time units to use in output files (e.g. for [TT]xmgr[tt] graphs or "
 103     "[TT]xpm[tt] matrices) and in all time options."
 104   };
 105
 106   CopyRight(stderr,argv[0]);
 107   parse_common_args(&argc,argv,0,
 108                     0,NULL,0,NULL,asize(desc),desc,asize(bugs),bugs);
 109
 110   thanx(stderr);
 111
 112   return 0;
 113 }