| blob | 4032c29882ee3256f7e14500ba7da9b37230d6d2 |
1 /*
2 * This file is part of the GROMACS molecular simulation package.
3 *
4 * Copyright (c) 2012,2013,2014,2015, by the GROMACS development team, led by
5 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 * and including many others, as listed in the AUTHORS file in the
7 * top-level source directory and at http://www.gromacs.org.
8 *
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.
13 *
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.
18 *
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.
23 *
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.
31 *
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.
34 */
35 /*! \defgroup module_commandline Command Line Program Management (commandline)
36 * \ingroup group_utilitymodules
37 * \brief
38 * Provides functionality for managing command line programs.
39 *
40 * This module provides utility classes and functions for implementing command
41 * line programs. They are mainly used within \Gromacs, but can also be used
42 * from external programs if they want to get a similar user experience to
43 * \Gromacs tools.
44 *
45 * The classes exposed from this module can be roughly divided into two groups:
46 *
47 * - Helper classes/functions for implementing the %main() function.
48 * See \ref page_usinglibrary for an overview of those available for user
49 * programs. These are declared in cmdlineinit.h
50 * (gmx::ICommandLineModule is declared in cmdlinemodule.h and
51 * gmx::ICommandLineOptions in cmdlineoptionsmodule.h).
52 * \if libapi
53 *
54 * Additionally, for internal \Gromacs use, gmx::CommandLineModuleManager
55 * provides the functionality to implement the `gmx` wrapper binary, as well
56 * as command line options common to all \Gromacs programs (such as
57 * `-version`).
58 * This is described in more detail at \ref page_wrapperbinary.
59 * \endif
60 *
61 * - Helper classes for particular command line tasks:
62 * - gmx::CommandLineParser implements command line parsing to assign
63 * values to gmx::Options (see \ref module_options).
64 * - gmx::CommandLineHelpWriter writes help text for a program that uses
65 * the parser.
66 * - parse_common_args() is an old interface to \Gromacs command line
67 * parsing. This is still used by many parts of \Gromacs.
68 *
69 * \author Teemu Murtola <teemu.murtola@gmail.com>
70 */
71 /*! \file
72 * \brief
73 * Public API convenience header for managing command line programs.
74 *
75 * \author Teemu Murtola <teemu.murtola@gmail.com>
76 * \inpublicapi
77 * \ingroup module_commandline
78 */
79 #ifndef GMX_COMMANDLINE_H
80 #define GMX_COMMANDLINE_H
89 #endif