INSTALL revision 75584
175584SruTo install groff, follow the instructions in the file INSTALL.gen.
275584Sru
375584SruThis file contains information that supplements those instructions.
4104862Sru
575584Sru(For instructions how to build groff with DJGPP tools for MS-DOS and
675584SruMS-Windows, see the file arch/djgpp/README.)
775584Sru
875584Srugroff is written in C++, so you will need a C++ compiler.  The C++
975584Srusource files use a suffix of `.cc', so your C++ compiler must be able
1075584Sruto handle this.  If you don't already have a C++ compiler, I suggest
1175584Srugcc 2.7.1 or later (gcc version 2 includes GNU C++ as well as GNU C).
1275584SruFrom gcc 2.5, it is no longer necessary to install libg++: the C++
1375584Sruheader files needed by groff are created by the gcc installation
1475584Sruprocess.  To override configure's choice of C++ compiler, you can set
1575584Sruthe CXX environment variable.
1675584Sru
1775584SruIf you have a library that provides a faster malloc than your system's
1875584Sruusual malloc, it is good idea to include it in LIBS.  For example,
1975584Sruusing the malloc that comes with GNU Emacs version 20 can give a
2075584Sruworthwhile (and sometimes spectacular) performance improvement.
2175584Sru
2275584SruIf you want A4 or letter paper format and the configure script produces
2375584Sruan incorrect guess, say
2475584Sru
2575584Sru  PAGE=xxx ./configure
2675584Sru
2775584Sruwhere `xxx' should be either `A4' or `letter'.  Note that this will only
2875584Sruaffect the paper selection for grops.  For compatibility with ditroff,
2975584Sruthe default page length in gtroff is always 11 inches.  The page length
3075584Srucan be changed with the `pl' request.
3175584Sru
3275584SruWhen you have built groff, you can use the test-groff script to try
3375584Srugroff out on one of the man pages.  (Use the .n files not the .man
3475584Srufiles.)  The test-groff script sets up environment variables to allow
3575584Srugroff to run without being installed.  The current directory must be
3675584Sruthe build directory when the script is run.  For example, you could do
3775584Sru
3875584Sru  ./test-groff -man -Tascii src/roff/groff/groff.n | less
3975584Sru
4075584SruIf you want to compile and install gxditview (an X11 previewer),
4175584Srufollow the instructions in the INSTALL file in the src/xditview
4275584Srusubdirectory.
4375584Sru
4475584SruTo get PostScript versions of the documentation resp. reference files
4575584Srufor the `me' macros and the `pic' preprocessor, simply say `make' in
4675584Sruthe `doc' subdirectory.
4775584Sru
4875584SruIf you have problems, read the PROBLEMS file.  If this doesn't help
4975584Srusend a bug report using the form in the file BUG-REPORT.
5075584Sru