contrib/groff/INSTALL

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