autom4te.1 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.8.
  2. .TH AUTOM4TE "1" "April 2012" "GNU Autoconf 2.68b.25-19513" "User Commands"
  3. .SH NAME
  4. autom4te \- Generate files and scripts thanks to M4
  5. .SH SYNOPSIS
  6. .B autom4te
  7. [\fIOPTION\fR]... [\fIFILES\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 of
  19. 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=\fIFILE\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=\fICATEGORY\fR
  41. report the warnings falling in CATEGORY
  42. .TP
  43. \fB\-l\fR, \fB\-\-language\fR=\fILANG\fR
  44. specify the set of M4 macros to use
  45. .TP
  46. \fB\-C\fR, \fB\-\-cache\fR=\fIDIRECTORY\fR
  47. preserve results for future runs in DIRECTORY
  48. .TP
  49. \fB\-\-no\-cache\fR
  50. disable the cache
  51. .TP
  52. \fB\-m\fR, \fB\-\-mode\fR=\fIOCTAL\fR
  53. change the non trace output file mode (0666)
  54. .TP
  55. \fB\-M\fR, \fB\-\-melt\fR
  56. don't use M4 frozen files
  57. .SS "Languages include:"
  58. .TP
  59. `Autoconf'
  60. create Autoconf configure scripts
  61. .TP
  62. `Autotest'
  63. create Autotest test suites
  64. .TP
  65. `M4sh'
  66. create M4sh shell scripts
  67. .TP
  68. `M4sugar'
  69. create M4sugar output
  70. .SS "Warning categories include:"
  71. .TP
  72. `cross'
  73. cross compilation issues
  74. .TP
  75. `gnu'
  76. GNU coding standards (default in gnu and gnits modes)
  77. .TP
  78. `obsolete'
  79. obsolete features or constructions
  80. .TP
  81. `override'
  82. user redefinitions of Automake rules or variables
  83. .TP
  84. `portability'
  85. portability issues (default in gnu and gnits modes)
  86. .TP
  87. `syntax'
  88. dubious syntactic constructs (default)
  89. .TP
  90. `unsupported'
  91. unsupported or incomplete features (default)
  92. .TP
  93. `all'
  94. all the warnings
  95. .TP
  96. `no\-CATEGORY'
  97. turn off warnings in CATEGORY
  98. .TP
  99. `none'
  100. turn off all the warnings
  101. .TP
  102. `error'
  103. treat warnings as errors
  104. .PP
  105. The environment variables `M4' and `WARNINGS' are honored.
  106. .SS "Library directories:"
  107. .TP
  108. \fB\-B\fR, \fB\-\-prepend\-include\fR=\fIDIR\fR
  109. prepend directory DIR to search path
  110. .TP
  111. \fB\-I\fR, \fB\-\-include\fR=\fIDIR\fR
  112. append directory DIR to search path
  113. .SS "Tracing:"
  114. .TP
  115. \fB\-t\fR, \fB\-\-trace\fR=\fIMACRO[\fR:FORMAT]
  116. report the MACRO invocations
  117. .TP
  118. \fB\-p\fR, \fB\-\-preselect\fR=\fIMACRO\fR
  119. prepare to trace MACRO in a future run
  120. .SS "Freezing:"
  121. .TP
  122. \fB\-F\fR, \fB\-\-freeze\fR
  123. produce an M4 frozen state file for FILES
  124. .SS "FORMAT defaults to `$f:$l:$n:$%', and can use the following escapes:"
  125. .TP
  126. $$
  127. literal $
  128. .TP
  129. $f
  130. file where macro was called
  131. .TP
  132. $l
  133. line where macro was called
  134. .TP
  135. $d
  136. nesting depth of macro call
  137. .TP
  138. $n
  139. name of the macro
  140. .TP
  141. $NUM
  142. argument NUM, unquoted and with newlines
  143. .TP
  144. $SEP@
  145. all arguments, with newlines, quoted, and separated by SEP
  146. .TP
  147. $SEP*
  148. all arguments, with newlines, unquoted, and separated by SEP
  149. .TP
  150. $SEP%
  151. all arguments, without newlines, unquoted, and separated by SEP
  152. .PP
  153. SEP can be empty for the default (comma for @ and *, colon for %),
  154. a single character for that character, or {STRING} to use a string.
  155. .SH AUTHOR
  156. Written by Akim Demaille.
  157. .SH "REPORTING BUGS"
  158. Report bugs to <bug\-autoconf@gnu.org>.
  159. .br
  160. GNU Autoconf home page: <http://www.gnu.org/software/autoconf/>.
  161. .br
  162. General help using GNU software: <http://www.gnu.org/gethelp/>.
  163. .SH COPYRIGHT
  164. Copyright \(co 2012 Free Software Foundation, Inc.
  165. License GPLv3+/Autoconf: GNU GPL version 3 or later
  166. <http://gnu.org/licenses/gpl.html>, <http://gnu.org/licenses/exceptions.html>
  167. .br
  168. This is free software: you are free to change and redistribute it.
  169. There is NO WARRANTY, to the extent permitted by law.
  170. .SH "SEE ALSO"
  171. .BR autoconf (1),
  172. .BR automake (1),
  173. .BR autoreconf (1),
  174. .BR autoupdate (1),
  175. .BR autoheader (1),
  176. .BR autoscan (1),
  177. .BR config.guess (1),
  178. .BR config.sub (1),
  179. .BR ifnames (1),
  180. .BR libtool (1).
  181. .PP
  182. The full documentation for
  183. .B autom4te
  184. is maintained as a Texinfo manual. If the
  185. .B info
  186. and
  187. .B autom4te
  188. programs are properly installed at your site, the command
  189. .IP
  190. .B info autom4te
  191. .PP
  192. should give you access to the complete manual.