Update description of genrestr
authorMark Abraham <mark.j.abraham@gmail.com>
Tue, 4 Feb 2014 14:39:07 +0000 (15:39 +0100)
committerGerrit Code Review <gerrit@gerrit.gromacs.org>
Wed, 5 Feb 2014 18:23:48 +0000 (19:23 +0100)
Change-Id: Ib5e34a40bee8154dc291121cbefd6cd73c6e1760

src/gromacs/gmxana/gmx_genpr.c

index 0ea66458d4687a2ba79d7835da6b0d68e2faf1c4..81aafc9df84d1b3c8e3f8bd74e8d0c252af12f05 100644 (file)
@@ -3,7 +3,7 @@
  *
  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
  * Copyright (c) 2001-2004, The GROMACS development team.
- * Copyright (c) 2013, by the GROMACS development team, led by
+ * Copyright (c) 2013,2014, by the GROMACS development team, led by
  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
  * and including many others, as listed in the AUTHORS file in the
  * top-level source directory and at http://www.gromacs.org.
 int gmx_genpr(int argc, char *argv[])
 {
     const char        *desc[] = {
-        "[THISMODULE] produces an include file for a topology containing",
+        "[THISMODULE] produces an #include file for a topology containing",
         "a list of atom numbers and three force constants for the",
-        "[IT]x[it]-, [IT]y[it]-, and [IT]z[it]-direction. A single isotropic force constant may",
+        "[IT]x[it]-, [IT]y[it]-, and [IT]z[it]-direction based on",
+        "the contents of the [TT]-f[tt] file. A single isotropic force constant may",
         "be given on the command line instead of three components.[PAR]",
-        "WARNING: position restraints only work for the one molecule at a time.",
-        "Position restraints are interactions within molecules, therefore",
-        "they should be included within the correct [TT][ moleculetype ][tt]",
-        "block in the topology. Since the atom numbers in every moleculetype",
-        "in the topology start at 1 and the numbers in the input file for",
-        "[THISMODULE] number consecutively from 1, [THISMODULE] will only",
-        "produce a useful file for the first molecule.[PAR]",
+        "WARNING: Position restraints are interactions within molecules, therefore",
+        "they must be included within the correct [TT][ moleculetype ][tt]",
+        "block in the topology. The atom indices within the",
+        "[TT][ position_restraints ][tt] block must be within the range of the",
+        "atom indices for that molecule type. Since the atom numbers in every",
+        "moleculetype in the topology start at 1 and the numbers in the input file",
+        "for [THISMODULE] number consecutively from 1, [THISMODULE] will only",
+        "produce a useful file for the first molecule. You may wish to",
+        "edit the resulting index file to remove the lines for later atoms,",
+        "or construct a suitable index group to provide",
+        "as input to [THISMODULE].[PAR]",
         "The [TT]-of[tt] option produces an index file that can be used for",
         "freezing atoms. In this case, the input file must be a [TT].pdb[tt] file.[PAR]",
         "With the [TT]-disre[tt] option, half a matrix of distance restraints",