New entry
[gromacs/rigid-bodies.git] / man / man1 / g_mindist.1
bloba07a6f030e38a5dead031e30b9b44ba2d9170518
1 .TH g_mindist 1 "Mon 4 Apr 2011" "" "GROMACS suite, VERSION 4.5.4-dev-20110404-bc5695c"
2 .SH NAME
3 g_mindist - calculates the minimum distance between two groups
5 .B VERSION 4.5.4-dev-20110404-bc5695c
6 .SH SYNOPSIS
7 \f3g_mindist\fP
8 .BI "\-f" " traj.xtc "
9 .BI "\-s" " topol.tpr "
10 .BI "\-n" " index.ndx "
11 .BI "\-od" " mindist.xvg "
12 .BI "\-on" " numcont.xvg "
13 .BI "\-o" " atm\-pair.out "
14 .BI "\-ox" " mindist.xtc "
15 .BI "\-or" " mindistres.xvg "
16 .BI "\-[no]h" ""
17 .BI "\-[no]version" ""
18 .BI "\-nice" " int "
19 .BI "\-b" " time "
20 .BI "\-e" " time "
21 .BI "\-dt" " time "
22 .BI "\-tu" " enum "
23 .BI "\-[no]w" ""
24 .BI "\-xvg" " enum "
25 .BI "\-[no]matrix" ""
26 .BI "\-[no]max" ""
27 .BI "\-d" " real "
28 .BI "\-[no]group" ""
29 .BI "\-[no]pi" ""
30 .BI "\-[no]split" ""
31 .BI "\-ng" " int "
32 .BI "\-[no]pbc" ""
33 .BI "\-[no]respertime" ""
34 .BI "\-[no]printresname" ""
35 .SH DESCRIPTION
36 \&\fB g_mindist\fR computes the distance between one group and a number of
37 \&other groups. Both the minimum distance
38 \&(between any pair of atoms from the respective groups)
39 \&and the number of contacts within a given
40 \&distance are written to two separate output files.
41 \&With the \fB \-group\fR option a contact of an atom an other group
42 \&with multiple atoms in the first group is counted as one contact
43 \&instead of as multiple contacts.
44 \&With \fB \-or\fR, minimum distances to each residue in the first
45 \&group are determined and plotted as a function of residue number.
48 \&With option \fB \-pi\fR the minimum distance of a group to its
49 \&periodic image is plotted. This is useful for checking if a protein
50 \&has seen its periodic image during a simulation. Only one shift in
51 \&each direction is considered, giving a total of 26 shifts.
52 \&It also plots the maximum distance within the group and the lengths
53 \&of the three box vectors.
56 \&Other programs that calculate distances are \fB g_dist\fR
57 \&and \fB g_bond\fR.
58 .SH FILES
59 .BI "\-f" " traj.xtc" 
60 .B Input
61  Trajectory: xtc trr trj gro g96 pdb cpt 
63 .BI "\-s" " topol.tpr" 
64 .B Input, Opt.
65  Structure+mass(db): tpr tpb tpa gro g96 pdb 
67 .BI "\-n" " index.ndx" 
68 .B Input, Opt.
69  Index file 
71 .BI "\-od" " mindist.xvg" 
72 .B Output
73  xvgr/xmgr file 
75 .BI "\-on" " numcont.xvg" 
76 .B Output, Opt.
77  xvgr/xmgr file 
79 .BI "\-o" " atm\-pair.out" 
80 .B Output, Opt.
81  Generic output file 
83 .BI "\-ox" " mindist.xtc" 
84 .B Output, Opt.
85  Trajectory: xtc trr trj gro g96 pdb 
87 .BI "\-or" " mindistres.xvg" 
88 .B Output, Opt.
89  xvgr/xmgr file 
91 .SH OTHER OPTIONS
92 .BI "\-[no]h"  "no    "
93  Print help info and quit
95 .BI "\-[no]version"  "no    "
96  Print version info and quit
98 .BI "\-nice"  " int" " 19" 
99  Set the nicelevel
101 .BI "\-b"  " time" " 0     " 
102  First frame (ps) to read from trajectory
104 .BI "\-e"  " time" " 0     " 
105  Last frame (ps) to read from trajectory
107 .BI "\-dt"  " time" " 0     " 
108  Only use frame when t MOD dt = first time (ps)
110 .BI "\-tu"  " enum" " ps" 
111  Time unit: \fB fs\fR, \fB ps\fR, \fB ns\fR, \fB us\fR, \fB ms\fR or \fB s\fR
113 .BI "\-[no]w"  "no    "
114  View output \fB .xvg\fR, \fB .xpm\fR, \fB .eps\fR and \fB .pdb\fR files
116 .BI "\-xvg"  " enum" " xmgrace" 
117  xvg plot formatting: \fB xmgrace\fR, \fB xmgr\fR or \fB none\fR
119 .BI "\-[no]matrix"  "no    "
120  Calculate half a matrix of group\-group distances
122 .BI "\-[no]max"  "no    "
123  Calculate *maximum* distance instead of minimum
125 .BI "\-d"  " real" " 0.6   " 
126  Distance for contacts
128 .BI "\-[no]group"  "no    "
129  Count contacts with multiple atoms in the first group as one
131 .BI "\-[no]pi"  "no    "
132  Calculate minimum distance with periodic images
134 .BI "\-[no]split"  "no    "
135  Split graph where time is zero
137 .BI "\-ng"  " int" " 1" 
138  Number of secondary groups to compute distance to a central group
140 .BI "\-[no]pbc"  "yes   "
141  Take periodic boundary conditions into account
143 .BI "\-[no]respertime"  "no    "
144  When writing per\-residue distances, write distance for each time point
146 .BI "\-[no]printresname"  "no    "
147  Write residue names
149 .SH SEE ALSO
150 .BR gromacs(7)
152 More information about \fBGROMACS\fR is available at <\fIhttp://www.gromacs.org/\fR>.