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 refer, the -man macros and the -ms macros, and drivers for PostScript,
   6 TeX dvi format, HP LaserJet 4 printers, HTML format (still alpha), and
   7 typewriter-like devices.  Also included is a modified version of the
   8 Berkeley -me macros, an enhanced version of the X11 xditview
   9 previewer, and an implementation of the -mm macros contributed by
  10 Joergen Haegg (jh@axis.se).
  11
  12 See the file INSTALL for installation instructions.  You will require
  13 a 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
  20 encountered in compiling, installing, and running groff.
  21
  22 For the moment, the documentation assumes that you are already
  23 familiar with the Unix versions of troff, -man, -ms and the
  24 preprocessors.
  25
  26 The most recent released version of groff is always available by
  27 anonymous ftp from ftp.gnu.org in the directory pub/gnu/groff.
  28
  29 A CVS repository is now available, containing the current development
  30 version of groff.  You can access it with the commands
  31
  32   export CVSROOT=:pserver:anoncvs@anoncvs.ffii.org:/var/cvs
  33   cvs login
  34   cvs -z9 co groff
  35
  36 (if the prompt for the password appears, just press the enter key).
  37 After a successful login you no longer need the first two commands; an
  38 update of a checked out repository should be done with
  39
  40   cvs -z9 update -d
  41
  42 Please read the info pages of cvs for further details.
  43
  44 Alternatively, you can download snapshots (which are updated twice a
  45 day) from
  46
  47   ftp://ftp.ffii.org/pub/groff/devel/groff-current.tar.gz
  48
  49 or a diff file relative to the latest official groff release as
  50
  51   ftp://ftp.ffii.org/pub/groff/devel/groff-<version>-current.diff.gz
  52
  53 Please report bugs using the form in the file BUG-REPORT; the idea of
  54 this is to make sure that FSF has all the information it needs to fix
  55 the bug.  At the very least, read the BUG-REPORT form and make sure
  56 that you supply all the information that it asks for.  Even if you are
  57 not sure that something is a bug, report it using BUG-REPORT: this
  58 will enable us to determine whether it really is a bug or not.
  59
  60 Three mailing lists are available:
  61
  62   bug-groff@gnu.org          for reporting bugs
  63   groff@gnu.org              for general discussion of groff
  64   groff-commit@ffii.org      a read-only list showing logs of
  65                              commitments to the CVS repository
  66
  67 Note that groff@gnu.org is an alias for groff@ffii.org; you must be
  68 subscribed to the `groff' and `groff-commit' lists to send mails.
  69
  70 To subscribe, send a mail to <list>-request@<domain> (example:
  71 groff-request@ffii.org) with the word `subscribe' in either the
  72 subject or body of the email (don't include the quotes).
  73
  74 GNU groff was written by James Clark <jjc@jclark.com>.  It is now
  75 maintained by Ted Harding <ted.harding@nessie.mcc.ac.uk> and Werner
  76 Lemberg <wl@gnu.org>.