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 molecule
   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 the current frame rate, CPU load, and polygon count.
  44 .TP 8
  45 .B \-verbose
  46 Print debugging info on stderr about files being loaded, etc.
  47 .TP 8
  48 .B \-wander
  49 Move the molecules around the screen.
  50 .TP 8
  51 .B \-no\-wander
  52 Keep the molecule centered on the screen.  This is the default.
  53 .TP 8
  54 .B \-spin
  55 Which axes around which the molecule should spin.  The default is "XYZ",
  56 meaning rotate it freely in space.  "\fB\-spin Z\fP" would rotate the
  57 molecule in the plane of the screen while not rotating it into or out
  58 of the screen; etc.
  59 .TP 8
  60 .B \-no\-spin
  61 Don't spin it at all: the same as \fB\-spin ""\fP.
  62 .TP 8
  63 .B \-labels
  64 Draw labels on the atoms (or the spot where the atoms would be.)
  65 This is the default.
  66 .TP 8
  67 .B \-no\-labels
  68 Do not draw labels on the atoms.
  69 .TP 8
  70 .B \-titles
  71 Print the name of the molecule and its chemical formula at the top of
  72 the screen.
  73 .TP 8
  74 .B \-no\-titles
  75 Do not print the molecule name.
  76 .TP 8
  77 .B \-atoms
  78 Represent the atoms as shaded spheres of appropriate sizes.
  79 This is the default.
  80 .TP 8
  81 .B \-no\-atoms
  82 Do not draw spheres for the atoms: only draw bond lines.
  83 .TP 8
  84 .B \-bonds
  85 Represent the atomic bonds as solid tubes of appropriate thicknesses.
  86 This is the default.
  87 .TP 8
  88 .B \-no\-bonds
  89 Do not draw the bonds: instead, make the spheres for the atoms be
  90 larger, for a "space-filling" representation of the molecule.
  91 .TP 8
  92 .B \-shells
  93 Draw transparent electron shells around the atoms.  This only works
  94 if bonds are also being drawn.
  95 .TP 8
  96 .B \-no\-shells
  97 Do not draw electron shells.  This is the default.
  98 .TP 8
  99 .B \-shell\-alpha
 100 When drawing shells, how transparent to make them.  Default 0.4.
 101 .TP 8
 102 .B \-wireframe
 103 Draw a wireframe rendition of the molecule: this will consist only of
 104 single-pixel lines for the bonds, and text labels where the atoms go.
 105 This will be very fast.
 106 .TP 8
 107 .B \-timeout \fIseconds\fP
 108 When using the built-in data set, change to a new molecule every
 109 this-many seconds.  Default is 20 seconds.
 110 .TP 8
 111 .B \-molecule \fIfile-or-directory\fP
 112 Instead of using the built-in molecules, read one from the given file.
 113 This file must be in PDB (Protein Data Base) format.  (Note that it's
 114 not uncommon for PDB files to contain only the atoms, with no (or
 115 little) information about the atomic bonds.)
 116
 117 This can also be a directory, in which case, all of the .pdb files in
 118 that directory will be loaded.  A new one will be displayed at random
 119 every few seconds (as per the \fI\-timeout\fP option.)
 120 .PP
 121 When the molecule is too large (bigger than about 30 angstroms from
 122 side to side), the \fI\-label\fP option will be automatically turned
 123 off, because otherwise, the labels would overlap and completely obscure
 124 the display.
 125
 126 When the molecule is around 150 angstroms from side to side, wireframe
 127 mode will be turned on (because otherwise it would be too slow.)
 128 .SH ENVIRONMENT
 129 .PP
 130 .TP 8
 131 .B DISPLAY
 132 to get the default host and display number.
 133 .TP 8
 134 .B XENVIRONMENT
 135 to get the name of a resource file that overrides the global resources
 136 stored in the RESOURCE_MANAGER property.
 137 .SH SEE ALSO
 138 .BR X (1),
 139 .BR xscreensaver (1)
 140 .PP
 141 Documentation on the PDB file format:
 142
 143     http://www.wwpdb.org/docs.html
 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.umass.edu/microbio/rasmol/whereget.htm
 149     http://www.wwpdb.org/docs.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>