* ltdl/m4/m4-getopt.m4 (M4_GETOPT): Update to take into account
[m4/ericb.git] / NEWS
blobc7540dee011be745ae4458537236b6f146fe727c
1 GNU m4 NEWS - History of user-visible changes.          -*- outline -*-
2 Copyright 1992, 1993, 1994, 1998, 2000, 2001, 2006 Free Software
3 Foundation, Inc.
5 Version beta 1.9a - ???, by ???
7 * If the POSIXLY_CORRECT environment variable is set, m4 now disables
8   GNU extensions that are incompatible with POSIX.
10 * POSIXLY_CORRECT and `m4 --traditional' now makes the `define' builtin
11   replace all `pushdef'ed values of a macro, as POSIX requires.
13 * The `defn' builtin now allows any number of arguments, as POSIX requires.
15 * The '$' syntax class is now enabled.  See the info docs for examples.
17 Version beta 1.4q - August 2001, by Gary V. Vaughan
19 * Support for the experimental `changeword' has been dropped.
21 * `m4 --hashsize' and `-H' are still accepted, but have no effect.  M4
22   will grow its internal symbol table if the symbol density is having
23   an effect on performance.
25 * `configure --without-modules' will build an m4 binary with no preloaded
26   modules.  At startup it will search for and load modules `m4' and either
27   `gnu' or `traditional'.  This mode of operation can be used for
28   development and debugging of the base modules without the need to
29   recompile all of m4 with each modification.
31 * `configure --with-modules="gnu m4 traditional load"', for example,
32   will build an m4 binary with the named modules preloaded, ready to
33   be activated (even on static lib only machines) with the `-m' option
34   or using the `load' builtin.
36 * M4 has no builtins or macros in core, they are all loaded from modules
37   at startup.  This means that modules are no longer optional, though
38   the standard build will statically link the modules `m4', `gnu' and
39   `traditional', so even on machines with no ltdl support, all of the
40   functionality from previous releases is available.
42 * New builtin `load' to dynamically load modules which can define new
43   builtins and user macros.
45 * New builtin `unload' to remove loaded modules (and the builtins and user
46   macros they define) from the running m4 interpreter.
48 * New builtins `eregexp' and `epatsubst' to use Extended Regular Expressions
49   syntax in lieu of Basic Regular Expressions as used by `regexp' and
50   `patsubst'.
52 * The names of all currently loaded modules are returned by the new
53   builtin, ``modules''.
55 * Loadable modules can define new builtin functions or text expansion
56   macros.
58 * The module code has been rewritten to use libltdl, the libtool dynamic
59   loader, which means GNU m4 can now load (and unload) modules just about
60   anywhere which it can be built.  This includes obscure hosts such as
61   cygwin and BeOS, and also on hosts which do not have shared libraries,
62   through preloading (see libtool manual) and GNU dld.
64 * Modules can now be built without the m4 source being available using the
65   installed m4module.h header file (and some other headers that it includes
66   for you), and the installed libm4.la libtool library.  All symbols
67   exported from libm4.la have a prefix of `m4_' or `M4_'.  See the modules
68   directory for examples of usage.
70 * A new V2 format for frozen files that saves module and syntax information.
72 Version beta 1.4o - January 2000, by Rene' Seindal
74 * Modules can be loaded from the command line with --load-module
76 * Modules now use libtool's wrapper libltdl.
78 * Bug fixes.
80 Version beta 1.4n - November 1998, by Rene' Seindal
82 * The module code has been reorganised yet again, and now compiles
83   correctly on GNU/Linux, HPUX 9 and 10, SunOS 5 and Solaris 5.
85 * When configured --with-gmp a new builtin `mpeval' is now defined.  The
86   builtin `eval' retains its normal behaviour.
88 * m4 --version also shows which options were used for compilation, such as:
89   "GNU m4 1.4n (options: modules gmp changeword)"
91 * New option --import-environment defines all environment variables as
92   macros.  This is done before -D and -U are handled, so the macros can be
93   changed through these options.
95 * Error messages now always print program name before input file name as
96   specified by GNU coding standards.  Reported by Akim Demaille
97   <demaille@inf.enst.fr>.
99 * Bug fixed: "undivert(0)" could cause m4 to read standard output.  A call
100   of "undivert(0)" is now silently ignored.
102 * Bug fixed: when compiling --with-included-gettext, <libintl.h> wasn't
103   found in intl/ directory.  Reported by Andrew Bettison
104   <andrewb@zip.com.au>.
106 Version beta 1.4m - November 1998, by Rene' Seindal
108 * Using libtool for compiling modules and for linking main app.
110 * Reorganised the dynamic module code to encapsulate system dependencies
111   better.  The code for HPUX shl_load() still needs testing and debugging.
112   A dld interface is also missing.  Any volunteers?
114 * The files from the GNU m4 web-site is now in examples/WWW as a more
115   complete example of what GNU m4 can do.
117 Version beta 1.4l - November 1998, by Rene' Seindal
119 * GNU m4 now has an escape syntax category.  If a character is marked as
120   an escape, words are only recognised as macros if preceded by an escape
121   character.  It is a bit like -P, but dynamic: it can be turned on and
122   off.  The GNU m4 web-site on http://www.seindal.dk/rene/gnu/ is
123   maintained with this feature - the m4 source is available on the site.
125 * The module interface is improved, thanks to "Brian J. Fox"
126   <bfox@datawave.net>, who have contributed some code from Meta-HTML.  The
127   modules now build automatically and installs properly, by default in
128   /usr/local/libexec/m4.  There is a preliminary, untested support for
129   shl_load().
131 * There is now a __m4_version__ macro that expands to the current version
132   number.
134 Version beta 1.4k - November 1998, by Erick Branderhorst and Rene' Seindal
136 * GNU m4 now uses gettext to support internationalization.
138 * GNU m4 now uses automake to control Makefile.in generation.  This
139   should make it more consistent with the GNU standards.
141 * GNU m4 will use the gmp library for multiple precision integral and
142   rational arithmetic in `eval' if configured with `--with-gmp'.  If
143   configured without `--with-gmp' or if gmp is not available, and the type
144   `long long int' is, GNU m4 will use that for `eval' arithmetic.
146 * GNU m4 now parses the input according to a syntax table, that can be
147   modified through the new builtin `changesyntax'.  It is a generalisation
148   of the existing builtins `changecom' and `changequote'.  The changes are
149   completely backwards compatible (except for the existence of
150   `changesyntax').
152 * Sync lines can be turned on and off with the `syncoutput' builtin.  The
153   builtin `syncoutput' is a GNU extension.
155 * New experimental feature: dynamically loadable modules.  New builtin
156   `loadmodules' loads shared libraries, that can define new builtin
157   macros, ie, new macros can be written in C.  Depends on the dlopen()
158   interface, and is currently only tested on Linux.  Enabled at configure
159   time with `--with-modules'.  Documentation is in src/module.c and
160   module/README.
162 * Implement a GNU message catalog for French (Franc,ois Pinard).
164 * Filenames found through path searches are now correctly reflected in
165   error and debug messages and through the `__file__' macro.
167 Bugs fixed
169 * All 8-bit characters can now be used for quotes.
172 Version 1.4 - October 1994, by Franc,ois Pinard
174 (No user visible changes)
177 Version 1.3 - September 1994, by Franc,ois Pinard
179 * Diversions are created as needed.  Option `-N' is still accepted, but
180 otherwise ignored.  Users should use only negative diversion numbers,
181 instead of high positive numbers, for diverting to nowhere.
183 * Diversions should also work faster.  No temporary files will be needed
184 at all if all diversions taken altogether do not use more than 512K.
186 * Frozen state files may be produced with the `--freeze-state' (-F)
187 option and later brought back through the `--reload-state' (-R) option.
190 Version 1.2 - July 1994, by Franc,ois Pinard
192 * In patsubst(STRING, REGEXP, REPLACEMENT), \& in REPLACEMENT has been
193 changed to represent this part of STRING matched by the whole REGEXP,
194 instead of the whole STRING as before.  \0 does the same, but emits a
195 diagnostic saying it will disappear in some subsequent release.
197 * eval(EXPR) emits a diagnostic if EXPR has suffixed crumb.  The same for
198 other numeric conversions in incr(), decr(), divert(), etc.
200 * `--fatal-warnings' (-E) stops execution at first warning.
202 * `--nesting-limit=LEVEL' (-L LEVEL) sets a limit to macro nesting.
203 It is initially fixed at 250.
205 * `--word-regexp=REGEXP' (-W REGEXP) modifies macro name syntax, like
206 does the new `changeword(REGEXP)' macro.  This feature is experimental,
207 tell me your opinions about it.  You do need --enable-changeword at
208 configure time to get these things.  Do *not* depend on them yet.
210 * Trace output format is scannable by GNU Emacs' next-error function.
212 * Stack overflow is detected and diagnosed on some capable systems.
214 * Various bugs have been corrected, m4 should be more portable.  See the
215 ChangeLog for details.
218 Version 1.1 - November 1993, by Franc,ois Pinard
220 Changes which might affect existing GNU m4 scripts:
222 * Option `-V' has been removed, use `--version' instead.  `--version'
223 writes on standard output instead of standard error, and inhibits any
224 script execution.
226 * `--no-gnu-extensions' has been renamed `--traditional'.
228 * In `eval', `^' used to indicate exponentiation, use `**' instead.
230 * The automatic undiversion which takes place at end of all input is
231 forced into the main output stream.
233 Changes which are unlikely to affect existing scripts:
235 * `--help' prints an usage summary on standard output.  Script execution
236 is then inhibited.
238 * `--prefix-builtins' (-P) prefixes all builtin macros by `m4_'.
240 * Most builtin macros for which arguments are mandatory, called without
241 any arguments, are no more recognized as builtin macros: they are
242 consequently copied verbatim to the output stream.
244 * `define' and `pushdef' are usable with only one argument, they give
245 this argument an empty definition.
247 * `eval' new operators for binary representation handling: `^' for
248 exclusive-or, `~' for the bitwise negation, `<<' and `>>' for shifts.
250 * `eval' recognizes the notation 0bDIGITS for binary numbers and the
251 notation 0rRADIX:DIGITS for numbers in any radix from 1 to 36.
253 Version 1.0.3 - December 1992, by Franc,ois Pinard
255 Changes for the user:
257 * `dnl' outputs a diagnostic if immediately followed by `('.  Usually,
258 `dnl' is followed by newline or whitespace.
260 * `ifelse' accepts without complaining the common idiom of having only
261 one argument.  This is useful for introducing long comments.
263 * `eval' always expresses values as signed, whatever the radix.
265 * M4OPTS environment variable is no longer obeyed.
267 * `--no-warnings' option is renamed `--silent'.
269 * Debug lines use a new format more compatible with GNU standards.
271 * Various bugs have been corrected.  See the ChangeLog for details.
273 Changes for the installer:
275 * GNU m4 now uses an Autoconf-generated configure script, and should be
276 more easily portable in many ways.  (Cray is not supported yet).
278 * `make check' has been made more portable, expect no errors.
280 Changes for the programmer:
282 * Sources have been fully reindented to comply with GNU standards, and
283 cleaned up in many ways.
285 * Sources have been protoized.  Non-ANSI compilers are automatically
286 detected, then sources are unprotoized on the fly before compilation.
288 * GNU m4 uses newer versions of obstack, regex, getopt, etc.
290 Version 1.0 - October 1991, by Rene' Seindal
292 * Uses GNU configure, taken from the gdb distribution.
294 * Uses GNU getopt(), with long option names.
296 * The -Q/+quiet option is added, which suppresses warnings about missing
297 or superflous arguments to builtin macros.
299 * Added default options via the M4OPTS environment variable.
301 * Several minor bugs have been fixed.
303 Version 0.99 - July 1991, by Rene' Seindal
305 * The builtins `incr' and `decr' are now implemented without use of
306 `eval'.
308 * The builtin `indir' is added, to allow for indirect macro calls
309 (allows use of "illegal" macro names).
311 * The debugging and tracing facilities has been enhanced considerably.
312 See the manual for details.
314 * The -tMACRO option is added, marks MACRO for tracing as soon as it
315 is defined.
317 * Builtins are traced after renaming iff they were before.
319 * Named files can now be undiverted.
321 * The -Nnum option can be used to increase the number of divertions
322 available.
324 * Calling changecom without arguments now disables all comment handling.
326 * A bug in `dnl' is fixed.
328 * A bug in the multi-character quoting code is fixed.
330 * Several typos in the manual has been corrected.  More probably persist.
332 Version 0.75 - November 1990, by Rene' Seindal
334 * Implemented search path for include files (-I option and M4PATH
335 environment variable).
337 * Implemented builtin `format' for printf-like formatting.
339 * Implemented builtin `regexp' for searching for regular expressions.
341 * Implemented builtin `patsubst' for substitution with regular
342 expressions.
344 * Implemented builtin `esyscmd', which expands to a shell commands output.
346 * Implemented `__file__' and `__line__' for use in error messages.
348 * Implemented character ranges in `translit'.
350 * Implemented control over debugging output.
352 * Implemented multi-character quotes.
354 * Implemented multi-character comment delimiters.
356 * Changed predefined macro `gnu' to `__gnu__'.
358 * Changed predefined macro `unix' to `__unix__', when the -G option is
359 not used.  With -G, `unix' is still defined.
361 * Added program name to error messages.
363 * Fixed two missing null bytes bugs.
365 Version 0.50 - January 1990, by Rene' Seindal
367 * Initial beta release.
369 Local Variables:
370 fill-column: 75
371 End: