contrib/chem/examples/README.txt

   1 This directory contains examples for the 'chem' language.
   2
   3 You can view the graphical display of the examples by calling
   4
   5     groffer <file>
   6
   7 'groffer' calls 'chem' automatically.
   8
   9 If you want to transform example files to a different format use the
  10 'roff2*' programs:
  11
  12 'roff2dvi' prints dvi format to standard output,
  13 'roff2html' generates html output,
  14 'roff2pdf' outputs pdf mode,
  15 'roff2ps' produces PostScript output,
  16 'roff2text' generates text output in the groff device 'latin1',
  17 'roff2x' prints the output  in  the  groff  device  X  that  is
  18          suitable  for programs  like 'gxditview' or 'xditview'.
  19
  20 To get a suitable 'groff' output run
  21
  22     @g@chem <file> | groff -p ...
  23
  24 On the displays, you can see rings consisting of several lines and
  25 bonds (lines).  All points on rings and bonds that do not have a
  26 notation mean a C atom (carbon) filled with H atoms (hydrogen) such
  27 that the valence of 4 is satisfied.
  28
  29 For example, suppose you have just a single line without any
  30 characters.  That means a bond.  It has two points, one at each end of
  31 the line.  So each of these points stands for a C atom, the bond
  32 itself connects these 2 C atoms.  To fulfill the valence of 4, each
  33 points has to carry additionally 3 H atoms.  So the single empty bond
  34 stands for CH3-CH3, though this combination doesn't make much sense
  35 chemically.
  36
  37
  38 ####### License
  39
  40 Copyright (C) 2006-2018 Free Software Foundation, Inc.
  41 Written by Bernd Warken <groff-bernd.warken-72@web.de>.
  42
  43 This file is part of 'chem', which is part of 'groff'.
  44
  45 'groff' is free software; you can redistribute it and/or modify it
  46 under the terms of the GNU General Public License as published by
  47 the Free Software Foundation, either version 3 of the License, or
  48 (at your option) any later version.
  49
  50 'groff' is distributed in the hope that it will be useful, but WITHOUT
  51 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  52 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  53 for more details.
  54
  55 The GPL2 license text is available in the internet at
  56 <http://www.gnu.org/licenses/gpl-2.0.html>.
  57
  58
  59 ####### Emacs settings
  60 Local Variables:
  61 mode: text
  62 End: