Penguin
Recent Changes
Blame: autoheader(1)
EditPageHistoryDiffInfoLikePages
Annotated edit history of autoheader(1) version 2, 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 autoheader - creates a template file of C #define's for use by configure.
13 !!SYNOPSIS
14
15
16 __autoheader__ [[ __--help__ | __-h__ ] [[
17 __--version__ | __-V__ ] [[ __--verbose__ |
18 __-v__ ] [[ __--debug__ | __-d__ ] [[
19 __--autoconf-dir=__''dir'' | __-A__ ''dir'' ] [[
20 __--localdir=__''dir'' | __-l__ ''dir'' ] [[
21 __--warnings=__''category'' | __-W__
22 ''category'' ]
23 !!DESCRIPTION
24
25
26 The __autoheader__ program can create a template file of
27 C __#define__ statements for __configure__ to use. If
28 __configure.ac__ invokes __AC_CONFIG_HEADER(FILE)__,
29 __autoheader__ creates __FILE.in__; if multiple file
30 arguments are given, the first one is used. Otherwise,
31 __autoheader__ creates __config.h.in__.
32
33
34 If you give __autoheader__ an argument, it uses that file
35 instead of __configure.ac__ and writes the header file to
36 the standard output instead of to __config.h.in__. If you
37 give __autoheader__ an argument of __-__, it reads the
38 standard input instead of __configure.ac__ and writes the
39 header file to the standard output.
40
41
42 __autoheader__ scans __configure.ac__ and figures out
43 which C preprocessor symbols it might define. It copies
44 comments and __#define__ and __#undef__ statements
45 from a file called __acconfig.h__, which comes with and
46 is installed with Autoconf. It also uses a file called
47 __acconfig.h__ in the current directory, if present. If
48 you __AC_DEFINE__ any additional symbols, you must create
49 that file with entries for them. For symbols defined by
50 __AC_CHECK_HEADERS__, __AC_CHECK_FUNCS__,
51 __AC_CHECK_SIZEOF__, or __AC_CHECK_LIB__,
52 __autoheader__ generates comments and __#undef__
53 statements itself rather than copying them from a file,
54 since the possible symbols are effectively
55 limitless.
56
57
58 The file that __autoheader__ creates contains mainly
59 __#define__ and __#undef__ statements and their
60 accompanying comments. If __./acconfig.h__ contains the
61 string __@TOP@__, __autoheader__ copies the lines
62 before the line containing __@TOP@__ into the top of the
63 file that it generates. Similarly, if __./acconfig.h__
64 contains the string __@BOTTOM@__, __autoheader__
65 copies the lines after that line to the end of the file it
66 generates. Either or both of those strings may be
67 omitted.
68
69
70 An alternate way to produce the same effect is to create the
71 files __FILE.top__ (typically __config.h.top__) and/or
72 __FILE.bot__ in the current directory. If they exist,
73 __autoheader__ copies them to the beginning and end,
74 respectively, of its output. Their use is discouraged
75 because they have file names that contain two periods, and
76 so can not be stored on MS-DOS; also, they are two more
77 files to clutter up the directory. But if you use the
78 __--localdir=DIR__ option to use an __acconfig.h__ in
79 another directory, they give you a way to put custom
80 boilerplate in each individual
81 __config.h.in__.
82
83
84 __autoheader__ accepts the following
85 options:
86
87
88 __--help__
89
90
91 __-h__
92
93
94 Print a summary of the command line options and
95 exit.
96
97
98 __--version__
99
100
101 __-V__
102
103
104 Print the version number of Autoconf and exit.
105
106
107 __--verbose__
108
109
110 __-v__
111
112
113 Report processing steps.
114
115
116 __--debug__
117
118
119 __-d__
120
121
122 Don't remove the temporary files.
123
124
125 __--autoconf-dir=__''dir''
126
127
128 __-A__ ''dir''
129
130
131 Look for the installed macro files in directory ''dir''.
132 You can also set the __AC_MACRODIR__ environment variable
133 to a directory; this option overrides the environment
134 variable.
135
136
137 __--localdir=__''dir''
138
139
140 __-l__ ''dir''
141
142
143 Look for the package file __aclocal.m4__ in directory
144 ''dir'' instead of in the current directory.
145
146
147 __--warnings=__''category''
148
149
150 __-W__ ''category''
151
152
153 Report the warnings related to ''category'' (which can
154 actually be a comma separated list). Special values for
155 ''category'' include __all__ to report all warnings,
156 __none__ to report no warnings, and __error__ to treat
157 warnings as errors. See the Texinfo documentation for a list
158 of categories and additional information.
159 !!SEE ALSO
160
161
162 autoconf(1), autoreconf(1),
163 autoscan(1), autoupdate(1),
164 ifnames(1)
165 !!AUTHORS
166
167
2 perry 168 David !MacKenzie, with help from Franc,ois Pinard, Karl
169 Berry, Richard Pixley, Ian Lance Taylor, Roland !McGrath,
1 perry 170 Noah Friedman, David D. Zuhn, and many others. This manpage
171 written by Ben Pfaff
172 autoconf__ package.
173 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.