source: src/documentation/userinterfaces/commandline.dox@ 3aa204

Action_Thermostats Add_AtomRandomPerturbation Add_RotateAroundBondAction Add_SelectAtomByNameAction Adding_Graph_to_ChangeBondActions Adding_MD_integration_tests Adding_StructOpt_integration_tests AutomationFragmentation_failures Candidate_v1.6.1 ChangeBugEmailaddress ChangingTestPorts ChemicalSpaceEvaluator Docu_Python_wait EmpiricalPotential_contain_HomologyGraph_documentation Enhance_userguide Enhanced_StructuralOptimization Enhanced_StructuralOptimization_continued Example_ManyWaysToTranslateAtom Exclude_Hydrogens_annealWithBondGraph Fix_ChronosMutex Fix_StatusMsg Fix_StepWorldTime_single_argument Fix_Verbose_Codepatterns ForceAnnealing_goodresults ForceAnnealing_oldresults ForceAnnealing_tocheck ForceAnnealing_with_BondGraph ForceAnnealing_with_BondGraph_continued ForceAnnealing_with_BondGraph_continued_betteresults ForceAnnealing_with_BondGraph_contraction-expansion GeometryObjects Gui_displays_atomic_force_velocity IndependentFragmentGrids_IntegrationTest JobMarket_RobustOnKillsSegFaults JobMarket_StableWorkerPool PythonUI_with_named_parameters QtGui_reactivate_TimeChanged_changes Recreated_GuiChecks RotateToPrincipalAxisSystem_UndoRedo StoppableMakroAction TremoloParser_IncreasedPrecision TremoloParser_MultipleTimesteps Ubuntu_1604_changes
Last change on this file since 3aa204 was caece4, checked in by Frederik Heber <heber@…>, 11 years ago

Enhanced documentation significantly.

  • went through all of the constructs and updated each.
  • enhanced documentation ofr Fragmentation::FragmentMolecule().
  • Property mode set to 100644
File size: 1.4 KB
RevLine 
[750cff]1/*
2 * Project: MoleCuilder
3 * Description: creates and alters molecular systems
4 * Copyright (C) 2010 University of Bonn. All rights reserved.
5 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
6 */
7
8/**
9 * \file commandline.dox
10 *
11 * Created on: Oct 31, 2011
12 * Author: heber
13 */
14
15/**
[35a889]16 * \page userinterfaces-commandline Command Line Interface
[750cff]17 *
18 * The command line interface allows for using MoleCuilder within scripts such
19 * system with only slightly varying parameters can be built in a straight-
20 * forward way.
21 *
[caece4]22 * Commands are parsed via the CommandLineParser which uses boost::program_options
[750cff]23 * to recognize the given options. ActionRegistry and OptionRegistry are used
[caece4]24 * to distinguish Option's from Action's. Each option has a specific type and a
25 * Validator ascertains that the value associated with this option and of this
26 * specific type matches certain criteria.
[750cff]27 *
28 * So far the sequence of the Option's is not really important but for the
29 * Action's the ordering counts: first come, first serve.
30 *
[caece4]31 * Undoing is possible from the command-line as well. But is so far only used in
32 * the regression test to test its functionality. However, as the ActionHistory,
33 * or rather ActionQueue, can be saved as a session, this is useful as in a restored
34 * ActionHistory undo would allow for traversing back in this history.
[750cff]35 *
36 *
[caece4]37 * \date 2014-03-10
[750cff]38 *
39 */
Note: See TracBrowser for help on using the repository browser.