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