Use filenm.c data for FileNameOption.
[alexxy/gromacs.git] / man / man7 / gromacs.7.cmakein
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2 .\" (and then reused elsewhere, since this isn't a perl package)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sh \" Subsection heading
7 .br
8 .if t .Sp
9 .ne 5
10 .PP
11 \fB\\$1\fR
12 .PP
13 ..
14 .de Sp \" Vertical space (when we can't use .PP)
15 .if t .sp .5v
16 .if n .sp
17 ..
18 .de Vb \" Begin verbatim text
19 .ft CW
20 .nf
21 .ne \\$1
22 ..
23 .de Ve \" End verbatim text
24 .ft R
25 .fi
26 ..
27 .\" Set up some character translations and predefined strings.  \*(-- will
28 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
29 .\" double quote, and \*(R" will give a right double quote.  | will give a
30 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
31 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
32 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .tr \(*W-|\(bv\*(Tr
34 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
35 .ie n \{\
36 .    ds -- \(*W-
37 .    ds PI pi
38 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
39 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
40 .    ds L" ""
41 .    ds R" ""
42 .    ds C` ""
43 .    ds C' ""
44 'br\}
45 .el\{\
46 .    ds -- \|\(em\|
47 .    ds PI \(*p
48 .    ds L" ``
49 .    ds R" ''
50 'br\}
51 .\"
52 .\" If the F register is turned on, we'll generate index entries on stderr for
53 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
54 .\" entries marked with X<> in POD.  Of course, you'll have to process the
55 .\" output yourself in some meaningful fashion.
56 .if \nF \{\
57 .    de IX
58 .    tm Index:\\$1\t\\n%\t"\\$2"
59 ..
60 .    nr % 0
61 .    rr F
62 .\}
63 .\"
64 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
65 .\" way too many mistakes in technical documents.
66 .hy 0
67 .if n .na
68 .\"
69 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
70 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
71 .    \" fudge factors for nroff and troff
72 .if n \{\
73 .    ds #H 0
74 .    ds #V .8m
75 .    ds #F .3m
76 .    ds #[ \f1
77 .    ds #] \fP
78 .\}
79 .if t \{\
80 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
81 .    ds #V .6m
82 .    ds #F 0
83 .    ds #[ \&
84 .    ds #] \&
85 .\}
86 .    \" simple accents for nroff and troff
87 .if n \{\
88 .    ds ' \&
89 .    ds ` \&
90 .    ds ^ \&
91 .    ds , \&
92 .    ds ~ ~
93 .    ds /
94 .\}
95 .if t \{\
96 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
97 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
98 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
99 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
100 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
101 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 .\}
103 .    \" troff and (daisy-wheel) nroff accents
104 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
105 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
106 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
107 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
108 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
109 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
110 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
111 .ds ae a\h'-(\w'a'u*4/10)'e
112 .ds Ae A\h'-(\w'A'u*4/10)'E
113 .    \" corrections for vroff
114 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
115 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
116 .    \" for low resolution devices (crt and lpr)
117 .if \n(.H>23 .if \n(.V>19 \
118 \{\
119 .    ds : e
120 .    ds 8 ss
121 .    ds o a
122 .    ds d- d\h'-1'\(ga
123 .    ds D- D\h'-1'\(hy
124 .    ds th \o'bp'
125 .    ds Th \o'LP'
126 .    ds ae ae
127 .    ds Ae AE
128 .\}
129 .rm #[ #] #H #V #F C
130 .\" ========================================================================
131 .\"
132 .IX Title "GROMACS 7"
133 .TH GROMACS 7 "${TODAYS_DATE}" "gromacs" "GROMACS suite, Version ${PROJECT_VERSION}"
134 .SH "NAME"
135 gromacs \- molecular dynamics simulation suite
136 .SH "DESCRIPTION"
137 .B GROMACS
138 (the Groningen Machine for Chemical Simulations) is a full-featured
139 suite of programs to perform molecular dynamics simulations - in other
140 words, to simulate the behavior of systems with hundreds to millions
141 of particles, using Newtonian equations of motion.  It is primarily
142 used for research on proteins, lipids, and polymers, but can be applied
143 to a wide variety of chemical and biological research questions.
144 .SH "SYNOPSIS"
145 .IX Header "SYNOPSIS"
146 .PP
147 The following commands make up the GROMACS suite.  Please refer to their
148 individual man pages for further details.
149 ${PROGMANPAGES}
150 .PP
151 .SH "ADDITIONAL DOCUMENTATION"
152 .IX Header "ADDITIONAL DOCUMENTATION"
153 Consult the manual at <\fIhttp://www.gromacs.org/content/view/27/42/\fR> for an
154 introduction to molecular dynamics in general and GROMACS in particular,
155 as well as an overview of the individual programs.
156 .PP
157 The shorter HTML reference and GROMACS FAQ are available in \fB/usr/share/doc/gromacs/html/\fR .
158 .PP
159 Tutorial files and other miscellaneous references are stored in \fB/usr/share/gromacs/\fR .
160 .SH "REFERENCES"
161 .IX Header "REFERENCES"
162 The development of GROMACS is mainly funded by academic research grants.
163 To help us fund development, the authors humbly ask that you cite the GROMACS papers:
164 .PP
165 H.J.C. Berendsen, D. van der Spoel and R. van Drunen.  \fBGROMACS: A message-passing
166 parallel molecular dynamics implementation\fR.  Comp. Phys. Comm. \fI91\fR, 43-56 (1995)
167 .PP
168 Erik Lindahl, Berk Hess and David van der Spoel.  \fBGROMACS 3.0: A package for 
169 molecular simulation and trajectory analysis\fR.  J. Mol. Mod. \fI7\fR, 306-317 (2001)
170 .PP
171 B. Hess, C. Kutzner, D. van der Spoel, and E. Lindahl.  \fBGROMACS 4: Algorithms for
172 Highly Efficient, Load-Balanced, and Scalable Molecular Simulation\fR.  J. Chem. Theory 
173 Comput. \fI4\fR, 3, 435-447 (2008), <\fIhttp://dx.doi.org/10.1021/ct700301q\fR>
174 .SH "AUTHORS"
175 .IX Header "AUTHORS"
176 Current developers:
177 .PP
178 David van der Spoel <spoel@gromacs.org>
179 .br
180 Berk Hess <hess@gromacs.org>
181 .br
182 Erik Lindahl <lindahl@gromacs.org>
183 .PP
184 A full list of present and former contributors
185 is available at <http://www.gromacs.org>
186 .PP
187 This manual page is largely based on the GROMACS online reference, and was
188 prepared in this format by Nicholas Breen <nbreen@ofb.net>.
189 .SH "BUGS"
190 .IX Header "BUGS"
191 GROMACS has no major known bugs, but be warned that it stresses your CPU more
192 than most software.  Systems with slightly flaky hardware may prove unreliable
193 while running heavy-duty simulations.  If at all possible, please try to
194 reproduce bugs on another machine before reporting them.