/*
+ * This file is part of the GROMACS molecular simulation package.
*
- * This source code is part of
+ * Copyright (c) 2012,2013,2014, by the GROMACS development team, led by
+ * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
+ * and including many others, as listed in the AUTHORS file in the
+ * top-level source directory and at http://www.gromacs.org.
*
- * G R O M A C S
+ * GROMACS is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 2.1
+ * of the License, or (at your option) any later version.
*
- * GROningen MAchine for Chemical Simulations
+ * GROMACS is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
*
- * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
- * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
- * Copyright (c) 2001-2009, The GROMACS development team,
- * check out http://www.gromacs.org for more information.
-
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with GROMACS; if not, see
+ * http://www.gnu.org/licenses, or write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
- * If you want to redistribute modifications, please consider that
- * scientific software is very special. Version control is crucial -
- * bugs must be traceable. We will be happy to consider code for
- * inclusion in the official distribution, but derived work must not
- * be called official GROMACS. Details are found in the README & COPYING
- * files - if they are missing, get the official version at www.gromacs.org.
+ * If you want to redistribute modifications to GROMACS, please
+ * consider that scientific software is very special. Version
+ * control is crucial - bugs must be traceable. We will be happy to
+ * consider code for inclusion in the official distribution, but
+ * derived work must not be called official GROMACS. Details are found
+ * in the README & COPYING files - if they are missing, get the
+ * official version at http://www.gromacs.org.
*
* To help us fund GROMACS development, we humbly ask that you cite
- * the papers on the package - you can find them in the top README file.
- *
- * For more info, check our website at http://www.gromacs.org
+ * the research papers on the package. Check out http://www.gromacs.org.
*/
-/*! \defgroup module_commandline Command Line Parsing and Help
+/*! \defgroup module_commandline Command Line Program Management (commandline)
* \ingroup group_utilitymodules
* \brief
- * Provides functionality for parsing command-line arguments and writing help.
+ * Provides functionality for managing command line programs.
+ *
+ * This module provides utility classes and functions for implementing command
+ * line programs. They are mainly used within \Gromacs, but can also be used
+ * from external programs if they want to get a similar user experience to
+ * \Gromacs tools.
+ *
+ * The classes exposed from this module can be roughly divided into two groups:
+ *
+ * - Helper classes/functions for implementing the %main() function.
+ * See \ref page_usinglibrary for an overview of those available for user
+ * programs. These are declared in cmdlineinit.h
+ * (gmx::CommandLineModuleInterface is declared in cmdlinemodule.h).
+ * \if libapi
+ *
+ * Additionally, for internal \Gromacs use, gmx::CommandLineModuleManager
+ * provides the functionality to implement the `gmx` wrapper binary, as well
+ * as command line options common to all \Gromacs programs (such as
+ * `-version`).
+ * This is described in more detail at \ref page_wrapperbinary.
+ * \endif
*
- * This module implements gmx::CommandLineParser that assigns values to
- * gmx::Options (see \ref module_options) based on command-line arguments.
- * gmx::CommandLineHelpWriter is also provided to write help text for a program
- * that uses the parser.
+ * - Helper classes for particular command line tasks:
+ * - gmx::CommandLineParser implements command line parsing to assign
+ * values to gmx::Options (see \ref module_options).
+ * - gmx::CommandLineHelpWriter writes help text for a program that uses
+ * the parser.
+ * - parse_common_args() is an old interface to \Gromacs command line
+ * parsing. This is still used by many parts of \Gromacs.
*
* \author Teemu Murtola <teemu.murtola@gmail.com>
*/
/*! \file
* \brief
- * Public API convenience header for handling command-line parameters.
+ * Public API convenience header for managing command line programs.
*
* \author Teemu Murtola <teemu.murtola@gmail.com>
* \inpublicapi
#ifndef GMX_COMMANDLINE_H
#define GMX_COMMANDLINE_H
-#include "commandline/cmdlinehelpwriter.h"
-#include "commandline/cmdlineparser.h"
+#include "gromacs/commandline/cmdlinehelpwriter.h"
+#include "gromacs/commandline/cmdlineinit.h"
+#include "gromacs/commandline/cmdlinemodule.h"
+#include "gromacs/commandline/cmdlineparser.h"
+#include "gromacs/commandline/pargs.h"
#endif
biod.pnpi.spb.ru / alexxy / gromacs.git / blobdiff