xref: /reactos/dll/3rdparty/libtirpc/INSTALL (revision c2c66aff)
1Copyright 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
2Foundation, Inc.
3
4   This file is free documentation; the Free Software Foundation gives
5unlimited permission to copy, distribute and modify it.
6
7
8TI-RPC Library Quick Installation
9=================================
10
11   Without GSS API
12
13$ ./configure
14$ make
15# make install
16
17   To enable utilization of RPCSEC via GSS API use following commands
18but you need to install libgssapi from the CITI before
19
20$ ./configure --enable-gss
21$ make
22# make install
23
24   Once installed, you can customize the /etc/netconfig configuration file
25to configure the supported protocols. To support INET6 udp/tcp, uncomment
26the udp6/tcp6 lines.
27
28
29Basic Installation
30==================
31
32   These are generic installation instructions.
33
34   The `configure' shell script attempts to guess correct values for
35various system-dependent variables used during compilation.  It uses
36those values to create a `Makefile' in each directory of the package.
37It may also create one or more `.h' files containing system-dependent
38definitions.  Finally, it creates a shell script `config.status' that
39you can run in the future to recreate the current configuration, and a
40file `config.log' containing compiler output (useful mainly for
41debugging `configure').
42
43   It can also use an optional file (typically called `config.cache'
44and enabled with `--cache-file=config.cache' or simply `-C') that saves
45the results of its tests to speed up reconfiguring.  (Caching is
46disabled by default to prevent problems with accidental use of stale
47cache files.)
48
49   If you need to do unusual things to compile the package, please try
50to figure out how `configure' could check whether to do them, and mail
51diffs or instructions to the address given in the `README' so they can
52be considered for the next release.  If you are using the cache, and at
53some point `config.cache' contains results you don't want to keep, you
54may remove or edit it.
55
56   The file `configure.ac' (or `configure.in') is used to create
57`configure' by a program called `autoconf'.  You only need
58`configure.ac' if you want to change it or regenerate `configure' using
59a newer version of `autoconf'.
60
61The simplest way to compile this package is:
62
63  1. `cd' to the directory containing the package's source code and type
64     `./configure' to configure the package for your system.  If you're
65     using `csh' on an old version of System V, you might need to type
66     `sh ./configure' instead to prevent `csh' from trying to execute
67     `configure' itself.
68
69     Running `configure' takes awhile.  While running, it prints some
70     messages telling which features it is checking for.
71
72  2. Type `make' to compile the package.
73
74  3. Optionally, type `make check' to run any self-tests that come with
75     the package.
76
77  4. Type `make install' to install the programs and any data files and
78     documentation.
79
80  5. You can remove the program binaries and object files from the
81     source code directory by typing `make clean'.  To also remove the
82     files that `configure' created (so you can compile the package for
83     a different kind of computer), type `make distclean'.  There is
84     also a `make maintainer-clean' target, but that is intended mainly
85     for the package's developers.  If you use it, you may have to get
86     all sorts of other programs in order to regenerate files that came
87     with the distribution.
88
89Compilers and Options
90=====================
91
92   Some systems require unusual options for compilation or linking that
93the `configure' script does not know about.  Run `./configure --help'
94for details on some of the pertinent environment variables.
95
96   You can give `configure' initial values for configuration parameters
97by setting variables in the command line or in the environment.  Here
98is an example:
99
100     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
101
102   *Note Defining Variables::, for more details.
103
104Compiling For Multiple Architectures
105====================================
106
107   You can compile the package for more than one kind of computer at the
108same time, by placing the object files for each architecture in their
109own directory.  To do this, you must use a version of `make' that
110supports the `VPATH' variable, such as GNU `make'.  `cd' to the
111directory where you want the object files and executables to go and run
112the `configure' script.  `configure' automatically checks for the
113source code in the directory that `configure' is in and in `..'.
114
115   If you have to use a `make' that does not support the `VPATH'
116variable, you have to compile the package for one architecture at a
117time in the source code directory.  After you have installed the
118package for one architecture, use `make distclean' before reconfiguring
119for another architecture.
120
121Installation Names
122==================
123
124   By default, `make install' will install the package's files in
125`/usr/local/bin', `/usr/local/man', etc.  You can specify an
126installation prefix other than `/usr/local' by giving `configure' the
127option `--prefix=PATH'.
128
129   You can specify separate installation prefixes for
130architecture-specific files and architecture-independent files.  If you
131give `configure' the option `--exec-prefix=PATH', the package will use
132PATH as the prefix for installing programs and libraries.
133Documentation and other data files will still use the regular prefix.
134
135   In addition, if you use an unusual directory layout you can give
136options like `--bindir=PATH' to specify different values for particular
137kinds of files.  Run `configure --help' for a list of the directories
138you can set and what kinds of files go in them.
139
140   If the package supports it, you can cause programs to be installed
141with an extra prefix or suffix on their names by giving `configure' the
142option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
143
144Optional Features
145=================
146
147   Some packages pay attention to `--enable-FEATURE' options to
148`configure', where FEATURE indicates an optional part of the package.
149They may also pay attention to `--with-PACKAGE' options, where PACKAGE
150is something like `gnu-as' or `x' (for the X Window System).  The
151`README' should mention any `--enable-' and `--with-' options that the
152package recognizes.
153
154   For packages that use the X Window System, `configure' can usually
155find the X include and library files automatically, but if it doesn't,
156you can use the `configure' options `--x-includes=DIR' and
157`--x-libraries=DIR' to specify their locations.
158
159Specifying the System Type
160==========================
161
162   There may be some features `configure' cannot figure out
163automatically, but needs to determine by the type of machine the package
164will run on.  Usually, assuming the package is built to be run on the
165_same_ architectures, `configure' can figure that out, but if it prints
166a message saying it cannot guess the machine type, give it the
167`--build=TYPE' option.  TYPE can either be a short name for the system
168type, such as `sun4', or a canonical name which has the form:
169
170     CPU-COMPANY-SYSTEM
171
172where SYSTEM can have one of these forms:
173
174     OS KERNEL-OS
175
176   See the file `config.sub' for the possible values of each field.  If
177`config.sub' isn't included in this package, then this package doesn't
178need to know the machine type.
179
180   If you are _building_ compiler tools for cross-compiling, you should
181use the `--target=TYPE' option to select the type of system they will
182produce code for.
183
184   If you want to _use_ a cross compiler, that generates code for a
185platform different from the build platform, you should specify the
186"host" platform (i.e., that on which the generated programs will
187eventually be run) with `--host=TYPE'.
188
189Sharing Defaults
190================
191
192   If you want to set default values for `configure' scripts to share,
193you can create a site shell script called `config.site' that gives
194default values for variables like `CC', `cache_file', and `prefix'.
195`configure' looks for `PREFIX/share/config.site' if it exists, then
196`PREFIX/etc/config.site' if it exists.  Or, you can set the
197`CONFIG_SITE' environment variable to the location of the site script.
198A warning: not all `configure' scripts look for a site script.
199
200Defining Variables
201==================
202
203   Variables not defined in a site shell script can be set in the
204environment passed to `configure'.  However, some packages may run
205configure again during the build, and the customized values of these
206variables may be lost.  In order to avoid this problem, you should set
207them in the `configure' command line, using `VAR=value'.  For example:
208
209     ./configure CC=/usr/local2/bin/gcc
210
211will cause the specified gcc to be used as the C compiler (unless it is
212overridden in the site shell script).
213
214`configure' Invocation
215======================
216
217   `configure' recognizes the following options to control how it
218operates.
219
220`--help'
221`-h'
222     Print a summary of the options to `configure', and exit.
223
224`--version'
225`-V'
226     Print the version of Autoconf used to generate the `configure'
227     script, and exit.
228
229`--cache-file=FILE'
230     Enable the cache: use and save the results of the tests in FILE,
231     traditionally `config.cache'.  FILE defaults to `/dev/null' to
232     disable caching.
233
234`--config-cache'
235`-C'
236     Alias for `--cache-file=config.cache'.
237
238`--quiet'
239`--silent'
240`-q'
241     Do not print messages saying which checks are being made.  To
242     suppress all normal output, redirect it to `/dev/null' (any error
243     messages will still be shown).
244
245`--srcdir=DIR'
246     Look for the package's source code in directory DIR.  Usually
247     `configure' can determine that directory automatically.
248
249`configure' also accepts some other, not widely useful, options.  Run
250`configure --help' for more details.
251
252