README

   1 This is the GNU groff document formatting system.  The version number
   2 is given in the file VERSION.
   3
   4 Included in this release are implementations of troff, pic, eqn, tbl,
   5 grn, refer, -man, -mdoc, -mom, and -ms macros, and drivers for PostScript,
   6 TeX dvi format, HP LaserJet 4 printers, Canon CAPSL printers, HTML format
   7 (beta status), and typewriter-like devices.  Also included is a modified
   8 version of the Berkeley -me macros, an enhanced version of the X11
   9 xditview previewer, and an implementation of the -mm macros contributed
  10 by Joergen Haegg (jh@axis.se).
  11
  12 See the file INSTALL for installation instructions.  You will require a
  13 C++ compiler.
  14
  15 The file NEWS describes recent user-visible changes to groff.
  16
  17 Groff is free software.  See the file COPYING for copying permission.
  18
  19 The file PROBLEMS describes various problems that have been encountered
  20 in compiling, installing, and running groff.
  21
  22 The most recent released version of groff is always available by
  23 anonymous ftp from ftp.gnu.org in the directory gnu/groff.
  24
  25 The current development version of groff is available from a CVS
  26 repository.  You can access it by first selecting a parent directory in
  27 which to create a working copy (call it, say, ~/cvswork), and then
  28 executing the commands
  29
  30   cd ~/cvswork
  31   CVS_RSH=ssh; export CVS_RSH
  32   cvs -d:ext:anoncvs@savannah.gnu.org/cvsroot/groff -z5 co groff
  33
  34 (Note that you need an SSH client for security reasons.)
  35
  36 This will create a subdirectory, ~/cvswork/groff, with a `checked out'
  37 copy of the CVS repository.  An update of this working copy may be
  38 achieved, at any later time by invoking the commands
  39
  40   cd ~/cvswork/groff
  41   CVS_RSH=ssh cvs -z5 update -dP
  42
  43 Please read the CVS info pages for further details.
  44
  45 Finally, it is possible to access the CVS with a web browser by
  46 pointing it to
  47
  48   http://savannah.gnu.org/cvs/?group=groff
  49
  50 Alternatively, you can download snapshots (which are updated twice a day).
  51 The complete groff source as a single file is available at
  52
  53   http://groff.ffii.org/groff/devel/groff-current.tar.gz
  54
  55 A diff file relative to groff-<version>, the latest official groff
  56 release is available at
  57
  58   http://groff.ffii.org/groff/devel/groff-<version>-current.diff.gz
  59
  60 Assuming that groff-<version>.tar.gz and
  61 groff-<version>-current.diff.gz are in the same directory, do the
  62 following to apply the diff file:
  63
  64   tar xzvf groff-<version>.tar.gz
  65   cd groff-<version>
  66   gunzip -c ../groff-<version>-current.diff.gz | patch -p1
  67
  68 Depending on your requirements, you may need at least some of the
  69 following tools to build groff directly from its source:
  70
  71   ghostscript
  72   the psutils package
  73   the netpbm package
  74   texinfo 4.8
  75   bison >= 1.875b or byacc
  76
  77 Note that texinfo and bison or byacc are required only for building from
  78 CVS sources (either a checked out working copy, or a daily snapshot).
  79 They are not required for building from a stable release tarball.  Also
  80 note that the version numbers stated are the minimum supported.  No
  81 version of texinfo < 4.8 will work, and the original release of bison
  82 1.875 is known not to work; you *may* find that bison releases < 1.875
  83 will work, but in case of difficulty, please update to a later version
  84 *before* posting a bug report.
  85
  86 For *all* sources, you need ghostscript for creation of either PDF or HTML
  87 output; the netpbm and psutils packages are required only for HTML output.
  88 If you don't intend to produce output in either of these formats, then
  89 these packages are unnecessary.
  90
  91 Please report bugs using the form in the file BUG-REPORT; the idea of
  92 this is to make sure that FSF has all the information it needs to fix
  93 the bug.  At the very least, read the BUG-REPORT form and make sure
  94 that you supply all the information that it asks for.  Even if you are
  95 not sure that something is a bug, report it using BUG-REPORT: this will
  96 enable us to determine whether it really is a bug or not.
  97
  98 Three mailing lists are available:
  99
 100   bug-groff@gnu.org          for reporting bugs
 101   groff@gnu.org              for general discussion of groff
 102   groff-commit@gnu.org       a read-only list showing commitments
 103                              to the CVS repository
 104
 105 You can post mails directly to the `bug-groff' list, without subscribing;
 106 to post mails to the `groff' list you must subscribe to it.
 107
 108 To subscribe, send a mail to <list>-request@<domain> (example:
 109 groff-request@gnu.org for the `groff' list) with the word `subscribe'
 110 in either the subject or body of the email (don't include the quotes).
 111 Alternatively, you may subscribe by visiting the web pages at
 112
 113   http://lists.gnu.org/mailman/listinfo/bug-groff
 114   http://lists.gnu.org/mailman/listinfo/groff
 115   http://lists.gnu.org/mailman/listinfo/groff-commit
 116
 117 Each of these web pages also provides a link to a browseable archive of
 118 postings to the corresponding mailing list.
 119
 120 GNU groff was written by James Clark <jjc@jclark.com>.  It is now
 121 maintained by Ted Harding <ted.harding@nessie.mcc.ac.uk> and Werner
 122 Lemberg <wl@gnu.org>.