b0c890552b3dadd24fb46a505ee7c803a542fb07
[alexxy/gromacs.git] / src / gromacs / tools / tests / refdata / HelpwritingTest_ConvertTprWritesHelp.xml
1 <?xml version="1.0"?>
2 <?xml-stylesheet type="text/xsl" href="referencedata.xsl"?>
3 <ReferenceData>
4   <String Name="HelpOutput"><![CDATA[
5 SYNOPSIS
6
7 test convert-tpr [-s [<.tpr/.gro/...>]] [-n [<.ndx>]] [-o [<.tpr/.gro/...>]]
8              [-extend <time>] [-until <time>] [-nsteps <int>] [-[no]zeroq]
9
10 DESCRIPTION
11
12 test convert-tpr can edit run input files in three ways.
13
14 1. by modifying the number of steps in a run input file with options -extend,
15 -until or -nsteps (nsteps=-1 means unlimited number of steps)
16
17 2. by creating a .tpx file for a subset of your original tpx file, which is
18 useful when you want to remove the solvent from your .tpx file, or when you
19 want to make e.g. a pure Calpha .tpx file. Note that you may need to use
20 -nsteps -1 (or similar) to get this to work. WARNING: this .tpx file is not
21 fully functional.
22
23 3. by setting the charges of a specified group to zero. This is useful when
24 doing free energy estimates using the LIE (Linear Interaction Energy) method.
25
26 OPTIONS
27
28 Options to specify input files:
29
30  -s      [<.tpr/.gro/...>]  (topol.tpr)
31            Run input file to modify: tpr gro g96 pdb brk ent
32  -n      [<.ndx>]           (index.ndx)      (Opt.)
33            File containing additional index groups
34
35 Options to specify output files:
36
37  -o      [<.tpr/.gro/...>]  (tprout.tpr)     (Opt.)
38            Generated modified run input file: tpr gro g96 pdb brk ent
39
40 Other options:
41
42  -extend <time>             (0)
43            Extend runtime by this amount (ps)
44  -until  <time>             (0)
45            Extend runtime until this ending time (ps)
46  -nsteps <int>              (0)
47            Change the number of steps
48  -[no]zeroq                 (no)
49            Set the charges of a group (from the index) to zero
50 ]]></String>
51 </ReferenceData>