README

   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.
   7
   8 GNU `m4' was originally written by Rene' Seindal, from Denmark.
   9 This release is considered stable.
  10
  11 If GNU `m4' is meant to serve GNU `autoconf', beware that `m4'
  12 should be fully installed *prior to* configuring `autoconf' itself.
  13 Likewise, if you intend on hacking GNU `m4' from git, the bootstrap
  14 process requires that you first install a released copy of GNU `m4'.
  15
  16 If you are just trying to build `m4' from a released tarball, you
  17 should not normally need to run `./bootstrap' or `autoreconf'; just go
  18 ahead and start with `./configure'.  If you are trying to build `m4'
  19 from git, more information can be found in the version-control-only
  20 file HACKING.
  21
  22 M4 has an optional dependency on the libsigsegv library:
  23   http://www.gnu.org/software/libsigsegv/
  24 If the library has not been installed in the standard location, you
  25 can use `./configure --with-libsigsegv-prefix=/path/to/dir', to make
  26 the build of `m4' use /path/to/dir/include/sigsegv.h as appropriate.
  27 The use of this library is optional; the only difference in having it
  28 available is that it increases the number of platforms where `m4' can
  29 correctly distinguish stack overflow from an internal bug.  It is
  30 recommended that you use version 2.9 or newer.
  31
  32 In the subdirectory `examples' you will find various m4 files, ranging
  33 from trivial test files to rather advanced macros.  If you intend to
  34 use m4 seriously, you might find useful material down there.
  35
  36 See file `BACKLOG' for a summary of pending mail and articles.
  37 See file `COPYING' for copying conditions.  Note that M4 is distributed
  38 under the GNU Public License version 3 or later.  Some files in the
  39 distribution are copied from the gnulib project, and hence bear the
  40 designation version 2 or later because they are unmodified from gnulib;
  41 however, if you modify these files using M4 rather than gnulib as the
  42 source, you must update the license to be GPLv3 or later.
  43 See file `INSTALL' for compilation and installation instructions.
  44 See file `NEWS' for a list of major changes in the current release.
  45 See file `THANKS' for a list of contributors.
  46
  47 By default, the `syscmd' and `esyscmd' macros try to use the first
  48 instance of `sh' found by `command -p getconf PATH' at configure time,
  49 with a default of `/bin/sh'.  If that default is inappropriate, you
  50 can use `./configure --with-syscmd-shell=location' to specify the
  51 shell to use.
  52
  53 By using `./configure --enable-changeword', you get an experimental
  54 feature which allows for changing the syntax of what is a "word" in
  55 `m4'.  This feature will not be present in m4 2.0, but will be
  56 replaced by other new features which provide similar capability, so
  57 do not count on it.
  58
  59 Send bug reports to `bug-m4@gnu.org'.  A bug report is an adequate
  60 description of the problem: your input, what you expected, what you got,
  61 and why this is wrong.  Diffs are welcome, but they only describe a
  62 solution, from which the problem might be uneasy to infer.
  63
  64 For any copyright year range specified as YYYY-ZZZZ in this package
  65 note that the range specifies every single year in that closed interval.
  66
  67 ========================================================================
  68
  69 Copyright (C) 2000, 2005-2011 Free Software Foundation, Inc.
  70
  71 Permission is granted to copy, distribute and/or modify this document
  72 under the terms of the GNU Free Documentation License, Version 1.3 or
  73 any later version published by the Free Software Foundation; with no
  74 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
  75 Texts.  A copy of the license is included in the ``GNU Free
  76 Documentation License'' file as part of this distribution.