Penguin
Blame: autoheader2.13(1)
EditPageHistoryDiffInfoLikePages
Annotated edit history of autoheader2.13(1) version 3, including all changes. View license author blame.
Rev Author # Line
1 perry 1 AUTOHEADER
2 !!!AUTOHEADER
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 SEE ALSO
7 AUTHORS
8 ----
9 !!NAME
10
11
12 autoheader2.13 - creates a template file of C #define's for use by configure.
13 !!SYNOPSIS
14
15
16 __autoheader2.13__ [[ __--help__ | __-h__ ] [[
17 __--localdir=dir__ | __-l dir__ ] [[
18 __--macrodir=dir__ | __-m dir__ ] [[ __--version__
19 ]
20 !!DESCRIPTION
21
22
23 The __autoheader2.13__ program can create a template file
24 of C __#define__ statements for __configure__ to use.
25 If __configure.in__ invokes
26 __AC_CONFIG_HEADER(FILE)__, __autoheader2.13__ creates
27 __FILE.in__; if multiple file arguments are given, the
28 first one is used. Otherwise, __autoheader2.13__ creates
29 __config.h.in__.
30
31
32 If you give __autoheader2.13__ an argument, it uses that
33 file instead of __configure.in__ and writes the header
34 file to the standard output instead of to
35 __config.h.in__. If you give __autoheader2.13__ an
36 argument of __-__, it reads the standard input instead of
37 __configure.in__ and writes the header file to the
38 standard output.
39
40
41 __autoheader2.13__ scans __configure.in__ and figures
42 out which C preprocessor symbols it might define. It copies
43 comments and __#define__ and __#undef__ statements
44 from a file called __acconfig.h__, which comes with and
45 is installed with Autoconf. It also uses a file called
46 __acconfig.h__ in the current directory, if present. If
47 you __AC_DEFINE__ any additional symbols, you must create
48 that file with entries for them. For symbols defined by
49 __AC_CHECK_HEADERS__, __AC_CHECK_FUNCS__,
50 __AC_CHECK_SIZEOF__, or __AC_CHECK_LIB__,
51 __autoheader2.13__ generates comments and __#undef__
52 statements itself rather than copying them from a file,
53 since the possible symbols are effectively
54 limitless.
55
56
57 The file that __autoheader2.13__ creates contains mainly
58 __#define__ and __#undef__ statements and their
59 accompanying comments. If __./acconfig.h__ contains the
60 string __@TOP@__, __autoheader2.13__ copies the lines
61 before the line containing __@TOP@__ into the top of the
62 file that it generates. Similarly, if __./acconfig.h__
63 contains the string __@BOTTOM@__, __autoheader2.13__
64 copies the lines after that line to the end of the file it
65 generates. Either or both of those strings may be
66 omitted.
67
68
69 An alternate way to produce the same effect is to create the
70 files __FILE.top__ (typically __config.h.top__) and/or
71 __FILE.bot__ in the current directory. If they exist,
72 __autoheader2.13__ copies them to the beginning and end,
73 respectively, of its output. Their use is discouraged
74 because they have file names that contain two periods, and
75 so can not be stored on MS-DOS; also, they are two more
76 files to clutter up the directory. But if you use the
77 __--localdir=DIR__ option to use an __acconfig.h__ in
78 another directory, they give you a way to put custom
79 boilerplate in each individual
80 __config.h.in__.
81
82
83 __autoheader2.13__ accepts the following
84 options:
85
86
87 __--help__
88
89
90 __-h__
91
92
93 Print a summary of the command line options and
94 exit.
95
96
97 __--localdir=DIR__
98
99
100 __-l DIR__
101
102
103 Look for the package files __aclocal.m4__ and
104 __acconfig.h__ (but not __FILE.top__ and
105 __FILE.bot__) in directory DIR instead of in the current
106 directory.
107
108
109 __--macrodir=DIR__
110
111
112 __-m DIR__
113
114
115 Look for the installed macro files and __acconfig.h__ in
116 directory DIR. You can also set the __AC_MACRODIR__
117 environment variable to a directory; this option overrides
118 the environment variable.
119
120
121 __--version__
122
123
124 Print the version number of Autoconf and exit.
125 !!SEE ALSO
126
127
3 perry 128 autoconf2.13(1), __autoreconf2.13__(1),
129 autoscan2.13(1), __autoupdate2.13__(1),
130 ifnames2.13(1)
1 perry 131 !!AUTHORS
132
133
2 perry 134 David !MacKenzie, with help from Franc,ois Pinard, Karl
135 Berry, Richard Pixley, Ian Lance Taylor, Roland !McGrath,
1 perry 136 Noah Friedman, David D. Zuhn, and many others. This manpage
137 written by Ben Pfaff
138 autoconf2.13__ package.
139 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.