File: INSTALL

package info (click to toggle)
dsc 1.0-5
  • links: PTS
  • area: main
  • in suites: slink
  • size: 1,212 kB
  • ctags: 587
  • sloc: lisp: 3,006; sh: 1,373; ansic: 862; cpp: 835; makefile: 229
file content (245 lines) | stat: -rw-r--r-- 10,945 bytes parent folder | download | duplicates (2)
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
These are generic installation instructions, with a few modifications
for dsc.

The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation.  It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions.  Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').

If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release.  If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.

The file `configure.in' is used to create `configure' by a program
called `autoconf'.  You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.

The simplest way to compile this package, presuming you have neither
SP nor Elk already installed, is:

  1. `cd' to the directory containing the package's source code and type
     `./configure' to configure the package for your system.  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.

     Running `configure' takes awhile.  While running, it prints some
     messages telling which features it is checking for.

  2. Type `make' to compile the package.

  3. Type `make install' to install dsc.

  4. You can remove the program binaries and object files from the
     source code directory by typing `make clean'.  To also remove the
     files that `configure' created (so you can compile the package for
     a different kind of computer), type `make distclean'.

  5. Note however that some files in the `scm' sub-directory of the
     distribution source are accessed at runtime, so you cannot delete
     the entire source tree.

Building Elk on architectures other than SunOS and FreeBSD
==========================================================
Elk has its own idiosyncratic non-standard approach to
architecture-dependent configuration, which involves a pre-built set
of candidate configuration files.  If you are building on any
architecture OTHER than SunOS (4 or 5) or FreeBSD, you will lose with
an error at Elk configuration time involving a missing 'system' file
in the elk-3.0/config directory.  This file needs to be linked to an
appropriate file in the same directory, or in the 'untried' subdirectory.
If you make another architecture work, please let me know how.

Pre-installed SP and/or Elk
===========================

dsc makes use of SGML parsing and grove support from the SP-1.1.1
distribution, and the Scheme interpreter from the Elk-3.0
distribution.  The necessary parts of these distributions are included
in the dsc distribution, as compressed tar files, but if you already
have one or both of these facilities installed, you can signal this to
`configure' and avoid duplication.  Use `--with-sp' and/or
`--with-elk' to indicate that the named package is pre-installed.
Note that the version of SP you have installed must have been
configured for multi-byte chararcter support and include the grove and
spgrove libraries from the JADE distribution.  If you are just running
`nsgmls' in an 8-bit environment, this is NOT what you will have set
up, so you should not set `--with-sp'.

The `--help' option will give a brief summary of all possible options,
including those special to dsc.

If the pre-installation is NOT in the default
(/usr/local/{lib,include}) place, use the directory-setting options
`configure' provides to get the basic paths sorted out, and if
necessary supply a sub-directory argument to `--with-sp' or
`--with-elk'.  For example, in my installation we have a separate
directory tree for user contributions, and the Elk libraries and
headers are in subdirectories, so I say

 .../configure --prefix=/usr/contrib --exec-prefix=/usr/contrib --with-elk=elk

which means the Elk headers will be searched for in
/usr/contrib/include/elk and the Elk runtime in /usr/contrib/lib/elk.
If even this isn't enough, you can specify specific library and
include directories for each pre-installed package with environment
variables named SPLIBDIR, SPINCLDIR, ELKLIBDIR and ELKINCLDIR, e.g.

 SPINCLDIR=/usr/local/share/include .../configure --with-sp --with-elk

[The above is 'sh' syntax -- under e.g. 'csh' you will have to do

(setenv SPINCLDIR /usr/local/share/include; .../configure --with-sp --with-elk)
]

Note that if you include `--with-sp', you MUST also include whatever
other optional extras you used when you installed SP yourself.  Thus
if you enabled http for system ids, you must include `--enable-http'
and if you provided a built-in default catalog, you must include
`--enable-default-catalog=<pathlist>'.  You don't need to worry about
multi-byte characters or grove support, that is taken care of
automatically.  Note that if you can't remember, check the
config.status file in the directory where you built SP, which records
the switches used at that time.

If configure can't find bits of the pre-installed packages, it will
give warning messages to this effect, suggesting possible remedies.
You should sort out the header files first, then the libraries.

In the end, if you can't get it sorted out, do let me know
(ht@cogsci.ed.ac.uk), with as much detail as possible, particularly
config.status and config.log, and give up and remove the --with-xxx
switch(es) which is/are causing the problems and let the supplied tar
files be used.

Compilers and Options
=====================

Some systems require unusual options for compilation or linking that
the `configure' script does not know about.  You can give `configure'
initial values for variables by setting them in the environment.  Using
a Bourne-compatible shell, you can do that on the command line like
this:
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure

Or on systems that have the `env' program, you can do it like this:
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure

Compiling For Multiple Architectures
====================================

You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory.  To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
directory where you want the object files and executables to go and
run the `configure' script.  `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.

If you have to use a `make' that does not supports the `VPATH'
variable, you have to compile the package for one architecture at a time
in the source code directory.  After you have installed the package for
one architecture, use `make distclean' before reconfiguring for another
architecture.

Installation Names
==================

By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.

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.
Documentation and other data files will still use the regular prefix.

In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files.  Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.

If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

Optional Features
=================

This package pays attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
It also pays attention to `--with-PACKAGE' options, where PACKAGE
is either `sp' or `elk'.  See the section "Pre-installed SP and/or
Elk" above.

Specifying the System Type
==========================

There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on.  Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option.  TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
     CPU-COMPANY-SYSTEM

See the file `config.sub' for the possible values of each field.  If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.

If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.

Sharing Defaults
================

If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists.  Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.

Operation Controls
==================

`configure' recognizes the following options to control how it
operates.

`--cache-file=FILE'
     Use and save the results of the tests in FILE instead of
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
     debugging `configure'.

`--help'
     Print a summary of the options to `configure', and exit.

`--quiet'
`--silent'
`-q'
     Do not print messages saying which checks are being made.  To
     suppress all normal output, redirect it to `/dev/null' (any error
     messages will still be shown).

`--srcdir=DIR'
     Look for the package's source code in directory DIR.  Usually
     `configure' can determine that directory automatically.

`--version'
     Print the version of Autoconf used to generate the `configure'
     script, and exit.

`configure' also accepts some other, not widely useful, options.