m4: Sync with FreeBSD.
[dragonfly.git] / usr.bin / m4 / m4.1
index d22b432..c23eac5 100644 (file)
@@ -1,52 +1,98 @@
-.\"    @(#) $OpenBSD: m4.1,v 1.24 2002/04/18 18:57:23 espie Exp $
-.\" $FreeBSD: src/usr.bin/m4/m4.1,v 1.27 2005/01/17 07:44:22 ru Exp $
-.\" $DragonFly: src/usr.bin/m4/m4.1,v 1.5 2007/07/30 22:11:33 swildner Exp $
+.\"    $NetBSD: m4.1,v 1.22 2010/05/14 17:14:28 joerg Exp $
+.\"    @(#) $OpenBSD: m4.1,v 1.56 2009/10/14 17:19:47 sthen Exp $
 .\"
-.Dd July 3, 2004
+.\" Copyright (c) 1989, 1993
+.\"    The Regents of the University of California.  All rights reserved.
+.\"
+.\" This code is derived from software contributed to Berkeley by
+.\" Ozan Yigit at York University.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD: src/usr.bin/m4/m4.1,v 1.30 2012/11/17 01:54:24 svnexp Exp $
+.\"
+.Dd October 14, 2009
 .Dt M4 1
 .Os
 .Sh NAME
 .Nm m4
 .Nd macro language processor
 .Sh SYNOPSIS
-.Nm
+.Nm m4
+.Op Fl gPs
+.Oo
+.Sm off
+.Fl D Ar name Op No = Ar value
+.Sm on
+.Oc
 .Op Fl d Ar flags
-.Op Fl t Ar name
-.Op Fl Pgs
-.Op Fl D Ar name Ns Op = Ns Ar value
-.Op Fl U Ar name
 .Op Fl I Ar dirname
+.Op Fl o Ar filename
+.Bk -words
+.Op Fl t Ar macro
+.Op Fl U Ns Ar name
 .Op Ar
+.Ek
 .Sh DESCRIPTION
 The
-.Nm
+.Nm m4
 utility is a macro processor that can be used as a front end to any
 language (e.g., C, ratfor, fortran, lex, and yacc).
-The
-.Nm
-utility reads from the standard input and writes
-the processed text to the standard output.
+If no input files are given,
+.Nm m4
+reads from the standard input,
+otherwise files specified on the command line are
+processed in the given order.
+Input files can be regular files, files in the m4 include paths, or a
+single dash
+.Pq Sq - ,
+denoting standard input.
+.Nm m4
+writes
+the processed text to the standard output, unless told otherwise.
 .Pp
-Macro calls have the form
-.Ic name Ns Pq Ar argument1 Ns Op , Ar argument2 , ... , argumentN .
+Macro calls have the form name(argument1[, argument2, ..., argumentN]).
 .Pp
 There cannot be any space following the macro name and the open
 parenthesis
