summaryrefslogtreecommitdiff
path: root/INSTALL
blob: 85aea2d931bab100c303ca4df41c38a5f00c44d7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
1. Get a C++ compiler.  The C++ source files use a suffix of `.cc', so
your C++ compiler must be able to handle this.  If you don't already
have a C++ compiler, I suggest the latest release of either g++
version 1 or gcc/g++ version 2. (g++ version 2 is included in gcc
version 2).  If you are using g++, you will also need to install the
corresponding version of libg++, unless your system header files
provide C++ support.  If you're using gcc/g++ version 2.[012], I
recommend you apply the patch in the file gcc.patch. (If you don't,
configure will detect this and work around the bug, but this will make
groff use significantly more memory.)

2. In the directory that this file is in, type `./configure'.  If
you're using `csh' on an old version of System V, you might need to
type `sh configure' instead to prevent `csh' from trying to execute
`configure' itself.

The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation, and
creates the Makefile.  It also creates a file `config.status' that you
can run in the future to recreate the current configuration.

Running `configure' takes a minute or two.  While it is running, it
prints some messages that tell what it is doing.  It also performs
some checks on your C++ compiler.  If these checks fail, it will print
a message and exit.  In this case, you should correct the problems
with your C++ compiler and then rerun configure.

To compile the package in a different directory from the one
containing the source code, you must use GNU make.  `cd' to the
directory where you want the object files and executables to go and
run `configure' with the option `--srcdir=DIR', where DIR is the
directory that contains the source code.  Using this option is
actually unnecessary if the source code is in the parent directory of
the one in which you are compiling; `configure' automatically checks
for the source code in `..' if it does not find it in the current
directory.

By default, `make install' will install the package's files in
/usr/local/bin, /usr/local/lib/groff, and /usr/local/man.  You can
specify an installation prefix other than /usr/local by giving
`configure' the option `--prefix=PATH'.  Alternately, you can do so by
changing the `prefix' variable in the Makefile that `configure'
creates.

You can specify separate installation prefixes for
architecture-specific files and architecture-independent files.  If
you give `configure' the option `--exec_prefix=PATH', the package will
use PATH as the prefix for installing programs and libraries.  Data
files and documentation will still use the regular prefix.  Normally,
all files are installed using the regular prefix.

You can tell `configure' to figure out the configuration for your
system, and record it in `config.status', without actually configuring
the package (creating `Makefile's and perhaps a configuration header
file).  To do this, give `configure' the `--no-create' option.  Later,
you can run `./config.status' to actually configure the package.  This
option is useful mainly in `Makefile' rules for updating `config.status'
and `Makefile'.  You can also give `config.status' the `--recheck'
option, which makes it re-run `configure' with the same arguments you
used before.  This is useful if you change `configure'.

`configure' ignores any other arguments that you give it.

If your system requires unusual options for compilation or linking
that `configure' doesn't know about, you can give `configure' initial
values for some variables by setting them in the environment.  In
Bourne-compatible shells, you can do that on the command line like
this:
	CC='gcc -traditional' DEFS=-D_POSIX_SOURCE ./configure

The `make' variables that you might want to override with environment
variables when running `configure' are:

(For these variables, any value given in the environment overrides the
value that `configure' would choose:)
CC		C compiler program.
		Default is `cc', or `gcc' if `gcc' is in your PATH.
CCC		C++ compiler program (for .cc files).
		By default, configure will look for gcc version 2, g++,
		and then CC.
INSTALL		Program to use to install files.
		Default is `install' if you have it, `cp' otherwise.
PAGE		This should be `A4' if your PostScript printer uses
		A4 paper and `letter' if your printer uses 8.5x11in
		paper.

(For these variables, any value given in the environment is added to
the value that `configure' chooses:)
DEFS		Configuration options, in the form `-Dfoo -Dbar ...'
LIBS		Libraries to link with, in the form `-lfoo -lbar ...'
CCLIBS		Libraries to link C++ programs with, in the same form.


If you need to do unusual things to compile the package, we encourage
you to figure out how `configure' could check whether to do them, and
mail diffs or instructions to the address given in the README so we
can include them in the next release.

3. Have a look at the generated Makefile.  The options you are most
likely to want to change are near the beginning.  Make sure that the
definition of PAGE is correct.

4. Type `make'.

5. Type `make install'.

6. If you want to install gxditview (an X11 previewer), follow the
instructions in the INSTALL file in the xditview directory.

7. Try groff out on one of the man pages, eg troff/troff.n.

If you have problems, read the PROBLEMS file.  If this doesn't help
send a bug report using the form in the file BUG-REPORT.