README

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