-.Pq Ql \&( .
+.Sq \&( .
 If the macro name is not followed by an open
 parenthesis it is processed with no arguments.
 .Pp
 Macro names consist of a leading alphabetic or underscore
 possibly followed by alphanumeric or underscore characters, e.g.,
 valid macro names match the pattern
-.Dq Li [a-zA-Z_][a-zA-Z0-9_]* .
+.Dq [a-zA-Z_][a-zA-Z0-9_]* .
 .Pp
 In arguments to macros, leading unquoted space, tab, and newline
-.Pq Ql \en
+.Pq Sq \en
 characters are ignored.
-To quote strings, use left and right single
-quotes (e.g.,
-.Sq "\ this is a string with a leading space" ) .
+To quote strings, use left and right single quotes
+.Po e.g.,\ \&
+.Sq "\ this is a string with a leading space"
+.Pc .
 You can change the quote characters with the
 .Ic changequote
 built-in macro.
@@ -55,161 +101,166 @@ Most built-ins do not make any sense without arguments, and hence are not
 recognized as special when not followed by an open parenthesis.
 .Pp
 The options are as follows:
-.Bl -tag -width indent
-.It Fl s
-Emit
-.Ic #line
-directives for
-.Xr cpp 1 .
-.It Fl D Ar name Ns Op = Ns Ar value
+.Bl -tag -width Ds
+.It Fl D Ns Ar name Ns Op Pf = Ns Ar value
 Define the symbol
 .Ar name
 to have some value (or
 .Dv NULL ) .
-.It Fl U Ar name
-Undefine the symbol
-.Ar name .
-.It Fl P
-Prefixes all
-.Nm
-builtin macros with the string
-.Li m4_ .
-This changes the macro names
-.Li dnl
-to
-.Li m4_dnl ,
-.Li index
-to
-.Li m4_index ,
-and so forth.
-.It Fl I Ar dirname
-Add directory
-.Ar dirname
-to the include path.
-.It Fl d Ar flags
+.It Fl d Ar "flags"
 Set trace flags.
-The
 .Ar flags
-argument may hold the following:
-.Pp
-.Bl -tag -width indent -compact
-.It Cm a
-print macro arguments
-.It Cm c
-print macro expansion over several lines
-.It Cm e
-print result of macro expansion
-.It Cm f
-print filename location
-.It Cm l
-print line number
-.It Cm q
-quote arguments and expansion with the current quotes
-.It Cm t
-start with all macros traced
-.It Cm x
-number macro expansions
-.It Cm V
-turn on all options
+may hold the following:
+.Bl -tag -width Ds
+.It Ar a
+print macro arguments.
+.It Ar c
+print macro expansion over several lines.
+.It Ar e
+print result of macro expansion.
+.It Ar f
+print filename location.
+.It Ar l
+print line number.
+.It Ar q
+quote arguments and expansion with the current quotes.
+.It Ar t
+start with all macros traced.
+.It Ar x
+number macro expansions.
+.It Ar V
+turn on all options.
 .El
 .Pp
 By default, trace is set to
-.Cm eq .
+.Qq eq .
+.It Fl g
+Activate GNU-m4 compatibility mode.
+In this mode, translit handles simple character
+ranges (e.g., a-z), regular expressions mimic emacs behavior,
+multiple m4wrap calls are handled as a stack,
+the number of diversions is unlimited,
+empty names for macro definitions are allowed,
+and eval understands
+.Sq 0rbase:value
+numbers.
+.It Fl I Ar "dirname"
+Add directory
+.Ar dirname
+to the include path.
+.It Fl o Ar filename
+Send trace output to
+.Ar filename .
+.It Fl P
+Prefix all built-in macros with
+.Sq m4_ .
+For example, instead of writing
+.Ic define ,
+use
+.Ic m4_define .
+.It Fl s
+Output line synchronization directives, suitable for
+.Xr cpp 1 .
 .It Fl t Ar macro
 Turn tracing on for
 .Ar macro .
-.It Fl g
-Activate GNU-m4 compatibility mode.
-In this mode,
-.Ic changequote
-with two empty parameters deactivates quotes,
-.Ic translit
-handles simple character ranges (e.g.,
-.Li a-z ) ,
-regular expressions mimic
-.Xr emacs 1
-behavior,
-and the number of diversions is unlimited.
+.It Fl "U" Ns Ar "name"
+Undefine the symbol
+.Ar name .
 .El
 .Sh SYNTAX
-The
-.Nm
-utility provides the following built-in macros.
+.Nm m4
+provides the following built-in macros.
 They may be redefined, losing their original meaning.
 Return values are null unless otherwise stated.
-.Bl -tag -width ".Ic changequote"
-.It Ic builtin
-Calls a built-in by its name, overriding possible redefinitions.
-.It Ic changecom
-Changes the start and end comment sequences.
-The default is the pound sign
-.Pq Ql #
+.Bl -tag -width changequote
+.It Fn builtin name
+Calls a built-in by its
+.Fa name ,
+overriding possible redefinitions.
+.It Fn changecom startcomment endcomment
+Changes the start comment and end comment sequences.
+Comment sequences may be up to five characters long.
+The default values are the hash sign
 and the newline character.
-With no arguments, the comment sequence is reset to the default,
-in GNU
-.Nm
-mode, comments are turned off.
-The maximum length for a comment marker is five characters.
-.It Ic changequote
-Defines the quote symbols to be the first and second arguments.
-The symbols may be up to five characters long.
-If no arguments are
-given it restores the default open and close single quotes.
-.It Ic decr
-Decrements the argument by 1.
-The argument must be a valid numeric string.
-.It Ic define
-Define a new macro named by the first argument to have the
-value of the second argument.
+.Bd -literal -offset indent
+# This is a comment
+.Ed
+.Pp
+With no arguments, comments are turned off.
+With one single argument, the end comment sequence is set
+to the newline character.
+.It Fn changequote beginquote endquote
+Defines the open quote and close quote sequences.
+Quote sequences may be up to five characters long.
+The default values are the backquote character and the quote
+character.
+.Bd -literal -offset indent
+`Here is a quoted string'
+.Ed
+.Pp
+With no arguments, the default quotes are restored.
+With one single argument, the close quote sequence is set
+to the newline character.
+.It Fn decr arg
+Decrements the argument
+.Fa arg
+by 1.
+The argument
+.Fa arg
+must be a valid numeric string.
+.It Fn define name value
+Define a new macro named by the first argument
+.Fa name
+to have the
+value of the second argument
+.Fa value .
 Each occurrence of
-.Sq Li $ Ns Ar n
+.Sq $n
 (where
 .Ar n
 is 0 through 9) is replaced by the
 .Ar n Ns 'th
 argument.
-.Ql $0
+.Sq $0
 is the name of the calling macro.
 Undefined arguments are replaced by a null string.
-.Ql $#
+.Sq $#
 is replaced by the number of arguments;
-.Ql $*
+.Sq $*
 is replaced by all arguments comma separated;
-.Ql $@
+.Sq $@
 is the same as
-.Ql $*
+.Sq $*
 but all arguments are quoted against further expansion.
-.It Ic defn
+.It Fn defn name ...
 Returns the quoted definition for each argument.
 This can be used to rename
 macro definitions (even for built-in macros).
-.It Ic divert
+.It Fn divert num
 There are 10 output queues (numbered 0-9).
 At the end of processing
-.Nm
+.Nm m4
 concatenates all the queues in numerical order to produce the
 final output.
 Initially the output queue is 0.
-The
-.Ic divert
+The divert
 macro allows you to select a new output queue (an invalid argument
-passed to
-.Ic divert
-causes output to be discarded).
+passed to divert causes output to be discarded).
 .It Ic divnum
 Returns the current output queue number.
 .It Ic dnl
-Discards input characters up to and including the next newline.
-.It Ic dumpdef
+Discard input characters up to and including the next newline.
+.It Fn dumpdef name ...
 Prints the names and definitions for the named items, or for everything
 if no arguments are passed.
-.It Ic errprint
+.It Fn errprint msg
 Prints the first argument on the standard error output stream.
-.It Ic esyscmd
+.It Fn esyscmd cmd
 Passes its first argument to a shell and returns the shell's standard output.
 Note that the shell shares its standard input and standard error with
-.Nm .
-.It Ic eval
+.Nm m4 .
+.It Fn eval expr
 Computes the first argument as an arithmetic expression using 32-bit
 arithmetic.
 Operators are the standard C ternary, arithmetic, logical,
@@ -217,30 +268,46 @@ shift, relational, bitwise, and parentheses operators.
 You can specify
 octal, decimal, and hexadecimal numbers as in C.
 The second argument (if any)
-specifies the radix for the result, and the third argument (if any)
+specifies the radix for the result and the third argument (if any)
 specifies the minimum number of digits in the result.
-.It Ic expr
+.It Fn expr expr
 This is an alias for
 .Ic eval .
-.It Ic ifdef
+.It Fn format formatstring arg1 ...
+Returns
+.Fa formatstring
+with escape sequences substituted with
+.Fa arg1
+and following arguments, in a way similar to
+.Xr printf 3 .
+This built-in is only available in GNU-m4 compatibility mode, and the only
+parameters implemented are there for autoconf compatibility:
+left-padding flag, an optional field width, a maximum field width,
+*-specified field widths, and the %s and %c data type.
+.It Fn ifdef name yes no
 If the macro named by the first argument is defined then return the second
 argument, otherwise the third.
 If there is no third argument, the value is
 .Dv NULL .
 The word
-.Ic unix
+.Qq unix
 is predefined.
-.It Ic ifelse
-If the first argument matches the second argument then
-.Ic ifelse
+.It Fn ifelse a b yes ...
+If the first argument
+.Fa a
+matches the second argument
+.Fa b
+then
+.Fn ifelse
 returns
-the third argument.
-If the match fails, the three arguments are
+the third argument
+.Fa yes .
+If the match fails the three arguments are
 discarded and the next three arguments are used until there is
 zero or one arguments left, either this last argument or
 .Dv NULL
 is returned if no other matches were found.
-.It Ic include
+.It Fn include name
 Returns the contents of the file specified in the first argument.
 If the file is not found as is, look through the include path:
 first the directories specified with
@@ -248,114 +315,114 @@ first the directories specified with
 on the command line, then the environment variable
 .Ev M4PATH ,
 as a colon-separated list of directories.
-Aborts with an error message if the file cannot be included.
-.It Ic incr
+Include aborts with an error message if the file cannot be included.
+.It Fn incr arg
 Increments the argument by 1.
 The argument must be a valid numeric string.
-.It Ic index
+.It Fn index string substring
 Returns the index of the second argument in the first argument (e.g.,
-.Fn index "the quick brown fox jumped" fox
+.Ic index(the quick brown fox jumped, fox)
 returns 16).
 If the second
-argument is not found,
-.Ic index
-returns \-1.
-.It Ic indir
-Indirectly calls the macro whose name is passed as the first arguments,
-with the remaining arguments passed as first, etc.\& arguments.
-.It Ic len
+argument is not found index returns \-1.
+.It Fn indir macro arg1 ...
+Indirectly calls the macro whose name is passed as the first argument,
+with the remaining arguments passed as first, ... arguments.
+.It Fn len arg
 Returns the number of characters in the first argument.
 Extra arguments
 are ignored.
-.It Ic m4exit
+.It Fn m4exit code
 Immediately exits with the return value specified by the first argument,
 0 if none.
-.It Ic m4wrap
+.It Fn m4wrap todo
 Allows you to define what happens at the final
 .Dv EOF ,
 usually for cleanup purposes (e.g.,
-.Fn m4wrap cleanup(tempfile)
-causes the macro
-.Ic cleanup
-to be
+.Ic m4wrap("cleanup(tempfile)")
+causes the macro cleanup to be
 invoked after all other processing is done).
-.It Ic maketemp
-Translates the string
-.Dq Li XXXXX
-in the first argument with the current process
-ID leaving other characters alone.
+.Pp
+Multiple calls to
+.Fn m4wrap
+get inserted in sequence at the final
+.Dv EOF .
+.It Fn maketemp template
+Invokes
+.Xr mkstemp 3
+on the first argument, and returns the modified string.
 This can be used to create unique
 temporary file names.
-.It Ic paste
+.It Fn paste file
 Includes the contents of the file specified by the first argument without
 any macro processing.
 Aborts with an error message if the file cannot be
 included.
-.It Ic patsubst
+.It Fn patsubst string regexp replacement
 Substitutes a regular expression in a string with a replacement string.
 Usual substitution patterns apply: an ampersand
-.Pq Ql &
+.Pq Sq \&&
 is replaced by the string matching the regular expression.
 The string
-.Sq \e Ns Ar # ,
+.Sq \e# ,
 where
-.Ar #
+.Sq #
 is a digit, is replaced by the corresponding back-reference.
-.It Ic popdef
+.It Fn popdef arg ...
 Restores the
 .Ic pushdef Ns ed
 definition for each argument.
-.It Ic pushdef
+.It Fn pushdef macro def
 Takes the same arguments as
 .Ic define ,
 but it saves the definition on a
 stack for later retrieval by
-.Ic popdef .
-.It Ic regexp
+.Fn popdef .
+.It Fn regexp string regexp replacement
 Finds a regular expression in a string.
 If no further arguments are given,
 it returns the first match position or \-1 if no match.
 If a third argument
 is provided, it returns the replacement string, with sub-patterns replaced.
-.It Ic shift
+.It Fn shift arg1 ...
 Returns all but the first argument, the remaining arguments are
 quoted and pushed back with commas in between.
 The quoting
 nullifies the effect of the extra scan that will subsequently be
 performed.
-.It Ic sinclude
+.It Fn sinclude file
 Similar to
 .Ic include ,
 except it ignores any errors.
-.It Ic spaste
+.It Fn spaste file
 Similar to
-.Ic paste ,
+.Fn paste ,
 except it ignores any errors.
-.It Ic substr
+.It Fn substr string offset length
 Returns a substring of the first argument starting at the offset specified
 by the second argument and the length specified by the third argument.
 If no third argument is present it returns the rest of the string.
-.It Ic syscmd
+.It Fn syscmd cmd
 Passes the first argument to the shell.
 Nothing is returned.
 .It Ic sysval
 Returns the return value from the last
 .Ic syscmd .
-.It Ic traceon
+.It Fn traceon arg ...
 Enables tracing of macro expansions for the given arguments, or for all
 macros if no argument is given.
-.It Ic traceoff
+.It Fn traceoff arg ...
 Disables tracing of macro expansions for the given arguments, or for all
 macros if no argument is given.
-.It Ic translit
+.It Fn translit string mapfrom mapto
 Transliterate the characters in the first argument from the set
 given by the second argument to the set given by the third.
 You cannot use
 .Xr tr 1
 style abbreviations.
-.It Ic undefine
+.It Fn undefine name1 ...
 Removes the definition for the macros specified by its arguments.
-.It Ic undivert
+.It Fn undivert arg ...
 Flushes the named output queues (or all queues if no arguments).
 .It Ic unix
 A pre-defined macro for testing the OS platform.
@@ -364,37 +431,20 @@ Returns the current file's line number.
 .It Ic __file__
 Returns the current file's name.
 .El
-.Sh EXIT STATUS
-.Ex -std
-.Pp
-The
-.Ic m4exit
-macro may be used to change the exit status from the input file.
-.Sh COMPATIBILITY
+.Sh STANDARDS
 The
 .Nm
-utility follows the
-.St -susv2 ,
-along with a few extensions taken from GNU-m4.
-Flags
-.Fl I , d ,
-and
-.Fl t
-are non-standard.
-.Pp
-The output format of tracing and of
-.Ic dumpdef
-are not specified in any standard,
-are likely to change and should not be relied upon.
-The current format of tracing is closely modeled on GNU-m4,
-to allow
-.Nm autoconf
-to work.
+utility is compliant with the
+.St -p1003.1-2008
+specification.
 .Pp
-For portability, one should not use the macros
+The flags
+.Op Fl dgIot
+and the macros
 .Ic builtin ,
 .Ic esyscmd ,
 .Ic expr ,
+.Ic format ,
 .Ic indir ,
 .Ic paste ,
 .Ic patsubst ,
@@ -403,34 +453,43 @@ For portability, one should not use the macros
 .Ic unix ,
 .Ic __line__ ,
 and
-.Ic __file__ .
+.Ic __file__
+are extensions to that specification.
+.Pp
+The output format of tracing and of
+.Ic dumpdef
+are not specified in any standard,
+are likely to change and should not be relied upon.
+The current format of tracing is closely modelled on
+.Nm gnu-m4 ,
+to allow
+.Nm autoconf
+to work.
+.Pp
+The built-ins
+.Ic pushdef
+and
+.Ic popdef
+handle macro definitions as a stack.
+However,
+.Ic define
+interacts with the stack in an undefined way.
+In this implementation,
+.Ic define
+replaces the top-most definition only.
+Other implementations may erase all definitions on the stack instead.
 .Pp
 All built-ins do expand without arguments in many other
-.Nm
-implementations.
+.Nm m4 .
 .Pp
 Many other
 .Nm
-implementations have dire size limitations with respect to buffer sizes.
-.Sh STANDARDS
-The
-.Nm
-utility
-conforms to
-.St -p1003.1-2001 .
-.Sh HISTORY
-An
-.Nm
-command appeared in PWB
-.Ux .
+have dire size limitations with respect to buffer sizes.
 .Sh AUTHORS
 .An -nosplit
 .An Ozan Yigit Aq oz@sis.yorku.ca
 and
 .An Richard A. O'Keefe Aq ok@goanna.cs.rmit.OZ.AU .
+.Pp
 GNU-m4 compatibility extensions by
 .An Marc Espie Aq espie@cvs.openbsd.org .
-.Sh BUGS
-The
-.Nm
-utility does not recognize multibyte characters.