README

   1     Copyright (C) 1989-2018 Free Software Foundation, Inc.
   2
   3     Copying and distribution of this file, with or without
   4     modification, are permitted in any medium without royalty provided
   5     the copyright notice and this notice are preserved.
   6
   7 This is the GNU `groff' document formatting system.  The version
   8 number is given in the file VERSION.
   9
  10 Included in this release are implementations of `troff', `pic', `eqn',
  11 `tbl', `grn', `refer', `-man', `-mdoc', `-mom', and `-ms' macros, and
  12 drivers for `PostScript', `PDF', `TeX DVI' format, `HP LaserJet 4'
  13 printers, `Canon CAPSL' printers, `HTML' and `XHTML' formats (beta
  14 status), and typewriter-like devices.  Also included is a modified
  15 version of the Berkeley `-me' macros, the enhanced version `gxditview'
  16 of the X11 `xditview' previewer, and an implementation of the `-mm'
  17 macros contributed by Joergen Haegg.
  18
  19 See the file `INSTALL' for instructions on how to install from a
  20 release.  You will require a C++ compiler.
  21
  22 The file `INSTALL.REPO' contains supplementary instructions for
  23 building directly from a clone of the repository or a snapshot
  24 tarball.
  25
  26 The file `NEWS' describes recent user-visible changes to `groff'.
  27
  28 `groff' is free software.  See the file `COPYING' for copying
  29 permission.
  30
  31 The file `PROBLEMS' describes various problems that have been
  32 encountered in compiling, installing, and running `groff'.
  33
  34 The file `MORE.STUFF' contains information about add-on packages
  35 useful for `groff'.
  36
  37 The most recent released version of `groff' is always available by
  38 anonymous ftp from `ftp.gnu.org' in the directory `gnu/groff'.
  39
  40 The current development version of `groff' is available from a git
  41 repository at
  42
  43   https://savannah.gnu.org/git/?group=groff
  44
  45 To view the git repository in your browser, go to
  46
  47   http://git.savannah.gnu.org/cgit/groff.git
  48
  49 There you can also download snapshots; simply click on a commit entry
  50 line to get the URL.
  51
  52 Depending on your requirements, you may need at least some of the
  53 following tools to build `groff' directly from its source:
  54
  55   perl >= v5.6.1 (see macro GROFF_PERL in file `m4/groff.m4')
  56   ghostscript
  57   the psutils package
  58   the netpbm package
  59   texinfo 4.8
  60   bison >= 1.875b or byacc
  61
  62 Note that `texinfo' and `bison' or `byacc' are required only for
  63 building from repository sources (either a checked out working copy,
  64 or a commit snapshot).  They are not required for building from a
  65 stable release tarball.  Also note that the version numbers stated are
  66 the minimum supported.  No version of `texinfo' < 4.8 works, and the
  67 original release of `bison' 1.875 is known not to work; you *may* find
  68 that `bison' releases < 1.875 work, but in case of difficulty, please
  69 update to a later version *before* posting a bug report.
  70
  71 For *all* sources, you need `ghostscript' for creation of either `PDF'
  72 or `HTML' output; the `netpbm' and `psutils' packages are required
  73 only for `HTML' output (and for compilation from the repository).  If
  74 you don't intend to produce output in either of these formats, then
  75 these packages are unnecessary.
  76
  77 Additionally, producing `PDF' output directly with the `gropdf' device needs
  78 a working installation of `perl'.  The same is true for some other
  79 preprocessors like `chem'.
  80
  81 The `groff' configure script searches for the X11 headers and
  82 libraries `Xaw' and `Xmu'.  So the corresponding developer packages of
  83 your system must be installed, otherwise `groff' does not install
  84 `gxditview' and the `-TX*' devices.  In Debian, the developer packages
  85 are `libxaw7-dev' and `libxmu-dev'.
  86
  87 Please report bugs using the bug tracker available from the project
  88 page at
  89
  90   https://savannah.gnu.org/projects/groff
  91
  92 You may use the form in the file `BUG-REPORT'; the idea of this is to
  93 make sure that FSF has all the information it needs to fix the bug.
  94 At the very least, read the `BUG-REPORT' form and make sure that you
  95 supply all the information that it asks for.  Even if you are not sure
  96 that something is a bug, report it: this enables us to determine whether
  97 it really is a bug.
  98
  99 Three mailing lists are available:
 100
 101   bug-groff@gnu.org          for following bug reports
 102   groff@gnu.org              for general discussion of groff
 103   groff-commit@gnu.org       a read-only list to follow commits
 104                              to the git repository
 105
 106 To subscribe, send a mail to <list>-request@<domain> (example:
 107 groff-request@gnu.org for the `groff' list) with the word `subscribe'
 108 in either the subject or body of the e-mail (don't include the quotes).
 109 Alternatively, you may subscribe by visiting the web pages at
 110
 111   http://lists.gnu.org/mailman/listinfo/bug-groff
 112   http://lists.gnu.org/mailman/listinfo/groff
 113   http://lists.gnu.org/mailman/listinfo/groff-commit
 114
 115 Each of these web pages also provides a link to a browseable archive of
 116 postings to the corresponding mailing list.
 117
 118 GNU `groff' was written by James Clark <jjc@jclark.com>.
 119
 120
 121 ##### Emacs settings
 122 Local Variables:
 123 mode: text
 124 End: