* src/builtin.c (substitute): Avoid core dump when accessing
[m4/ericb.git] / README
blobafbcf05d6897b48f5656e1f858471374382dc7d0
1 GNU `m4' is an implementation of the traditional Unix macro
2 processor.  It is mostly SVR4 compatible, although it has some
3 extensions (for example, handling more than 9 positional parameters
4 to macros).  `m4' also has built-in functions for including files,
5 running shell commands, doing arithmetic, etc.  Autoconf needs GNU
6 `m4' for generating `configure' scripts, but not for running them.
8 GNU `m4' was originally written by Rene' Seindal, from Denmark.
9 This release is considered stable.
11 If GNU `m4' is meant to serve GNU `autoconf', beware that `m4'
12 should be fully installed *prior to* configuring `autoconf' itself.
14 In the subdirectory `examples' you will find various m4 files, ranging
15 from trivial test files to rather advanced macros.  If you intend to
16 use m4 seriously, you might find useful material down there.
18 See file `BACKLOG' for a summary of pending mail and articles.
19 See file `COPYING' for copying conditions.
20 See file `INSTALL' for compilation and installation instructions.
21 See file `NEWS' for a list of major changes in the current release.
22 See file `THANKS' for a list of contributors.
24 By using `./configure --enable-changeword', you get an experimental
25 feature which allows for changing the syntax of what is a "word" in
26 `m4'.  This feature will not be present in m4 2.0, but will be
27 replaced by other new features which provide the same capability, so
28 do not count on it.
30 Send bug reports to `bug-m4@gnu.org'.  A bug report is an adequate
31 description of the problem: your input, what you expected, what you got,
32 and why this is wrong.  Diffs are welcome, but they only describe a
33 solution, from which the problem might be uneasy to infer.