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