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 pub/gnu/groff.
  24
  25 A CVS repository is available (http://savannah.gnu.org/cvs/?group=groff),
  26 containing the current development version of groff.  You can access it
  27 with the commands
  28
  29   export CVS_RSH=ssh
  30   cvs -d:ext:anoncvs@savannah.gnu.org/cvsroot/groff -z5 co groff
  31
  32 Note that you need an SSH client for security reasons.
  33
  34 An update of a checked out repository should be done with
  35
  36   CVS_RSH=ssh cvs -z5 update -dP
  37
  38 Please read the info pages of cvs for further details.
  39
  40 Alternatively, you can download snapshots (which are updated twice a
  41 day) from
  42
  43   http://groff.ffii.org/groff/devel/groff-current.tar.gz
  44
  45 or a diff file relative to the latest official groff release as
  46
  47   http://groff.ffii.org/groff/devel/groff-<version>-current.diff.gz
  48
  49 Assuming that groff-<version>.tar.gz and
  50 groff-<version>-current.diff.gz are in the same directory, do the
  51 following to apply the diff file:
  52
  53   tar xzvf groff-<version>.tar.gz
  54   cd groff-<version>
  55   gunzip -c ../groff-<version>-current.diff.gz | patch -p1
  56
  57 Finally, it is possible to access the CVS with a browser by pointing it
  58 to
  59
  60   http://savannah.gnu.org/cvs/?group=groff
  61
  62 Please report bugs using the form in the file BUG-REPORT; the idea of
  63 this is to make sure that FSF has all the information it needs to fix
  64 the bug.  At the very least, read the BUG-REPORT form and make sure
  65 that you supply all the information that it asks for.  Even if you are
  66 not sure that something is a bug, report it using BUG-REPORT: this will
  67 enable us to determine whether it really is a bug or not.
  68
  69 Three mailing lists are available:
  70
  71   bug-groff@gnu.org          for reporting bugs
  72   groff@gnu.org              for general discussion of groff
  73   groff-commit@gnu.org       a read-only list showing commitments
  74                              to the CVS repository
  75
  76 You must be subscribed to the `groff' list to send mails.
  77
  78 To subscribe, send a mail to <list>-request@<domain> (example:
  79 groff-request@gnu.org) with the word `subscribe' in either the subject
  80 or body of the email (don't include the quotes) or have a look at the
  81 groff mailing list web pages at
  82
  83   http://lists.gnu.org/mailman/listinfo/bug-groff
  84   http://lists.gnu.org/mailman/listinfo/groff
  85   http://lists.gnu.org/mailman/listinfo/groff-commit
  86
  87 GNU groff was written by James Clark <jjc@jclark.com>.  It is now
  88 maintained by Ted Harding <ted.harding@nessie.mcc.ac.uk> and Werner
  89 Lemberg <wl@gnu.org>.