1 --- autoconf-2.52/doc/autoconf.texi.orig Tue Jul 17 18:34:55 2001
2 +++ autoconf-2.52/doc/autoconf.texi Wed Jul 18 21:44:32 2001
7 -@dircategory GNU admin
8 +@dircategory Programming tools:
10 -* Autoconf: (autoconf). Create source code configuration scripts
11 +* Autoconf: (autoconf). Create source code configuration scripts
14 @dircategory Individual utilities
16 -* autoscan: (autoconf)autoscan Invocation.
17 - Semi-automatic @file{configure.ac} writing
18 -* ifnames: (autoconf)ifnames Invocation.
19 - Listing the conditionals in source code
20 -* autoconf: (autoconf)autoconf Invocation.
21 - How to create configuration scripts
22 -* autoreconf: (autoconf)autoreconf Invocation.
23 - Remaking multiple @code{configure} scripts
24 -* configure: (autoconf)configure Invocation.
25 - Configuring a package
26 -* config.status: (autoconf)config.status Invocation.
27 - Recreating a configuration
28 +* autoscan: (autoconf)autoscan. Semi-automatic @file{configure.ac} writing
29 +* ifnames: (autoconf)ifnames. Listing the conditionals in source code
30 +* autoconf: (autoconf)autoconf. How to create configuration scripts
31 +* autoreconf: (autoconf)autoreconf. Remaking multiple @code{configure} scripts
32 +* configure: (autoconf)configure. Configuring a package
33 +* config.status: (autoconf)config.status.
34 + Recreating a configuration
39 * Manual Configuration:: Selecting features that can't be guessed
40 * Site Configuration:: Local defaults for @code{configure}
41 * Running configure scripts:: How to use the Autoconf output
42 -* config.status Invocation:: Recreating a configuration
43 +* config.status:: Recreating a configuration
44 * Obsolete Constructs:: Kept for backward compatibility
45 * Questions:: Questions about Autoconf, with answers
46 * History:: History of Autoconf
48 Making @code{configure} Scripts
50 * Writing configure.ac:: What to put in an Autoconf input file
51 -* autoscan Invocation:: Semi-automatic @file{configure.ac} writing
52 -* ifnames Invocation:: Listing the conditionals in source code
53 -* autoconf Invocation:: How to create configuration scripts
54 -* autoreconf Invocation:: Remaking multiple @code{configure} scripts
55 +* autoscan:: Semi-automatic @file{configure.ac} writing
56 +* ifnames:: Listing the conditionals in source code
57 +* autoconf:: How to create configuration scripts
58 +* autoreconf:: Remaking multiple @code{configure} scripts
60 Writing @file{configure.ac}
63 Configuration Header Files
65 * Header Templates:: Input for the configuration headers
66 -* autoheader Invocation:: How to create configuration templates
67 +* autoheader:: How to create configuration templates
68 * Autoheader Macros:: How to specify CPP templates
72 * System Type:: Specifying the system type
73 * Sharing Defaults:: Setting site-wide defaults for @code{configure}
74 * Environment Variables:: Defining environment variables.
75 -* configure Invocation:: Changing how @code{configure} runs
76 +* configure:: Changing how @code{configure} runs
80 * Obsolete config.status Use:: Different calling convention
81 * acconfig.h:: Additional entries in @file{config.h.in}
82 -* autoupdate Invocation:: Automatic update of @file{configure.ac}
83 +* autoupdate:: Automatic update of @file{configure.ac}
84 * Obsolete Macros:: Backward compatibility macros
85 * Autoconf 1:: Tips for upgrading your files
86 * Autoconf 2.13:: Some fresher tips
90 a shell script called @file{config.status} that, when run, will recreate
91 -the files listed above (@pxref{config.status Invocation});
92 +the files listed above (@pxref{config.status});
95 an optional shell script normally called @file{config.cache}
99 * Writing configure.ac:: What to put in an Autoconf input file
100 -* autoscan Invocation:: Semi-automatic @file{configure.ac} writing
101 -* ifnames Invocation:: Listing the conditionals in source code
102 -* autoconf Invocation:: How to create configuration scripts
103 -* autoreconf Invocation:: Remaking multiple @code{configure} scripts
104 +* autoscan:: Semi-automatic @file{configure.ac} writing
105 +* ifnames:: Listing the conditionals in source code
106 +* autoconf:: How to create configuration scripts
107 +* autoreconf:: Remaking multiple @code{configure} scripts
110 -@node Writing configure.ac, autoscan Invocation, Making configure Scripts, Making configure Scripts
111 +@node Writing configure.ac, autoscan, Making configure Scripts, Making configure Scripts
112 @section Writing @file{configure.ac}
114 To produce a @code{configure} script for a software package, create a
116 or specialized features, @file{configure.ac} might need to contain some
117 hand-crafted shell commands; see @ref{Portable Shell}. The
118 @code{autoscan} program can give you a good start in writing
119 -@file{configure.ac} (@pxref{autoscan Invocation}, for more information).
120 +@file{configure.ac} (@pxref{autoscan}, for more information).
122 Previous versions of Autoconf promoted the name @file{configure.in},
123 which is somewhat ambiguous (the tool needed to produce this file is not
128 -@node autoscan Invocation, ifnames Invocation, Writing configure.ac, Making configure Scripts
129 +@node autoscan, ifnames, Writing configure.ac, Making configure Scripts
130 @section Using @code{autoscan} to Create @file{configure.ac}
131 @cindex @code{autoscan}
133 @@ -1009,7 +1004,7 @@
134 use a configuration header file, you must add a call to
135 @code{AC_CONFIG_HEADERS} (@pxref{Configuration Headers}). You might
136 also have to change or add some @code{#if} directives to your program in
137 -order to make it work with Autoconf (@pxref{ifnames Invocation}, for
138 +order to make it work with Autoconf (@pxref{ifnames}, for
139 information about a program that can help with that job).
141 When using @command{autoscan} to maintain a @file{configure.ac}, simply
142 @@ -1051,7 +1046,7 @@
143 plays with different versions of Autoconf simultaneously.
146 -@node ifnames Invocation, autoconf Invocation, autoscan Invocation, Making configure Scripts
147 +@node ifnames, autoconf, autoscan, Making configure Scripts
148 @section Using @code{ifnames} to List Conditionals
149 @cindex @code{ifnames}
151 @@ -1060,8 +1055,7 @@
152 preprocessor conditionals. If a package has already been set up to have
153 some portability, @code{ifnames} can thus help you figure out what its
154 @code{configure} needs to check for. It may help fill in some gaps in a
155 -@file{configure.ac} generated by @code{autoscan} (@pxref{autoscan
157 +@file{configure.ac} generated by @code{autoscan} (@pxref{autoscan}).
159 @code{ifnames} scans all of the C source files named on the command line
160 (or the standard input, if none are given) and writes to the standard
161 @@ -1083,7 +1077,7 @@
162 Print the version number of Autoconf and exit.
165 -@node autoconf Invocation, autoreconf Invocation, ifnames Invocation, Making configure Scripts
166 +@node autoconf, autoreconf, ifnames, Making configure Scripts
167 @section Using @code{autoconf} to Create @code{configure}
168 @cindex @code{autoconf}
170 @@ -1346,7 +1340,7 @@
174 -@node autoreconf Invocation, , autoconf Invocation, Making configure Scripts
175 +@node autoreconf, , autoconf, Making configure Scripts
176 @section Using @code{autoreconf} to Update @code{configure} Scripts
177 @cindex @code{autoreconf}
179 @@ -1568,8 +1562,8 @@
180 source directory; @code{configure} checks for this file's existence to
181 make sure that the directory that it is told contains the source code in
182 fact does. Occasionally people accidentally specify the wrong directory
183 -with @option{--srcdir}; this is a safety check. @xref{configure
184 -Invocation}, for more information.
185 +with @option{--srcdir}; this is a safety check. @xref{configure},
186 +for more information.
190 @@ -1755,7 +1749,7 @@
191 when used in @var{output}, or the standard input when used in the
192 @var{inputs}. You most probably don't need to use this in
193 @file{configure.ac}, but it is convenient when using the command line
194 -interface of @file{./config.status}, see @ref{config.status Invocation},
195 +interface of @file{./config.status}, see @ref{config.status},
198 The @var{inputs} may be absolute or relative filenames. In the latter
199 @@ -2223,7 +2217,7 @@
200 @file{config.h} is considered up to date. @xref{Output}, for more
201 information about @code{AC_OUTPUT}.
203 -@xref{config.status Invocation}, for more examples of handling
204 +@xref{config.status}, for more examples of handling
205 configuration-related dependencies.
207 @node Configuration Headers, Configuration Commands, Makefile Substitutions, Setup
208 @@ -2284,11 +2278,11 @@
211 * Header Templates:: Input for the configuration headers
212 -* autoheader Invocation:: How to create configuration templates
213 +* autoheader:: How to create configuration templates
214 * Autoheader Macros:: How to specify CPP templates
217 -@node Header Templates, autoheader Invocation, Configuration Headers, Configuration Headers
218 +@node Header Templates, autoheader, Configuration Headers, Configuration Headers
219 @subsection Configuration Header Templates
220 @cindex Configuration Header Template
221 @cindex @file{config.h.in}
222 @@ -2335,10 +2329,10 @@
223 @samp{#undef} is strongly discouraged.
225 Since it is a tedious task to keep a template header up to date, you may
226 -use @code{autoheader} to generate it, see @ref{autoheader Invocation}.
227 +use @code{autoheader} to generate it, see @ref{autoheader}.
230 -@node autoheader Invocation, Autoheader Macros, Header Templates, Configuration Headers
231 +@node autoheader, Autoheader Macros, Header Templates, Configuration Headers
232 @subsection Using @code{autoheader} to Create @file{config.h.in}
233 @cindex @code{autoheader}
235 @@ -2443,7 +2437,7 @@
239 -@node Autoheader Macros, , autoheader Invocation, Configuration Headers
240 +@node Autoheader Macros, , autoheader, Configuration Headers
241 @subsection Autoheader Macros
243 @code{autoheader} scans @file{configure.ac} and figures out which C
244 @@ -5621,7 +5615,7 @@
245 files will depend upon @command{bizarre-cc} being the C compiler. If
246 for some reason the user runs @command{/configure} again, or if it is
247 run via @samp{./config.status --recheck}, (@xref{Automatic Remaking},
248 -and @pxref{config.status Invocation}), then the configuration can be
249 +and @pxref{config.status}), then the configuration can be
250 inconsistent, composed of results depending upon two different
253 @@ -5665,7 +5659,7 @@
256 @var{variable} is kept during automatic reconfiguration
257 -(@pxref{config.status Invocation}) as if it had been passed as a command
258 +(@pxref{config.status}) as if it had been passed as a command
259 line argument, including when no cache is used:
262 @@ -6670,7 +6664,7 @@
264 When the user runs @samp{autoconf -W error}, warnings from
265 @code{AC_DIAGNOSE} and @code{AC_WARNING} are reported as error, see
266 -@ref{autoconf Invocation}.
269 @node Dependencies Between Macros, Obsoleting Macros, Reporting Messages, Writing Autoconf Macros
270 @section Dependencies Between Macros
271 @@ -9445,7 +9439,7 @@
273 @c ============================================== Running configure Scripts.
275 -@node Running configure scripts, config.status Invocation, Site Configuration, Top
276 +@node Running configure scripts, config.status, Site Configuration, Top
277 @chapter Running @code{configure} Scripts
278 @cindex @code{configure}
280 @@ -9463,7 +9457,7 @@
281 * System Type:: Specifying the system type
282 * Sharing Defaults:: Setting site-wide defaults for @code{configure}
283 * Environment Variables:: Defining environment variables.
284 -* configure Invocation:: Changing how @code{configure} runs
285 +* configure:: Changing how @code{configure} runs
288 @include install.texi
289 @@ -9471,7 +9465,7 @@
291 @c ============================================== Recreating a Configuration
293 -@node config.status Invocation, Obsolete Constructs, Running configure scripts, Top
294 +@node config.status, Obsolete Constructs, Running configure scripts, Top
295 @chapter Recreating a Configuration
296 @cindex @code{config.status}
298 @@ -9590,7 +9584,7 @@
300 @c =================================================== Obsolete Constructs
302 -@node Obsolete Constructs, Questions, config.status Invocation, Top
303 +@node Obsolete Constructs, Questions, config.status, Top
304 @chapter Obsolete Constructs
306 Autoconf changes, and throughout the years some constructs are obsoleted.
307 @@ -9604,7 +9598,7 @@
309 * Obsolete config.status Use:: Different calling convention
310 * acconfig.h:: Additional entries in @file{config.h.in}
311 -* autoupdate Invocation:: Automatic update of @file{configure.ac}
312 +* autoupdate:: Automatic update of @file{configure.ac}
313 * Obsolete Macros:: Backward compatibility macros
314 * Autoconf 1:: Tips for upgrading your files
315 * Autoconf 2.13:: Some fresher tips
316 @@ -9614,7 +9608,7 @@
317 @section Obsolete @file{config.status} Invocation
319 @file{config.status} now supports arguments to specify the files to
320 -instantiate, see @ref{config.status Invocation}, for more details.
321 +instantiate, see @ref{config.status}, for more details.
322 Before, environment variables had to be used.
324 @defvar CONFIG_COMMANDS
325 @@ -9645,7 +9639,7 @@
326 @file{config.status} ignores this variable.
329 -In @ref{config.status Invocation}, using this old interface, the example
330 +In @ref{config.status}, using this old interface, the example
334 @@ -9668,7 +9662,7 @@
335 for @code{CONFIG_COMMANDS} etc.)
338 -@node acconfig.h, autoupdate Invocation, Obsolete config.status Use, Obsolete Constructs
339 +@node acconfig.h, autoupdate, Obsolete config.status Use, Obsolete Constructs
340 @section @file{acconfig.h}
342 @cindex @file{acconfig.h}
343 @@ -9719,7 +9713,7 @@
344 self-contained, and should not depend upon @file{acconfig.h} etc.
347 -@node autoupdate Invocation, Obsolete Macros, acconfig.h, Obsolete Constructs
348 +@node autoupdate, Obsolete Macros, acconfig.h, Obsolete Constructs
349 @section Using @code{autoupdate} to Modernize @file{configure.ac}
350 @cindex @code{autoupdate}
352 @@ -9777,7 +9771,7 @@
353 instead of in the current directory.
356 -@node Obsolete Macros, Autoconf 1, autoupdate Invocation, Obsolete Constructs
357 +@node Obsolete Macros, Autoconf 1, autoupdate, Obsolete Constructs
358 @section Obsolete Macros
360 Several macros are obsoleted in Autoconf, for various reasons (typically
361 @@ -10572,7 +10566,7 @@
363 If you have an @file{aclocal.m4} installed with Autoconf (as opposed to
364 in a particular package's source directory), you must rename it to
365 -@file{acsite.m4}. @xref{autoconf Invocation}.
366 +@file{acsite.m4}. @xref{autoconf}.
368 If you distribute @file{install.sh} with your package, rename it to
369 @file{install-sh} so @code{make} builtin rules won't inadvertently
370 @@ -10627,7 +10621,7 @@
371 the documentation for them. @xref{Obsolete Macros}, for a table showing the
372 new names for the old macros. Use the @code{autoupdate} program to
373 convert your @file{configure.ac} to using the new macro names.
374 -@xref{autoupdate Invocation}.
377 Some macros have been superseded by similar ones that do the job better,
378 but are not call-compatible. If you get warnings about calling obsolete