2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2012, by the GROMACS development team, led by
5 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
6 * others, as listed in the AUTHORS file in the top-level source
7 * directory and at http://www.gromacs.org.
9 * GROMACS is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public License
11 * as published by the Free Software Foundation; either version 2.1
12 * of the License, or (at your option) any later version.
14 * GROMACS is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with GROMACS; if not, see
21 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 * If you want to redistribute modifications to GROMACS, please
25 * consider that scientific software is very special. Version
26 * control is crucial - bugs must be traceable. We will be happy to
27 * consider code for inclusion in the official distribution, but
28 * derived work must not be called official GROMACS. Details are found
29 * in the README & COPYING files - if they are missing, get the
30 * official version at http://www.gromacs.org.
32 * To help us fund GROMACS development, we humbly ask that you cite
33 * the research papers on the package. Check out http://www.gromacs.org.
35 /*! \defgroup module_commandline Command Line Parsing and Help
36 * \ingroup group_utilitymodules
38 * Provides functionality for parsing command-line arguments and writing help.
40 * This module implements gmx::CommandLineParser that assigns values to
41 * gmx::Options (see \ref module_options) based on command-line arguments.
42 * gmx::CommandLineHelpWriter is also provided to write help text for a program
43 * that uses the parser.
45 * \author Teemu Murtola <teemu.murtola@gmail.com>
49 * Public API convenience header for handling command-line parameters.
51 * \author Teemu Murtola <teemu.murtola@gmail.com>
53 * \ingroup module_commandline
55 #ifndef GMX_COMMANDLINE_H
56 #define GMX_COMMANDLINE_H
58 #include "commandline/cmdlinehelpwriter.h"
59 #include "commandline/cmdlineparser.h"