| 1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.35.
|
|---|
| 2 | .TH M4 "1" "November 2006" "FSF" "User Commands"
|
|---|
| 3 | .SH NAME
|
|---|
| 4 | M4 \- macro processor
|
|---|
| 5 | .SH SYNOPSIS
|
|---|
| 6 | .B m4
|
|---|
| 7 | [\fIOPTION\fR]... [\fIFILE\fR]...
|
|---|
| 8 | .SH DESCRIPTION
|
|---|
| 9 | Process macros in FILEs. If no FILE or if FILE is `\-', standard input
|
|---|
| 10 | is read.
|
|---|
| 11 | .PP
|
|---|
| 12 | Mandatory or optional arguments to long options are mandatory or optional
|
|---|
| 13 | for short options too.
|
|---|
| 14 | .SS "Operation modes:"
|
|---|
| 15 | .TP
|
|---|
| 16 | \fB\-\-help\fR
|
|---|
| 17 | display this help and exit
|
|---|
| 18 | .TP
|
|---|
| 19 | \fB\-\-version\fR
|
|---|
| 20 | output version information and exit
|
|---|
| 21 | .TP
|
|---|
| 22 | \fB\-E\fR, \fB\-\-fatal\-warnings\fR
|
|---|
| 23 | stop execution after first warning
|
|---|
| 24 | .TP
|
|---|
| 25 | \fB\-i\fR, \fB\-\-interactive\fR
|
|---|
| 26 | unbuffer output, ignore interrupts
|
|---|
| 27 | .TP
|
|---|
| 28 | \fB\-P\fR, \fB\-\-prefix\-builtins\fR
|
|---|
| 29 | force a `m4_' prefix to all builtins
|
|---|
| 30 | .TP
|
|---|
| 31 | \fB\-Q\fR, \fB\-\-quiet\fR, \fB\-\-silent\fR
|
|---|
| 32 | suppress some warnings for builtins
|
|---|
| 33 | .SS "Preprocessor features:"
|
|---|
| 34 | .TP
|
|---|
| 35 | \fB\-D\fR, \fB\-\-define=NAME\fR[=\fIVALUE\fR]
|
|---|
| 36 | define NAME as having VALUE, or empty
|
|---|
| 37 | .TP
|
|---|
| 38 | \fB\-I\fR, \fB\-\-include\fR=\fIDIRECTORY\fR
|
|---|
| 39 | append DIRECTORY to include path
|
|---|
| 40 | .TP
|
|---|
| 41 | \fB\-s\fR, \fB\-\-synclines\fR
|
|---|
| 42 | generate `#line NUM "FILE"' lines
|
|---|
| 43 | .TP
|
|---|
| 44 | \fB\-U\fR, \fB\-\-undefine\fR=\fINAME\fR
|
|---|
| 45 | undefine NAME
|
|---|
| 46 | .SS "Limits control:"
|
|---|
| 47 | .TP
|
|---|
| 48 | \fB\-G\fR, \fB\-\-traditional\fR
|
|---|
| 49 | suppress all GNU extensions
|
|---|
| 50 | .TP
|
|---|
| 51 | \fB\-H\fR, \fB\-\-hashsize\fR=\fIPRIME\fR
|
|---|
| 52 | set symbol lookup hash table size [509]
|
|---|
| 53 | .TP
|
|---|
| 54 | \fB\-L\fR, \fB\-\-nesting\-limit\fR=\fINUMBER\fR
|
|---|
| 55 | change artificial nesting limit [1024]
|
|---|
| 56 | .SS "Frozen state files:"
|
|---|
| 57 | .TP
|
|---|
| 58 | \fB\-F\fR, \fB\-\-freeze\-state\fR=\fIFILE\fR
|
|---|
| 59 | produce a frozen state on FILE at end
|
|---|
| 60 | .TP
|
|---|
| 61 | \fB\-R\fR, \fB\-\-reload\-state\fR=\fIFILE\fR
|
|---|
| 62 | reload a frozen state from FILE at start
|
|---|
| 63 | .SS "Debugging:"
|
|---|
| 64 | .TP
|
|---|
| 65 | \fB\-d\fR, \fB\-\-debug\fR[=\fIFLAGS\fR]
|
|---|
| 66 | set debug level (no FLAGS implies `aeq')
|
|---|
| 67 | .TP
|
|---|
| 68 | \fB\-\-debugfile\fR=\fIFILE\fR
|
|---|
| 69 | redirect debug and trace output
|
|---|
| 70 | .TP
|
|---|
| 71 | \fB\-l\fR, \fB\-\-arglength\fR=\fINUM\fR
|
|---|
| 72 | restrict macro tracing size
|
|---|
| 73 | .TP
|
|---|
| 74 | \fB\-t\fR, \fB\-\-trace\fR=\fINAME\fR
|
|---|
| 75 | trace NAME when it is defined
|
|---|
| 76 | .SS "FLAGS is any of:"
|
|---|
| 77 | .TP
|
|---|
| 78 | a
|
|---|
| 79 | show actual arguments
|
|---|
| 80 | .TP
|
|---|
| 81 | c
|
|---|
| 82 | show before collect, after collect and after call
|
|---|
| 83 | .TP
|
|---|
| 84 | e
|
|---|
| 85 | show expansion
|
|---|
| 86 | .TP
|
|---|
| 87 | f
|
|---|
| 88 | say current input file name
|
|---|
| 89 | .TP
|
|---|
| 90 | i
|
|---|
| 91 | show changes in input files
|
|---|
| 92 | .TP
|
|---|
| 93 | l
|
|---|
| 94 | say current input line number
|
|---|
| 95 | .TP
|
|---|
| 96 | p
|
|---|
| 97 | show results of path searches
|
|---|
| 98 | .TP
|
|---|
| 99 | q
|
|---|
| 100 | quote values as necessary, with a or e flag
|
|---|
| 101 | .TP
|
|---|
| 102 | t
|
|---|
| 103 | trace for all macro calls, not only traceon'ed
|
|---|
| 104 | .TP
|
|---|
| 105 | x
|
|---|
| 106 | add a unique macro call id, useful with c flag
|
|---|
| 107 | .TP
|
|---|
| 108 | V
|
|---|
| 109 | shorthand for all of the above flags
|
|---|
| 110 | .PP
|
|---|
| 111 | If defined, the environment variable `M4PATH' is a colon\-separated list
|
|---|
| 112 | of directories included after any specified by `\-I'.
|
|---|
| 113 | .PP
|
|---|
| 114 | Exit status is 0 for success, 1 for failure, 63 for frozen file version
|
|---|
| 115 | mismatch, or whatever value was passed to the m4exit macro.
|
|---|
| 116 | .SH AUTHOR
|
|---|
| 117 | Written by Rene' Seindal.
|
|---|
| 118 | .SH "REPORTING BUGS"
|
|---|
| 119 | Report bugs to <bug\-m4@gnu.org>.
|
|---|
| 120 | .SH COPYRIGHT
|
|---|
| 121 | Copyright \(co 2006 Free Software Foundation, Inc.
|
|---|
| 122 | .br
|
|---|
| 123 | This is free software; see the source for copying conditions. There is NO
|
|---|
| 124 | warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
|---|
| 125 | .SH "SEE ALSO"
|
|---|
| 126 | The full documentation for
|
|---|
| 127 | .B M4
|
|---|
| 128 | is maintained as a Texinfo manual. If the
|
|---|
| 129 | .B info
|
|---|
| 130 | and
|
|---|
| 131 | .B M4
|
|---|
| 132 | programs are properly installed at your site, the command
|
|---|
| 133 | .IP
|
|---|
| 134 | .B info m4
|
|---|
| 135 | .PP
|
|---|
| 136 | should give you access to the complete manual.
|
|---|
