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