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