* doc/groff.texinfo: Added section about man macro package
[s-roff.git] / INSTALL
blob3818263c590aeaa881dd6ff701b831539f7e66e2
1 To install groff, follow the instructions in the file INSTALL.gen.
3 This file contains information that supplements those instructions.
5 groff is written in C++, so you will need a C++ compiler.  The C++
6 source files use a suffix of `.cc', so your C++ compiler must be able
7 to handle this.  If you don't already have a C++ compiler, I suggest
8 gcc 2.7.1 or later (gcc version 2 includes GNU C++ as well as GNU C).
9 From gcc 2.5, it is no longer necessary to install libg++: the C++
10 header files needed by groff are created by the gcc installation
11 process.  To override configure's choice of C++ compiler, you can set
12 the CXX environment variable.
14 If you have a library that provides a faster malloc than your system's
15 usual malloc, it is good idea to include it in LIBS.  For example,
16 using the malloc that comes with GNU Emacs version 20 can give a
17 worthwhile (and sometimes spectacular) performance improvement.
19 When you have built groff, you can use the test-groff script to try
20 groff out on one of the man pages.  (Use the .n files not the .man
21 files.)  The test-groff script sets up environment variables to allow
22 groff to run without being installed.  The current directory must be
23 the build directory when the script is run.  For example, you could do
25   ./test-groff -man -Tascii src/roff/groff/groff.n | less
27 If you want to install gxditview (an X11 previewer), follow the
28 instructions in the INSTALL file in the xditview directory.
30 To get PostScript versions of the documentation resp. reference files
31 for the `me' macros and the `pic' preprocessor, simply say `make' in
32 the `doc' subdirectory.
34 If you have problems, read the PROBLEMS file.  If this doesn't help
35 send a bug report using the form in the file BUG-REPORT.