src/gromacs/commandline/tests/refdata/CommandLineHelpModuleTest_ExportsHelp.xml

   1 <?xml version="1.0"?>
   2 <?xml-stylesheet type="text/xsl" href="referencedata.xsl"?>
   3 <ReferenceData>
   4   <String Name="programs/byname.rst"><![CDATA[
   5 Tools by Name
   6 =============
   7 * :doc:`test help <test-help>` - Print help information
   8 * :doc:`test module <test-module>` - First module
   9 * :doc:`test other <test-other>` - Second module
  10 ]]></String>
  11   <String Name="conf-man.py"><![CDATA[
  12 man_pages = [
  13     ('programs/test-help', 'test-help', "Print help information", '', 1),
  14     ('programs/test-module', 'test-module', "First module", '', 1),
  15     ('programs/test-other', 'test-other', "Second module", '', 1),
  16     ('programs/test', 'test', 'molecular dynamics simulation suite', '', 1)
  17 ]
  18 ]]></String>
  19   <String Name="programs/test-help.rst"><![CDATA[
  20 .. _test help:
  21
  22 test help
  23 =========
  24
  25 .. only:: man
  26
  27    See also
  28    --------
  29
  30    :manpage:`test(1)`
  31
  32    More information about |Gromacs| is available at <http://www.gromacs.org/>.
  33 ]]></String>
  34   <String Name="programs/test-module.rst"><![CDATA[
  35 .. _test module:
  36
  37 test module
  38 ===========
  39 Synopsis
  40 --------
  41 ::
  42
  43     test module [-int <int>]
  44
  45 Description
  46 -----------
  47 Sample description
  48 for testing ``test module``.
  49
  50 Options
  51 -------
  52 Other options:
  53
  54 ``-int`` <int>
  55
  56
  57
  58 .. only:: man
  59
  60    See also
  61    --------
  62
  63    :manpage:`test(1)`
  64
  65    More information about |Gromacs| is available at <http://www.gromacs.org/>.
  66 ]]></String>
  67   <String Name="programs/test-other.rst"><![CDATA[
  68 .. _test other:
  69
  70 test other
  71 ==========
  72 Synopsis
  73 --------
  74 ::
  75
  76     test other
  77
  78
  79 .. only:: man
  80
  81    See also
  82    --------
  83
  84    :manpage:`test(1)`
  85
  86    More information about |Gromacs| is available at <http://www.gromacs.org/>.
  87 ]]></String>
  88   <String Name="programs/bytopic.rst"><![CDATA[
  89 Tools by Topic
  90 ==============
  91 Group 1
  92 -------
  93 | :doc:`test module <test-module>` - First module
  94
  95 Group 2
  96 -------
  97 | :doc:`test other <test-other>` - Second module
  98
  99 ]]></String>
 100   <String Name="man/bytopic.rst"><![CDATA[
 101 Group 1
 102 ^^^^^^^
 103 :manpage:`test-module(1)`
 104   First module
 105
 106 Group 2
 107 ^^^^^^^
 108 :manpage:`test-other(1)`
 109   Second module
 110
 111 ]]></String>
 112   <String Name="programs/topic1.rst"><![CDATA[
 113 Test topic
 114 ==========
 115 Help text
 116
 117 Subtopic 1
 118 ----------
 119 Sub text
 120
 121 Subtopic 2
 122 ----------
 123 Sub text
 124
 125 Out-of-order subtopic
 126 ---------------------
 127 Sub text
 128 ]]></String>
 129   <String Name="programs/topic2.rst"><![CDATA[
 130 Another topic
 131 =============
 132 Help text
 133 ]]></String>
 134   <String Name="programs/test.rst"><![CDATA[
 135 :orphan:
 136
 137 molecular dynamics simulation suite
 138 ===================================
 139 Synopsis
 140 --------
 141 ::
 142
 143     test [-[no]h] [-[no]quiet] [-[no]version] [-[no]copyright] [-nice <int>]
 144          [-[no]backup]
 145
 146 Description
 147 -----------
 148 |Gromacs| is a full-featured suite of programs to perform molecular
 149 dynamics simulations, i.e., to simulate the behavior of systems with
 150 hundreds to millions of particles using Newtonian equations of motion.
 151 It is primarily used for research on proteins, lipids, and polymers, but
 152 can be applied to a wide variety of chemical and biological research
 153 questions.
 154
 155 Options
 156 -------
 157 Other options:
 158
 159 ``-[no]h``  (no)
 160     Print help and quit
 161 ``-[no]quiet``  (no)
 162     Do not print common startup info or quotes
 163 ``-[no]version``  (no)
 164     Print extended version information and quit
 165 ``-[no]copyright``  (yes)
 166     Print copyright information on startup
 167 ``-nice`` <int> (19)
 168     Set the nicelevel (default depends on command)
 169 ``-[no]backup``  (yes)
 170     Write backups if output files exist
 171
 172 test commands
 173 -------------
 174 The following commands are available. Please refer to their individual man pages or ``commandline-test help <command>`` for further details.
 175
 176 .. include:: /man/bytopic.rst
 177 ]]></String>
 178 </ReferenceData>