Fix kldstat option.
[dragonfly.git] / contrib / groff-1.19 / 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 will
14 require 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_RSH=ssh; export CVS_RSH
34   cvs -d:ext:anoncvs@savannah.gnu.org/cvsroot/groff -z5 co groff
35
36 (Note that you need an `ssh' client for security reasons.)
37
38 This will create a subdirectory, `~/cvswork/groff', with a "checked
39 out" copy of the `CVS' repository.  An update of this working copy may
40 be achieved, at any later time by invoking the commands
41
42   cd ~/cvswork/groff
43   CVS_RSH=ssh cvs -z5 update -dP
44
45 Please read the `CVS' info pages for further details.
46
47 Finally, it is possible to access the `CVS' with a web browser by
48 pointing it to
49
50   http://savannah.gnu.org/cvs/?group=groff
51
52 Alternatively, you can download snapshots (which are updated twice a day).
53 The complete `groff' source as a single file is available at
54
55   http://groff.ffii.org/groff/devel/groff-current.tar.gz
56
57 A diff file relative to `groff-<version>', the latest official `groff'
58 release is available at
59
60   http://groff.ffii.org/groff/devel/groff-<version>-current.diff.gz
61
62 Assuming that `groff-<version>.tar.gz' and
63 `groff-<version>-current.diff.gz' are in the same directory, do the
64 following to apply the diff file:
65
66   tar xzvf groff-<version>.tar.gz
67   cd groff-<version>
68   gunzip -c ../groff-<version>-current.diff.gz | patch -p1
69
70 Depending on your requirements, you may need at least some of the
71 following tools to build `groff' directly from its source:
72
73   ghostscript
74   the psutils package
75   the netpbm package
76   texinfo 4.8
77   bison >= 1.875b or byacc
78
79 Note that `texinfo' and `bison' or `byacc' are required only for
80 building from `CVS' sources (either a checked out working copy, or a
81 daily snapshot).  They are not required for building from a stable
82 release tarball.  Also note that the version numbers stated are the
83 minimum supported.  No version of `texinfo' < 4.8 will work, and the
84 original release of `bison' 1.875 is known not to work; you *may* find
85 that `bison' releases < 1.875 will work, but in case of difficulty,
86 please update to a later version *before* posting a bug report.
87
88 For *all* sources, you need ghostscript for creation of either `PDF' or
89 `HTML' output; the `netpbm' and `psutils' packages are required only for
90 `HTML' output.  If you don't intend to produce output in either of these
91 formats, then these packages are unnecessary.
92
93 In Linux Debian, the installation of `texinfo' is dangerous.  For it
94 creates a file `install-info' that will block the system installation.
95 So the created `/usr/local/bin/install-info' must be renamed.
96
97 The `groff' configure script searches for the X11 headers and
98 libraries `Xaw' and `Xmu'.  So the corresponding developer packages of
99 your system must be installed, otherwise `groff' does not install
100 `gxditview' and the `-TX*' devices.  In Debian, the developer packages
101 are `libxaw7-dev' and `libxmu-dev'.
102
103 Please report bugs using the form in the file `BUG-REPORT'; the idea of
104 this is to make sure that FSF has all the information it needs to fix
105 the bug.  At the very least, read the `BUG-REPORT' form and make sure
106 that you supply all the information that it asks for.  Even if you are
107 not sure that something is a bug, report it using `BUG-REPORT': this will
108 enable us to determine whether it really is a bug or not.
109
110 Three mailing lists are available:
111
112   bug-groff@gnu.org          for reporting bugs
113   groff@gnu.org              for general discussion of groff
114   groff-commit@gnu.org       a read-only list showing commitments
115                              to the CVS repository
116
117 You can post mails directly to the `bug-groff' list, without subscribing;
118 to post mails to the `groff' list you must subscribe to it.
119
120 To subscribe, send a mail to <list>-request@<domain> (example:
121 groff-request@gnu.org for the `groff' list) with the word `subscribe'
122 in either the subject or body of the email (don't include the quotes).
123 Alternatively, you may subscribe by visiting the web pages at
124
125   http://lists.gnu.org/mailman/listinfo/bug-groff
126   http://lists.gnu.org/mailman/listinfo/groff
127   http://lists.gnu.org/mailman/listinfo/groff-commit
128
129 Each of these web pages also provides a link to a browseable archive of
130 postings to the corresponding mailing list.
131
132 GNU `groff' was written by James Clark <jjc@jclark.com>.  It is now
133 maintained by Ted Harding <ted.harding@nessie.mcc.ac.uk> and Werner
134 Lemberg <wl@gnu.org>.