PWB1/usr/man/man1/m4.1

.th M4 I 5/31/77
.sh NAME
m4 \*- macro processor
.sh SYNOPSIS
.bd m4
[ files ]
.sh DESCRIPTION
.it M4
is a macro processor
intended as a front end for Ratfor, C, and other languages.
Each of the argument files is processed in order;
if there are no arguments, or if an argument is `\*-',
the standard input is read.
The processed text is written on the standard output.
.s3
Macro calls
have the form
.s3
	name(arg1,arg2, . . . , argn)
.br
.s3
The `(' must immediately follow the name of the macro.
If a defined macro name is not followed by a `(',
it is deemed to have no arguments.
Leading unquoted blanks, tabs, and newlines are ignored while collecting arguments.
Potential macro names consist of alphabetic letters,
digits, and underscore `\_', where the first character is not a digit.
.s3
Left and right single quotes (\*g\*a) are used to quote strings.
The value of a quoted string is the string stripped of the quotes.
.s3
When a macro name is recognized,
its arguments are collected by searching for a matching right
parenthesis.
Macro evaluation proceeds normally during the collection of the arguments,
and any commas or right parentheses
which happen to turn up within the value of a nested
call are as effective as those in the original input text.
After argument collection,
the value of the macro is pushed back onto the input stream
and rescanned.
.s3
.it M4
makes available the following built-in macros.
They may be redefined, but once this is done the original meaning is lost.
Their values are null unless otherwise stated.
.s3
.lp +10 10
define	The second argument is installed as the value of the macro
whose name is the first argument.
Each occurrence of $\fIn\fR in the replacement text,
where
.it n
is a digit,
is replaced by the \fIn\fP-th argument.
Argument 0 is the name of the macro;
missing arguments are replaced by the null string.
.s3
.lp +10 10
undefine	removes the definition of the macro named in its argument.
.s3
.lp +10 10
ifdef	If the first argument is defined, the value is the second argument, otherwise the third.
If there is no third argument, the value is null.
.s3
.lp +10 10
changequote Change quote characters to the first and second arguments.
.it Changequote
without arguments restores the original values
(i.e., \*g\*a).
.s3
.lp +10 10
divert	\fIM4\fP maintains 10 output streams,
numbered 0-9.
The final output is the concatenation of the streams
in numerical order;
initially stream 0 is the current stream.
The
.it divert
macro changes the current output stream to its (digit-string)
argument.
Output diverted to a stream other than 0 through 9
is discarded.
.s3
.lp +10 10
undivert	causes immediate output of text from diversions named as
arguments, or all diversions if no argument.
Text may be undiverted into another diversion.
Undiverting discards the diverted text.
.s3
.lp +10 10
divnum	returns the value of the current output stream.
.s3
.lp +10 10
dnl	reads and discards characters up to and including the next newline.
.s3
.lp +10 10
ifelse	has three or more arguments.
If the first argument is the same string as the second,
then the value is the third argument.
If not, and if there are more than four arguments, the process is repeated with arguments 4, 5, 6 and 7.
Otherwise, the value is either the fourth string, or, if it is not present,
null.
.s3
.lp +10 10
incr	returns the value of its argument incremented by 1.
The value of the argument is calculated
by interpreting an initial digit-string as a decimal number.
.s3
.lp +10 10
eval	evaluates its argument as an arithmetic expression, using 32-bit arithmetic.
Operators include +, \*-, \(**, /, %, ^ (exponentiation); relationals; parentheses.
.s3
.lp +10 10
len	returns the number of characters in its argument.
.s3
.lp +10 10
index	returns the position in its first argument where the second argument begins (zero origin),
or \*-1 if the second argument does not occur.
.s3
.lp +10 10
substr	returns a substring of its first argument.
The second argument is a zero origin
number selecting the first character;
the third argument indicates the length of the substring.
A missing third argument is taken to be large enough to extend to
the end of the first string.
.s3
.lp +10 10
include	returns the contents of the file named in the argument.
.s3
.lp +10 10
sinclude	is identical to
.it include,
except that it
says nothing if the file is inaccessible.
.s3
.lp +10 10
syscmd	executes the UNIX command given in the first argument.
.s3
.lp +10 10
errprint	prints its argument
on the diagnostic output file.
.s3
.lp +10 10
dumpdef	prints current names and definitions,
for the named items, or for all if no arguments are given.
.i0
.dt
.sh "SEE ALSO"
.it "The M4 Macro Processor"
by B. W. Kernighan and D. M. Ritchie.