Make it easier to find selection help
[gromacs/AngularHB.git] / docs / old-html / online / options.html
blobaf9fc65727069ddac49136770a49fb52c388de86
1 <TITLE>Options</TITLE>
2 <UL>
3 <LI>
4 Optional files are not used unless the option is set, in contrast to
5 non optional files, where the default file name is used when the
6 option is not set.
7 <P>
8 All GROMACS programs will accept file options without a file extension
9 or filename being specified. In such cases the default filenames will
10 be used. With multiple input file types, such as generic structure
11 format, the directory will be searched for files of each type with the
12 supplied or default name. When no such file is found, or with output
13 files the first file type will be used.
14 <P>
15 All GROMACS programs with the exception of <tt>mdrun</tt>,
16 <tt>trjcat</tt> and <tt>eneconv</tt> check if the command line options
17 are valid. If this is not the case, the program will be halted.
18 <P>
19 <LI>
20 All GROMACS programs have 4 hidden options:
21 <TABLE BORDER=1 CELLSPACING=0 CELLPADDING=2>
22 <TR><TH>option</TH><TH>type</TH><TH>default</TH><TH>description</TH></TR>
23 <TR><TD ALIGN=RIGHT> <b><tt>-[no]hidden</tt></b> </TD><TD ALIGN=RIGHT> bool </TD><TD ALIGN=RIGHT> <tt> yes</tt> </TD><TD> [hidden] Print hidden options </TD></TD>
24 <TR><TD ALIGN=RIGHT> <b><tt>-[no]quiet</tt></b> </TD><TD ALIGN=RIGHT> bool </TD><TD ALIGN=RIGHT> <tt> no</tt> </TD><TD> [hidden] Do not print help info </TD></TD>
25 <TR><TD ALIGN=RIGHT> <b><tt>-man</tt></b> </TD><TD ALIGN=RIGHT> enum </TD><TD ALIGN=RIGHT> <tt>html</tt> </TD><TD> [hidden] Write manual and quit: no, html, tex, nroff, java, ascii or completion </TD></TD>
26 <TR><TD ALIGN=RIGHT> <b><tt>-[no]debug</tt></b> </TD><TD ALIGN=RIGHT> bool </TD><TD ALIGN=RIGHT> <tt> no</tt> </TD><TD> [hidden] Write file with debug information </TD></TD>
27 </TABLE>
28 <P>
29 <LI>
30 Enumerated options (enum) should be used with one of the arguments
31 listed in the option description, the argument may be abbreviated.
32 The first match to the shortest argument in the list will be selected.
33 <P>
34 <LI>
35 Vector options can be used with 1 or 3 parameters. When only one
36 parameter is supplied the two others are also set to this value.
37 <P>
38 <LI>
39 All GROMACS programs can read compressed or g-zipped files. There
40 might be a problem with reading compressed <tt>.xtc</tt>,
41 <tt>.trr</tt> and <tt>.trj</tt> files, but these will not compress
42 very well anyway.
43 <P>
44 <LI>
45 Most GROMACS programs can process a trajectory with less atoms than
46 the run input or structure file, but only if the trajectory consists
47 of the first n atoms of the run input or structure file.
48 </UL>