git.hungrycats.org Git - xscreensaver/blob - hacks/glx/molecule.man

   1 .TH XScreenSaver 1 "13-Mar-01" "X Version 11"
   2 .SH NAME
   3 molecule - draws 3D moleclear structures
   4 .SH SYNOPSIS
   5 .B gltext
   6 [\-display \fIhost:display.screen\fP] [\-window] [\-root]
   7 [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP] [\-fps]
   8 [\-wander] [\-no-wander]
   9 [\-spin \fIaxes\fP]
  10 [\-no-spin]
  11 [\-wire]
  12 [\-verbose]
  13 [\-timeout \fIseconds\fP]
  14 [\-labels] [\-no-labels]
  15 [\-titles] [\-no-titles]
  16 [\-atoms] [\-no-atoms]
  17 [\-bonds] [\-no-bonds]
  18 [\-shells] [\-no-shells]
  19 [\-molecule \fIfile-or-directory\fP]
  20 .SH DESCRIPTION
  21 The \fImolecule\fP program draws several different representations of
  22 molecules.  Some common molecules are built in, and it can read PDB
  23 (Protein Data Base) files as input.
  24 .SH OPTIONS
  25 .I molecule
  26 accepts the following options:
  27 .TP 8
  28 .B \-window
  29 Draw on a newly-created window.  This is the default.
  30 .TP 8
  31 .B \-root
  32 Draw on the root window.
  33 .TP 8
  34 .B \-install
  35 Install a private colormap for the window.
  36 .TP 8
  37 .B \-visual \fIvisual\fP\fP
  38 Specify which visual to use.  Legal values are the name of a visual class,
  39 or the id number (decimal or hex) of a specific visual.
  40 .TP 8
  41 .B \-fps
  42 Display a running tally of how many frames per second are being rendered.
  43 In conjunction with \fB\-delay 0\fP, this can be a useful benchmark of
  44 your GL performance.
  45 .TP 8
  46 .B \-verbose
  47 Print debugging info on stderr about files being loaded, etc.
  48 .TP 8
  49 .B \-wander
  50 Move the molecules around the screen.
  51 .TP 8
  52 .B \-no\-wander
  53 Keep the molecule centered on the screen.  This is the default.
  54 .TP 8
  55 .B \-spin
  56 Which axes around which the molecule should spin.  The default is "XYZ",
  57 meaning rotate it freely in space.  "\fB\-spin Z\fP" would rotate the
  58 molecule in the plane of the screen while not rotating it into or out
  59 of the screen; etc.
  60 .TP 8
  61 .B \-no\-spin
  62 Don't spin it at all: the same as \fB\-spin ""\fP.
  63 .TP 8
  64 .B \-labels
  65 Draw labels on the atoms (or the spot where the atoms would be.)
  66 This is the default.
  67 .TP 8
  68 .B \-no\-labels
  69 Do not draw labels on the atoms.
  70 .TP 8
  71 .B \-titles
  72 Print the name of the molecule and its chemical formula at the top of
  73 the screen.
  74 .TP 8
  75 .B \-no\-titles
  76 Do not print the molecule name.
  77 .TP 8
  78 .B \-atoms
  79 Represent the atoms as shaded spheres of appropriate sizes.
  80 This is the default.
  81 .TP 8
  82 .B \-no\-atoms
  83 Do not draw spheres for the atoms: only draw bond lines.
  84 .TP 8
  85 .B \-bonds
  86 Represent the atomic bonds as solid tubes of appropriate thicknesses.
  87 This is the default.
  88 .TP 8
  89 .B \-no\-bonds
  90 Do not draw the bonds: instead, make the spheres for the atoms be
  91 larger, for a "space-filling" representation of the molecule.
  92 .TP 8
  93 .B \-shells
  94 Draw transparent electron shells around the atoms.  This only works
  95 if bonds are also being drawn.
  96 .TP 8
  97 .B \-no\-shells
  98 Do not draw electron shells.  This is the default.
  99 .TP 8
 100 .B \-shell\-alpha
 101 When drawing shells, how transparent to make them.  Default 0.4.
 102 .TP 8
 103 .B \-wire
 104 Draw a wireframe rendition of the molecule: this will consist only of
 105 single-pixel lines for the bonds, and text labels where the atoms go.
 106 This will be very fast.
 107 .TP 8
 108 .B \-timeout \fIseconds\fP
 109 When using the built-in data set, change to a new molecule every
 110 this-many seconds.  Default is 20 seconds.
 111 .TP 8
 112 .B \-molecule \fIfile-or-directory\fP
 113 Instead of using the built-in molecules, read one from the given file.
 114 This file must be in PDB (Protein Data Base) format.  (Note that it's
 115 not uncommon for PDB files to contain only the atoms, with no (or
 116 little) information about the atomic bonds.)
 117
 118 This can also be a directory, in which case, all of the .pdb files in
 119 that directory will be loaded.  A new one will be displayed at random
 120 every few seconds (as per the \fI\-timeout\fP option.)
 121 .PP
 122 When the molecule is too large (bigger than about 30 angstroms from
 123 side to side), the \fI\-label\fP option will be automatically turned
 124 off, because otherwise, the labels would overlap and completely obscure
 125 the display.
 126
 127 When the molecule is around 150 angstroms from side to side, wireframe
 128 mode will be turned on (because otherwise it would be too slow.)
 129 .SH ENVIRONMENT
 130 .PP
 131 .TP 8
 132 .B DISPLAY
 133 to get the default host and display number.
 134 .TP 8
 135 .B XENVIRONMENT
 136 to get the name of a resource file that overrides the global resources
 137 stored in the RESOURCE_MANAGER property.
 138 .SH SEE ALSO
 139 .BR X (1),
 140 .BR xscreensaver (1)
 141 .PP
 142 Documentation on the PDB file format:
 143
 144     http://www.rcsb.org/pdb/docs/format/pdbguide2.2/guide2.2_frame.html
 145
 146 A good source of PDB files:
 147
 148     http://www.sci.ouc.bc.ca/chem/molecule/molecule.html
 149 .SH COPYRIGHT
 150 Copyright \(co 2001-2005 by Jamie Zawinski.
 151 Permission to use, copy, modify, distribute, and sell this software and
 152 its documentation for any purpose is hereby granted without fee,
 153 provided that the above copyright notice appear in all copies and that
 154 both that copyright notice and this permission notice appear in
 155 supporting documentation.  No representations are made about the
 156 suitability of this software for any purpose.  It is provided "as is"
 157 without express or implied warranty.
 158 .SH AUTHOR
 159 Jamie Zawinski <jwz@jwz.org>