| 1 |
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. |
| 2 |
.TH AUTOM4TE "1" "March 2026" "GNU Autoconf 2.73" "User Commands" |
| 3 |
.SH NAME |
| 4 |
autom4te \- Generate files and scripts thanks to M4 |
| 5 |
.SH SYNOPSIS |
| 6 |
.B autom4te |
| 7 |
[\fI\,OPTION\/\fR]... [\fI\,FILES\/\fR] |
| 8 |
.SH DESCRIPTION |
| 9 |
Run GNU M4 on the FILES, avoiding useless runs. Output the traces if tracing, |
| 10 |
the frozen file if freezing, otherwise the expansion of the FILES. |
| 11 |
.PP |
| 12 |
If some of the FILES are named 'FILE.m4f' they are considered to be M4 |
| 13 |
frozen files of all the previous files (which are therefore not loaded). |
| 14 |
If 'FILE.m4f' is not found, then 'FILE.m4' will be used, together with |
| 15 |
all the previous files. |
| 16 |
.PP |
| 17 |
Some files may be optional, i.e., will only be processed if found in the |
| 18 |
include path, but then must end in '.m4?'; the question mark is not part |
| 19 |
of the actual file name. |
| 20 |
.SS "Operation modes:" |
| 21 |
.TP |
| 22 |
\fB\-h\fR, \fB\-\-help\fR |
| 23 |
print this help, then exit |
| 24 |
.TP |
| 25 |
\fB\-V\fR, \fB\-\-version\fR |
| 26 |
print version number, then exit |
| 27 |
.TP |
| 28 |
\fB\-v\fR, \fB\-\-verbose\fR |
| 29 |
verbosely report processing |
| 30 |
.TP |
| 31 |
\fB\-d\fR, \fB\-\-debug\fR |
| 32 |
don't remove temporary files |
| 33 |
.TP |
| 34 |
\fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR |
| 35 |
save output in FILE (defaults to '\-', stdout) |
| 36 |
.TP |
| 37 |
\fB\-f\fR, \fB\-\-force\fR |
| 38 |
don't rely on cached values |
| 39 |
.TP |
| 40 |
\fB\-W\fR, \fB\-\-warnings\fR=\fI\,CATEGORY\/\fR |
| 41 |
report the warnings falling in CATEGORY |
| 42 |
(comma\-separated list accepted) |
| 43 |
.TP |
| 44 |
\fB\-l\fR, \fB\-\-language\fR=\fI\,LANG\/\fR |
| 45 |
specify the set of M4 macros to use |
| 46 |
.TP |
| 47 |
\fB\-C\fR, \fB\-\-cache\fR=\fI\,DIRECTORY\/\fR |
| 48 |
preserve results for future runs in DIRECTORY |
| 49 |
.TP |
| 50 |
\fB\-\-no\-cache\fR |
| 51 |
disable the cache |
| 52 |
.TP |
| 53 |
\fB\-m\fR, \fB\-\-mode\fR=\fI\,OCTAL\/\fR |
| 54 |
change the non trace output file mode (0666) |
| 55 |
.TP |
| 56 |
\fB\-M\fR, \fB\-\-melt\fR |
| 57 |
don't use M4 frozen files |
| 58 |
.SS "Languages include:" |
| 59 |
.TP |
| 60 |
\&'Autoconf' |
| 61 |
create Autoconf configure scripts |
| 62 |
.TP |
| 63 |
\&'Autotest' |
| 64 |
create Autotest test suites |
| 65 |
.TP |
| 66 |
\&'M4sh' |
| 67 |
create M4sh shell scripts |
| 68 |
.TP |
| 69 |
\&'M4sugar' |
| 70 |
create M4sugar output |
| 71 |
.SS "Warning categories are:" |
| 72 |
.TP |
| 73 |
cross |
| 74 |
cross compilation issues |
| 75 |
.TP |
| 76 |
gnu |
| 77 |
GNU coding standards (default in gnu and gnits modes) |
| 78 |
.TP |
| 79 |
obsolete |
| 80 |
obsolete features or constructions (default) |
| 81 |
.TP |
| 82 |
override |
| 83 |
user redefinitions of Automake rules or variables |
| 84 |
.TP |
| 85 |
portability |
| 86 |
portability issues (default in gnu and gnits modes) |
| 87 |
.TP |
| 88 |
portability\-recursive |
| 89 |
nested Make variables (default with \fB\-Wportability\fR) |
| 90 |
.TP |
| 91 |
extra\-portability |
| 92 |
extra portability issues related to obscure tools |
| 93 |
.TP |
| 94 |
syntax |
| 95 |
dubious syntactic constructs (default) |
| 96 |
.TP |
| 97 |
unsupported |
| 98 |
unsupported or incomplete features (default) |
| 99 |
.SS "-W also understands:" |
| 100 |
.TP |
| 101 |
all |
| 102 |
turn on all the warnings |
| 103 |
.TP |
| 104 |
none |
| 105 |
turn off all the warnings |
| 106 |
.TP |
| 107 |
no\-CATEGORY |
| 108 |
turn off warnings in CATEGORY |
| 109 |
.TP |
| 110 |
error |
| 111 |
treat all enabled warnings as errors |
| 112 |
.PP |
| 113 |
The environment variables 'M4' and 'WARNINGS' are honored. |
| 114 |
.SS "Library directories:" |
| 115 |
.TP |
| 116 |
\fB\-B\fR, \fB\-\-prepend\-include\fR=\fI\,DIR\/\fR |
| 117 |
prepend directory DIR to search path |
| 118 |
.TP |
| 119 |
\fB\-I\fR, \fB\-\-include\fR=\fI\,DIR\/\fR |
| 120 |
append directory DIR to search path |
| 121 |
.SS "Tracing:" |
| 122 |
.TP |
| 123 |
\fB\-t\fR, \fB\-\-trace\fR=\fI\,MACRO[\/\fR:FORMAT] |
| 124 |
report the MACRO invocations |
| 125 |
.TP |
| 126 |
\fB\-p\fR, \fB\-\-preselect\fR=\fI\,MACRO\/\fR |
| 127 |
prepare to trace MACRO in a future run |
| 128 |
.SS "Freezing:" |
| 129 |
.TP |
| 130 |
\fB\-F\fR, \fB\-\-freeze\fR |
| 131 |
produce an M4 frozen state file for FILES |
| 132 |
.SS "FORMAT defaults to '$f:$l:$n:$%', and can use the following escapes:" |
| 133 |
.TP |
| 134 |
$$ |
| 135 |
literal $ |
| 136 |
.TP |
| 137 |
$f |
| 138 |
file where macro was called |
| 139 |
.TP |
| 140 |
$l |
| 141 |
line where macro was called |
| 142 |
.TP |
| 143 |
$d |
| 144 |
nesting depth of macro call |
| 145 |
.TP |
| 146 |
$n |
| 147 |
name of the macro |
| 148 |
.TP |
| 149 |
$NUM |
| 150 |
argument NUM, unquoted and with newlines |
| 151 |
.TP |
| 152 |
$SEP@ |
| 153 |
all arguments, with newlines, quoted, and separated by SEP |
| 154 |
.TP |
| 155 |
$SEP* |
| 156 |
all arguments, with newlines, unquoted, and separated by SEP |
| 157 |
.TP |
| 158 |
$SEP% |
| 159 |
all arguments, without newlines, unquoted, and separated by SEP |
| 160 |
.PP |
| 161 |
SEP can be empty for the default (comma for @ and *, colon for %), |
| 162 |
a single character for that character, or {STRING} to use a string. |
| 163 |
.SH AUTHOR |
| 164 |
Written by Akim Demaille. |
| 165 |
.SH "REPORTING BUGS" |
| 166 |
Report bugs to |
| 167 |
.MT [email protected] |
| 168 |
.ME , |
| 169 |
or via Savannah: |
| 170 |
.UR https://savannah.gnu.org/support/?group=autoconf |
| 171 |
.UE . |
| 172 |
.SH COPYRIGHT |
| 173 |
Copyright \(co 2026 Free Software Foundation, Inc. |
| 174 |
License GPLv3+/Autoconf: GNU GPL version 3 or later |
| 175 |
<https://gnu.org/licenses/gpl.html>, <https://gnu.org/licenses/exceptions.html> |
| 176 |
.br |
| 177 |
This is free software: you are free to change and redistribute it. |
| 178 |
There is NO WARRANTY, to the extent permitted by law. |
| 179 |
.SH "SEE ALSO" |
| 180 |
.BR autoconf (1), |
| 181 |
.BR automake (1), |
| 182 |
.BR autoreconf (1), |
| 183 |
.BR autoupdate (1), |
| 184 |
.BR autoheader (1), |
| 185 |
.BR autoscan (1), |
| 186 |
.BR config.guess (1), |
| 187 |
.BR config.sub (1), |
| 188 |
.BR ifnames (1), |
| 189 |
.BR libtool (1). |
| 190 |
|
| 191 |
The full documentation for Autoconf is maintained as a Texinfo manual. |
| 192 |
To read the manual locally, use the command |
| 193 |
.IP |
| 194 |
.B info autoconf |
| 195 |
.PP |
| 196 |
You can also consult the Web version of the manual at |
| 197 |
.UR https://gnu.org/software/autoconf/manual/ |
| 198 |
.UE . |