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
42 #include "../utility/common.h"
51 * Writes help information for Options in ascii format.
54 * \ingroup module_commandline
56 class CommandLineHelpWriter
60 * Creates an object that writer ascii-formatted help for Options.
62 * \param[in] options Options for which help should be printed.
64 explicit CommandLineHelpWriter(const Options &options);
65 ~CommandLineHelpWriter();
68 * Sets whether hidden options are shown in the help.
70 CommandLineHelpWriter &setShowHidden(bool bShow);
72 * Sets whether long descriptions for sections are shown in the help.
74 CommandLineHelpWriter &setShowDescriptions(bool bShow);
76 * Sets time unit to show in descriptions.
78 * \param[in] timeUnit Time unit to show in descriptions.
79 * \throws std::bad_alloc if out of memory.
81 * For each time parameter, any "%t" in the description is replaced
83 * If not called, uses a default "ps".
85 CommandLineHelpWriter &setTimeUnitString(const char *timeUnit);
90 * \param[in] file File to write the help to.
92 void writeHelp(File *file);
97 PrivateImplPointer<Impl> impl_;