2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2006, The GROMACS development team.
6 * Copyright (c) 2013,2014, by the GROMACS development team, led by
7 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8 * and including many others, as listed in the AUTHORS file in the
9 * top-level source directory and at http://www.gromacs.org.
11 * GROMACS is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public License
13 * as published by the Free Software Foundation; either version 2.1
14 * of the License, or (at your option) any later version.
16 * GROMACS is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with GROMACS; if not, see
23 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 * If you want to redistribute modifications to GROMACS, please
27 * consider that scientific software is very special. Version
28 * control is crucial - bugs must be traceable. We will be happy to
29 * consider code for inclusion in the official distribution, but
30 * derived work must not be called official GROMACS. Details are found
31 * in the README & COPYING files - if they are missing, get the
32 * official version at http://www.gromacs.org.
34 * To help us fund GROMACS development, we humbly ask that you cite
35 * the research papers on the package. Check out http://www.gromacs.org.
43 #include "gromacs/commandline/pargs.h"
46 * This program is needed to create the files:
49 * for the html and latex manuals.
50 * It should be ran with the option: -hidden
54 gmx_options(int argc, char *argv[])
56 const char *desc[] = {
57 "GROMACS programs have some standard options,",
58 "of which some are hidden by default:"
61 const char *bugs[] = {
62 "If the configuration script found Motif or Lesstif on your system, "
63 "you can use the graphical interface (if not, you will get an error):[BR]"
64 "[TT]-X[tt] gmx_bool [TT]no[tt] Use dialog box GUI to edit command line options",
66 "Optional files are not used unless the option is set, in contrast to "
67 "non-optional files, where the default file name is used when the "
70 "All GROMACS programs will accept file options without a file extension "
71 "or filename being specified. In such cases the default filenames will "
72 "be used. With multiple input file types, such as generic structure "
73 "format, the directory will be searched for files of each type with the "
74 "supplied or default name. When no such file is found, or with output "
75 "files the first file type will be used.",
77 "All GROMACS programs with the exception of [TT]mdrun[tt] "
78 "and [TT]eneconv[tt] check if the command line options "
79 "are valid. If this is not the case, the program will be halted.",
81 "Enumerated options (enum) should be used with one of the arguments "
82 "listed in the option description, the argument may be abbreviated. "
83 "The first match to the shortest argument in the list will be selected.",
85 "Vector options can be used with 1 or 3 parameters. When only one "
86 "parameter is supplied the two others are also set to this value.",
88 "All GROMACS programs can read compressed or g-zipped files. There "
89 "might be a problem with reading compressed [TT].xtc[tt], "
90 "[TT].trr[tt] and [TT].trj[tt] files, but these will not compress "
93 "Most GROMACS programs can process a trajectory with fewer atoms than "
94 "the run input or structure file, but only if the trajectory consists "
95 "of the first n atoms of the run input or structure file.",
97 "Many GROMACS programs will accept the [TT]-tu[tt] option to set the "
98 "time units to use in output files (e.g. for [TT]xmgr[tt] graphs or "
99 "[TT]xpm[tt] matrices) and in all time options."
102 output_env_t oenv = NULL;
103 if (!parse_common_args(&argc, argv, 0,
104 0, NULL, 0, NULL, asize(desc), desc, asize(bugs), bugs, &oenv))