Debian Codegraph @

cextern/xpa/INSTALL

raw
1 Quick Summary
2 =============
3
4 To build and install the XPA package, simply execute:
5
6 ./configure # site-specific configuration
7 make # build the software
8 make install # install it
9 make clean # clean up unneeded temp files
10
11 We strongly recommend that you install in a directory other than the
12 default of /usr/local, so as not to require root access. To do this,
13 configure for a different install directory:
14
15 ./configure --prefix=<top_level_install_dir>
16 e.g.,
17 ./configure --prefix=/soft/saord
18
19 Programs will be installed in /soft/saord/bin, libraries in /soft/saord/lib,
20 include files in /soft/saord/include, and man pages in /soft/saord/man.
21 Indeed, we do this at SAO and recommend it as a general rule, in order
22 to keep SAORD software in one place that does not conflict with other
23 installations. Note that you will need to add the bin directory to
24 your path and the man directory to MANPATH.
25
26 The build ("make") takes only a minute or so on modern machines. To
27 monitor its progress and/or check for errors, redirect output to a file
28 and use the 'tail' command:
29
30 make >& foo.log &; tail -f foo.log # csh
31 or
32 make 1>foo.log 2>&1 &; tail -f foo.log # sh, bash
33
34
35 Details of Installation
36 =======================
37
38 NB: These are generic installation instructions, modified for XPA.
39
40 The `configure' shell script attempts to guess correct values for
41 various system-dependent variables used during compilation. It uses
42 those values to create a `Makefile' in each directory of the package.
43 It may also create one or more `.h' files containing system-dependent
44 definitions. Finally, it creates a shell script `config.status' that
45 you can run in the future to recreate the current configuration, a file
46 `config.cache' that saves the results of its tests to speed up
47 reconfiguring, and a file `config.log' containing compiler output
48 (useful mainly for debugging `configure').
49
50 If you need to do unusual things to compile the package, please try
51 to figure out how `configure' could check whether to do them, and mail
52 diffs or instructions to the address given in the `README' so they can
53 be considered for the next release. If at some point `config.cache'
54 contains results you don't want to keep, you may remove or edit it.
55
56 The file `configure.in' is used to create `configure' by a program
57 called `autoconf'. You only need `configure.in' if you want to change
58 it or regenerate `configure' using a newer version of `autoconf'.
59
60 The simplest way to compile this package is:
61
62 `./configure' to configure the package for your system. If you're
63 using `csh' on an old version of System V, you might need to type
64 `sh ./configure' instead to prevent `csh' from trying to execute
65 `configure' itself.
66
67 Running `configure' takes awhile. While running, it prints some
68 messages telling which features it is checking for.
69
70 1. `cd' to the directory containing the package's source code and type
71 "./configure". This runs a configuration script created by GNU
72 autoconf, which configures XPA for your system and creates a
73 Makefile. The configure script allows you to customize the XPA
74 configuration for your site; for details on how you can do this,
75 type "./configure -help" or refer to the autoconf documentation (not
76 included here). The XPA "configure" script supports the following special
77 switch(es) in addition to the standard ones:
78
79 --enable-shared=yes|link
80
81 Build shared libraries in addition to the
82 default static library. There are two options:
83
84 If the value is "yes", shared libraries are
85 built but not used to link xpa programs.
86
87 If the value is "link", shared libraries are
88 used to link xpa programs. If therefore becomes
89 your responsibility to put the shared library
90 where it can be found (or use LD_LIBRARY_PATH).
91
92 --enable-threaded-xpans
93 Build xpans to support separate threads for
94 handling name server requests and xpa proxy
95 callbacks. This is recommended if you are going
96 to enable proxy handling in xpans (-P), since
97 XPA long callbacks via proxy can interfere
98 with the name server functions. (You still have
99 to start xpans with -P 2 to use 2 threads.)
100
101 --with-tcl=<dir>
102 Force build Tcl support using parameters found
103 in <dir>/tclConfig.sh. Configure will look for
104 the Tcl config script in standard places and
105 will enable Tcl support if found. It will abort
106 if tclConfig.sh points to a non-existent tcl.h
107 file (some versions of Linux have shown this
108 behavior). Use this switch to override the
109 standard locations or to force a build even
110 if tcl.h is not found (e.g. if you are going to
111 install tcl as part of a larger build). With
112 Tcl support enabled you can execute:
113
114 make tclxpa
115
116 to generate the XPA package as a shared Tcl
117 object, loadable using Tcl "package require".
118 Contact us with problems -- its been a bear to
119 get this even half-way right.
120
121 --with-threads
122 If you are going to link XPA into a threaded
123 program, you need to specify --with-threads.
124 This add -D_REENTRANT to the compiler flags,
125 which tells gcc to use thread-safe versions of
126 global system variables such as errno. No code
127 changes are made to XPA. Please note that all
128 XPA calls must be in a single thread: XPA is
129 not thread-safe in and of itself but does work
130 in threaded programs.
131
132 --with-gtk=<include_dir>
133 Build with support for adding xpa to a gtk
134 loop. The specified include directory must
135 contain the gtk directory which itself contains
136 gtk.h, e.g.:
137
138 --with-gtk=/usr/local/include/gtk-1.2
139
140 which contains gtk/gtk.h
141
142 Standard options are listed below. the most important of which
143 are --exec-prefix and --prefix (to specify where to install), and
144 --x-includes=DIR and --x-libraries=DIR (for non-standard X installations).
145 We recommend --prefix be set to a directory that will hold saord software
146 (e.g., --prefix=/soft/saord) in order to make management of our software
147 easier.
148
149 NB: be sure to use only absolute path names (those starting with "/")
150 in the --prefix and --exec_prefix options. (The configure options we
151 use at SAO for various machines are given as examples in the script
152 file called "saoconfig" in this directory.)
153
154 2. Type `make' to compile the package.
155 This will create a library archive called libxpa.a. It also will create
156 the programs xpaget, xpaset, xpainfo, xpaaccess, xpans, and xpamb. It
157 also will create the libxpa.so shared object if requested using the
158 --enable-shared switch
159
160 3. You can build the libxpa.so shared library manually by executing:
161
162 make shlib
163
164 at this point. This will not contain Xt or Tcl routines. If Tcl support
165 has been enabled (see --with-tcl above), you can build a shared library
166 called libtclxpa.so that supports the tclxpa package (i.e. Tcl routines
167 are contained in it) by executing:
168
169 make tclxpa
170
171 This shared library will be loaded automatically with the Tcl command:
172
173 package require tclxpa 2.1
174
175 assuming, of course, that your shared library can be found by Tcl.
176
177 4. Type "make install" to install XPA's libraries and binaries in
178 standard places. You'll need write permission on the installation
179 directories to do this. The installation directories are
180 determined by the "configure" script and may be specified with
181 the --prefix and --exec_prefix options to "configure". See the
182 Makefile for information on what directories were chosen; you
183 can override these choices by modifying the "prefix" and
184 "exec_prefix" variables in the Makefile.
185
186 5. There are .html help files in the doc directory. You can copy
187 these files to a more convenient location, if you like. We
188 did not automate this step because we did not know where to
189 copy these files by default. (NB: The help.html file is the
190 top level index file.)
191
192 6. You can remove the program binaries and object files from the
193 source code directory by typing `make clean'. To also remove the
194 files that `configure' created (so you can compile the package for
195 a different kind of computer), type `make distclean'. There is
196 also a `make maintainer-clean' target, but that is intended mainly
197 for the package's developers. If you use it, you may have to get
198 all sorts of other programs in order to regenerate files that came
199 with the distribution.
200
201 Compilers and Options
202 =====================
203
204 Some systems require unusual options for compilation or linking that
205 the `configure' script does not know about. You can give `configure'
206 initial values for variables by setting them in the environment:
207
208 ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
209
210 You also can use this facility to specify a compiler other than the default
211 gcc (if it exists).
212
213 Installation Names
214 ==================
215
216 By default, `make install' will install the package's files in
217 `/usr/local/bin', `/usr/local/lib', etc. You can specify an
218 installation prefix other than `/usr/local' by giving `configure' the
219 option `--prefix=PATH':
220
221 e.g.,
222 ./configure --prefix=/soft/saord
223
224 Programs will be installed in /soft/saord/bin, libraries in /soft/saord/lib,
225 and include files in /soft/saord/include. We recommend this as a general rule,
226 in order to keep SAORD software in one place that does not conflict with other
227 installations. Note that you will need to add the bin directory to your path.
228
229 You can specify separate installation prefixes for architecture-specific
230 files and architecture-independent files. If you give `configure' the option
231 `--exec-prefix=PATH', the package will use PATH as the prefix for installing
232 programs and libraries. Documentation and other data files will still use the
233 regular prefix.
234
235 In addition, if you use an unusual directory layout you can give
236 options like `--bindir=PATH' to specify different values for particular
237 kinds of files. Run `configure --help' for a list of the directories
238 you can set and what kinds of files go in them.
239
240 If the package supports it, you can cause programs to be installed
241 with an extra prefix or suffix on their names by giving `configure' the
242 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
243
244 Optional Features
245 =================
246
247 Some packages pay attention to `--enable-FEATURE' options to
248 `configure', where FEATURE indicates an optional part of the package.
249 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
250 is something like `gnu-as' or `x' (for the X Window System). The
251 `README' should mention any `--enable-' and `--with-' options that the
252 package recognizes.
253
254 For packages that use the X Window System, `configure' can usually
255 find the X include and library files automatically, but if it doesn't,
256 you can use the `configure' options `--x-includes=DIR' and
257 `--x-libraries=DIR' to specify their locations.
258
259 Specifying the System Type
260 ==========================
261
262 There may be some features `configure' can not figure out
263 automatically, but needs to determine by the type of host the package
264 will run on. Usually `configure' can figure that out, but if it prints
265 a message saying it can not guess the host type, give it the
266 `--host=TYPE' option. TYPE can either be a short name for the system
267 type, such as `sun4', or a canonical name with three fields:
268 CPU-COMPANY-SYSTEM
269
270 See the file `config.sub' for the possible values of each field. If
271 `config.sub' isn't included in this package, then this package doesn't
272 need to know the host type.
273
274 If you are building compiler tools for cross-compiling, you can also
275 use the `--target=TYPE' option to select the type of system they will
276 produce code for and the `--build=TYPE' option to select the type of
277 system on which you are compiling the package.
278
279 Sharing Defaults
280 ================
281
282 If you want to set default values for `configure' scripts to share,
283 you can create a site shell script called `config.site' that gives
284 default values for variables like `CC', `cache_file', and `prefix'.
285 `configure' looks for `PREFIX/share/config.site' if it exists, then
286 `PREFIX/etc/config.site' if it exists. Or, you can set the
287 `CONFIG_SITE' environment variable to the location of the site script.
288 A warning: not all `configure' scripts look for a site script.
289
290 Operation Controls
291 ==================
292
293 `configure' recognizes the following options to control how it
294 operates.
295
296 `--cache-file=FILE'
297 Use and save the results of the tests in FILE instead of
298 `./config.cache'. Set FILE to `/dev/null' to disable caching, for
299 debugging `configure'.
300
301 `--help'
302 Print a summary of the options to `configure', and exit.
303
304 `--quiet'
305 `--silent'
306 `-q'
307 Do not print messages saying which checks are being made. To
308 suppress all normal output, redirect it to `/dev/null' (any error
309 messages will still be shown).
310
311 `--srcdir=DIR'
312 Look for the package's source code in directory DIR. Usually
313 `configure' can determine that directory automatically.
314
315 `--version'
316 Print the version of Autoconf used to generate the `configure'
317 script, and exit.
318
319 `configure' also accepts some other, not widely useful, options.
320
321 If you have questions, please contact us at: [email protected].
322
323 Eric Mandel