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