Tons of small fixes to documentation.
[alexxy/gromacs.git] / src / tools / gmx_bar.c
index 4d54b382207a74546920107a3eb35a699b13c747..53c670e9e84639e99aef2dfe7dbf80d3452b6304 100644 (file)
@@ -2482,54 +2482,54 @@ int gmx_bar(int argc,char *argv[])
 
         "Every individual BAR free energy difference relies on two ",
         "simulations at different states: say state A and state B, as",
-        "controlled by a parameter, lambda (see the mdp parameter",
+        "controlled by a parameter, [GRK]lambda[grk] (see the [TT].mdp[tt] parameter",
         "[TT]init_lambda[tt]). The BAR method calculates a ratio of weighted",
         "average of the Hamiltonian difference of state B given state A and",
-        "vice versa. If the Hamiltonian does not linearly depend on lambda",
+        "vice versa. If the Hamiltonian does not depend linearly on [GRK]lambda[grk]",
         "(in which case we can extrapolate the derivative of the Hamiltonian",
-        "with respect to lambda, as is the default when [TT]free_energy[tt] is on),",
+        "with respect to [GRK]lambda[grk], as is the default when [TT]free_energy[tt] is on),",
         "the energy differences to the other state need to be calculated",
         "explicitly during the simulation. This can be controlled with",
-        "the mdp option [TT]foreign_lambda[tt].[PAR]",
+        "the [TT].mdp[tt] option [TT]foreign_lambda[tt].[PAR]",
 
-        "Input option [TT]-f[tt] expects multiple dhdl files. ",
+        "Input option [TT]-f[tt] expects multiple [TT]dhdl.xvg[tt] files. ",
         "Two types of input files are supported:[BR]",
-        "[TT]*[tt]  Files with only one y-value, for such files it is assumed ",
-        "   that the y-value is dH/dlambda and that the Hamiltonian depends ",
-        "   linearly on lambda. The lambda value of the simulation is inferred ",
-        "   from the subtitle if present, otherwise from a number in the",
+        "[TT]*[tt]  Files with only one [IT]y[it]-value, for such files it is assumed ",
+        "   that the [IT]y[it]-value is dH/d[GRK]lambda[grk] and that the Hamiltonian depends ",
+        "   linearly on [GRK]lambda[grk]. The [GRK]lambda[grk] value of the simulation is inferred ",
+        "   from the subtitle (if present), otherwise from a number in the",
         "   subdirectory in the file name.",
         "[BR]",
-        "[TT]*[tt]  Files with more than one y-value. The files should have columns ",
-        "   with dH/dlambda and Delta lambda. The lambda values are inferred ",
-        "   from the legends: lambda of the simulation from the legend of dH/dlambda ",
-        "   and the foreign lambda's from the legends of Delta H.[PAR]",
-        "The lambda of the simulation is parsed from dhdl.xvg file's legend ",
-        "containing the string 'dH', the foreign lambdas from the legend ",
+        "[TT]*[tt]  Files with more than one [IT]y[it]-value. The files should have columns ",
+        "   with dH/d[GRK]lambda[grk] and [GRK]Delta[grk][GRK]lambda[grk]. The [GRK]lambda[grk] values are inferred ",
+        "   from the legends: [GRK]lambda[grk] of the simulation from the legend of dH/d[GRK]lambda[grk] ",
+        "   and the foreign [GRK]lambda[grk] values from the legends of Delta H.[PAR]",
+        "The [GRK]lambda[grk] of the simulation is parsed from [TT]dhdl.xvg[tt] file's legend ",
+        "containing the string 'dH', the foreign [GRK]lambda[grk] values from the legend ",
         "containing the capitalized letters 'D' and 'H'. The temperature ",
         "is parsed from the legend line containing 'T ='.[PAR]",
 
-        "The input option [TT]-g[tt] expects multiple .edr files. ",
+        "The input option [TT]-g[tt] expects multiple [TT].edr[tt] files. ",
         "These can contain either lists of energy differences (see the",
-        "mdp option separate_dhdl_file), or a series of histograms",
-        "(see the mdp options [TT]dh_hist_size[tt] and [TT]dh_hist_spacing[tt]).",
-        "The temperature and lambda values are automatically deduced from",
-        "the ener.edr file.[PAR]"
+        "[TT].mdp[tt] option [TT]separate_dhdl_file[tt]), or a series of histograms",
+        "(see the [TT].mdp[tt] options [TT]dh_hist_size[tt] and [TT]dh_hist_spacing[tt]).",
+        "The temperature and [GRK]lambda[grk] values are automatically deduced from",
+        "the [TT]ener.edr[tt] file.[PAR]"
 
         "The free energy estimates are determined using BAR with bisection, ",
-        "the precision of the output is set with [TT]-prec[tt]. ",
+        "with the precision of the output set with [TT]-prec[tt]. ",
         "An error estimate taking into account time correlations ",
         "is made by splitting the data into blocks and determining ",
         "the free energy differences over those blocks and assuming ",
         "the blocks are independent. ",
         "The final error estimate is determined from the average variance ",
-        "over 5 blocks. A range of blocks numbers for error estimation can ",
+        "over 5 blocks. A range of block numbers for error estimation can ",
         "be provided with the options [TT]-nbmin[tt] and [TT]-nbmax[tt].[PAR]",
 
         "[TT]g_bar[tt] tries to aggregate samples with the same 'native' and 'foreign'",
-        "lambda values, but always assumes independent samples: note that",
+        "[GRK]lambda[grk] values, but always assumes independent samples. [BB]Note[bb] that",
         "when aggregating energy differences/derivatives with different",
-        "sampling intervals, this is almost certainly not correct: usually",
+        "sampling intervals, this is almost certainly not correct. Usually",
         "subsequent energies are correlated and different time intervals mean",
         "different degrees of correlation between samples.[PAR]",
 
@@ -2539,8 +2539,8 @@ int gmx_bar(int argc,char *argv[])
         "difference estimates and phase space overlap measures in units of ",
         "kT (together with their computed error estimate). The printed ",
         "values are:[BR]",
-        "[TT]*[tt]  lam_A: the lambda values for point A.[BR]",
-        "[TT]*[tt]  lam_B: the lambda values for point B.[BR]",
+        "[TT]*[tt]  lam_A: the [GRK]lambda[grk] values for point A.[BR]",
+        "[TT]*[tt]  lam_B: the [GRK]lambda[grk] values for point B.[BR]",
         "[TT]*[tt]     DG: the free energy estimate.[BR]",
         "[TT]*[tt]    s_A: an estimate of the relative entropy of B in A.[BR]",
         "[TT]*[tt]    s_A: an estimate of the relative entropy of A in B.[BR]",