3 * This source code is part of
7 * GROningen MAchine for Chemical Simulations
9 * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
10 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
11 * Copyright (c) 2001-2009, The GROMACS development team,
12 * check out http://www.gromacs.org for more information.
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version 2
17 * of the License, or (at your option) any later version.
19 * If you want to redistribute modifications, please consider that
20 * scientific software is very special. Version control is crucial -
21 * bugs must be traceable. We will be happy to consider code for
22 * inclusion in the official distribution, but derived work must not
23 * be called official GROMACS. Details are found in the README & COPYING
24 * files - if they are missing, get the official version at www.gromacs.org.
26 * To help us fund GROMACS development, we humbly ask that you cite
27 * the papers on the package - you can find them in the top README file.
29 * For more info, check our website at http://www.gromacs.org
33 * Declares gmx::CommandLineHelpWriter.
35 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
37 * \ingroup module_commandline
39 #ifndef GMX_COMMANDLINE_CMDLINEHELPWRITER_H
40 #define GMX_COMMANDLINE_CMDLINEHELPWRITER_H
44 #include "../utility/common.h"
52 * Writes help information for Options in ascii format.
55 * \ingroup module_commandline
57 class CommandLineHelpWriter
61 * Creates an object that writer ascii-formatted help for Options.
63 * \param[in] options Options for which help should be printed.
65 explicit CommandLineHelpWriter(const Options &options);
66 ~CommandLineHelpWriter();
69 * Sets whether hidden options are shown in the help.
71 CommandLineHelpWriter &setShowHidden(bool bShow);
73 * Sets whether long descriptions for sections are shown in the help.
75 CommandLineHelpWriter &setShowDescriptions(bool bShow);
80 * \param[in] fp File to write the help to.
82 void writeHelp(FILE *fp);
87 PrivateImplPointer<Impl> impl_;