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

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