/contrib/groff/INSTALL

 1To install groff, follow the instructions in the file INSTALL.gen.
 2
 3This file contains information that supplements those instructions.
 4
 5(For instructions how to build groff with DJGPP tools for MS-DOS and
 6MS-Windows, see the file arch/djgpp/README.)
 7
 8(For instructions how to build groff with the MinGW tools for
 9MS-Windows, see the file README.MinGW.)
10
11groff is written in C++, so you will need a C++ compiler.  The C++
12source files use a suffix of `.cpp', so your C++ compiler must be able
13to handle this.  If you don't already have a C++ compiler, I suggest
14gcc 2.7.1 or later (gcc version 2 includes GNU C++ as well as GNU C).
15From gcc 2.5, it is no longer necessary to install libg++: the C++
16header files needed by groff are created by the gcc installation
17process.  To override configure's choice of C++ compiler, you can set
18the CXX environment variable.
19
20If you have a library that provides a faster malloc than your system's
21usual malloc, it is good idea to include it in LIBS.  For example,
22using the malloc that comes with GNU Emacs version 20 can give a
23worthwhile (and sometimes spectacular) performance improvement.
24
25If you want A4 or letter paper format and the configure script produces
26an incorrect guess, say
27
28  PAGE=xxx ./configure
29
30where `xxx' should be either `A4' or `letter'.  Note that this will only
31affect the paper selection of some device drivers like grops (which can
32be still overridden on the command line).  For compatibility with
33ditroff, the default page length in gtroff is always 11 inches.  The
34page length can be changed with the `pl' request.
35
36When you have built groff, you can use the test-groff script to try
37groff out on one of the man pages.  (Use the .n files not the .man
38files.)  The test-groff script sets up environment variables to allow
39groff to run without being installed.  For example, you could do
40
41  ./test-groff -man -Tascii src/roff/groff/groff.n | less
42
43To get a DVI, PDF, or HTML version of the groff texinfo manual, say `make
44groff.dvi', `make groff.pdf', or `make groff.html', respectively, in the
45`doc' subdirectory (after configuring the groff package).  Note that you
46need texinfo version 4.6 as a prerequisite.  Neither older versions nor
47texinfo 4.7 (due to a bug) will work.
48
49If you have problems, read the PROBLEMS file.  If this doesn't help
50send a bug report using the form in the file BUG-REPORT.