Bump to m4 1.4.19
[platform/upstream/m4.git] / doc / m4.info-2
1 This is m4.info, produced by makeinfo version 6.7 from m4.texi.
2
3 This manual (28 May 2021) is for GNU M4 (version 1.4.19), a package
4 containing an implementation of the m4 macro language.
5
6    Copyright © 1989–1994, 2004–2014, 2016–2017, 2020–2021 Free Software
7 Foundation, Inc.
8
9      Permission is granted to copy, distribute and/or modify this
10      document under the terms of the GNU Free Documentation License,
11      Version 1.3 or any later version published by the Free Software
12      Foundation; with no Invariant Sections, no Front-Cover Texts, and
13      no Back-Cover Texts.  A copy of the license is included in the
14      section entitled “GNU Free Documentation License.”
15 INFO-DIR-SECTION Text creation and manipulation
16 START-INFO-DIR-ENTRY
17 * M4: (m4).                     A powerful macro processor.
18 END-INFO-DIR-ENTRY
19
20 \1f
21 File: m4.info,  Node: Copying This Manual,  Next: Indices,  Prev: Copying This Package,  Up: Top
22
23 Appendix B How to make copies of this manual
24 ********************************************
25
26 This appendix covers the license for copying this manual.  Note that
27 some of the longer examples in this manual are also distributed in the
28 directory ‘m4-1.4.19/examples/’, where a more permissive license is in
29 effect when copying just the examples.
30
31 * Menu:
32
33 * GNU Free Documentation License::  License for copying this manual
34
35 \1f
36 File: m4.info,  Node: GNU Free Documentation License,  Up: Copying This Manual
37
38 B.1 License for copying this manual
39 ===================================
40
41                      Version 1.3, 3 November 2008
42
43      Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
44      <https://fsf.org/>
45
46      Everyone is permitted to copy and distribute verbatim copies
47      of this license document, but changing it is not allowed.
48
49   0. PREAMBLE
50
51      The purpose of this License is to make a manual, textbook, or other
52      functional and useful document “free” in the sense of freedom: to
53      assure everyone the effective freedom to copy and redistribute it,
54      with or without modifying it, either commercially or
55      noncommercially.  Secondarily, this License preserves for the
56      author and publisher a way to get credit for their work, while not
57      being considered responsible for modifications made by others.
58
59      This License is a kind of “copyleft”, which means that derivative
60      works of the document must themselves be free in the same sense.
61      It complements the GNU General Public License, which is a copyleft
62      license designed for free software.
63
64      We have designed this License in order to use it for manuals for
65      free software, because free software needs free documentation: a
66      free program should come with manuals providing the same freedoms
67      that the software does.  But this License is not limited to
68      software manuals; it can be used for any textual work, regardless
69      of subject matter or whether it is published as a printed book.  We
70      recommend this License principally for works whose purpose is
71      instruction or reference.
72
73   1. APPLICABILITY AND DEFINITIONS
74
75      This License applies to any manual or other work, in any medium,
76      that contains a notice placed by the copyright holder saying it can
77      be distributed under the terms of this License.  Such a notice
78      grants a world-wide, royalty-free license, unlimited in duration,
79      to use that work under the conditions stated herein.  The
80      “Document”, below, refers to any such manual or work.  Any member
81      of the public is a licensee, and is addressed as “you”.  You accept
82      the license if you copy, modify or distribute the work in a way
83      requiring permission under copyright law.
84
85      A “Modified Version” of the Document means any work containing the
86      Document or a portion of it, either copied verbatim, or with
87      modifications and/or translated into another language.
88
89      A “Secondary Section” is a named appendix or a front-matter section
90      of the Document that deals exclusively with the relationship of the
91      publishers or authors of the Document to the Document’s overall
92      subject (or to related matters) and contains nothing that could
93      fall directly within that overall subject.  (Thus, if the Document
94      is in part a textbook of mathematics, a Secondary Section may not
95      explain any mathematics.)  The relationship could be a matter of
96      historical connection with the subject or with related matters, or
97      of legal, commercial, philosophical, ethical or political position
98      regarding them.
99
100      The “Invariant Sections” are certain Secondary Sections whose
101      titles are designated, as being those of Invariant Sections, in the
102      notice that says that the Document is released under this License.
103      If a section does not fit the above definition of Secondary then it
104      is not allowed to be designated as Invariant.  The Document may
105      contain zero Invariant Sections.  If the Document does not identify
106      any Invariant Sections then there are none.
107
108      The “Cover Texts” are certain short passages of text that are
109      listed, as Front-Cover Texts or Back-Cover Texts, in the notice
110      that says that the Document is released under this License.  A
111      Front-Cover Text may be at most 5 words, and a Back-Cover Text may
112      be at most 25 words.
113
114      A “Transparent” copy of the Document means a machine-readable copy,
115      represented in a format whose specification is available to the
116      general public, that is suitable for revising the document
117      straightforwardly with generic text editors or (for images composed
118      of pixels) generic paint programs or (for drawings) some widely
119      available drawing editor, and that is suitable for input to text
120      formatters or for automatic translation to a variety of formats
121      suitable for input to text formatters.  A copy made in an otherwise
122      Transparent file format whose markup, or absence of markup, has
123      been arranged to thwart or discourage subsequent modification by
124      readers is not Transparent.  An image format is not Transparent if
125      used for any substantial amount of text.  A copy that is not
126      “Transparent” is called “Opaque”.
127
128      Examples of suitable formats for Transparent copies include plain
129      ASCII without markup, Texinfo input format, LaTeX input format,
130      SGML or XML using a publicly available DTD, and standard-conforming
131      simple HTML, PostScript or PDF designed for human modification.
132      Examples of transparent image formats include PNG, XCF and JPG.
133      Opaque formats include proprietary formats that can be read and
134      edited only by proprietary word processors, SGML or XML for which
135      the DTD and/or processing tools are not generally available, and
136      the machine-generated HTML, PostScript or PDF produced by some word
137      processors for output purposes only.
138
139      The “Title Page” means, for a printed book, the title page itself,
140      plus such following pages as are needed to hold, legibly, the
141      material this License requires to appear in the title page.  For
142      works in formats which do not have any title page as such, “Title
143      Page” means the text near the most prominent appearance of the
144      work’s title, preceding the beginning of the body of the text.
145
146      The “publisher” means any person or entity that distributes copies
147      of the Document to the public.
148
149      A section “Entitled XYZ” means a named subunit of the Document
150      whose title either is precisely XYZ or contains XYZ in parentheses
151      following text that translates XYZ in another language.  (Here XYZ
152      stands for a specific section name mentioned below, such as
153      “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.)
154      To “Preserve the Title” of such a section when you modify the
155      Document means that it remains a section “Entitled XYZ” according
156      to this definition.
157
158      The Document may include Warranty Disclaimers next to the notice
159      which states that this License applies to the Document.  These
160      Warranty Disclaimers are considered to be included by reference in
161      this License, but only as regards disclaiming warranties: any other
162      implication that these Warranty Disclaimers may have is void and
163      has no effect on the meaning of this License.
164
165   2. VERBATIM COPYING
166
167      You may copy and distribute the Document in any medium, either
168      commercially or noncommercially, provided that this License, the
169      copyright notices, and the license notice saying this License
170      applies to the Document are reproduced in all copies, and that you
171      add no other conditions whatsoever to those of this License.  You
172      may not use technical measures to obstruct or control the reading
173      or further copying of the copies you make or distribute.  However,
174      you may accept compensation in exchange for copies.  If you
175      distribute a large enough number of copies you must also follow the
176      conditions in section 3.
177
178      You may also lend copies, under the same conditions stated above,
179      and you may publicly display copies.
180
181   3. COPYING IN QUANTITY
182
183      If you publish printed copies (or copies in media that commonly
184      have printed covers) of the Document, numbering more than 100, and
185      the Document’s license notice requires Cover Texts, you must
186      enclose the copies in covers that carry, clearly and legibly, all
187      these Cover Texts: Front-Cover Texts on the front cover, and
188      Back-Cover Texts on the back cover.  Both covers must also clearly
189      and legibly identify you as the publisher of these copies.  The
190      front cover must present the full title with all words of the title
191      equally prominent and visible.  You may add other material on the
192      covers in addition.  Copying with changes limited to the covers, as
193      long as they preserve the title of the Document and satisfy these
194      conditions, can be treated as verbatim copying in other respects.
195
196      If the required texts for either cover are too voluminous to fit
197      legibly, you should put the first ones listed (as many as fit
198      reasonably) on the actual cover, and continue the rest onto
199      adjacent pages.
200
201      If you publish or distribute Opaque copies of the Document
202      numbering more than 100, you must either include a machine-readable
203      Transparent copy along with each Opaque copy, or state in or with
204      each Opaque copy a computer-network location from which the general
205      network-using public has access to download using public-standard
206      network protocols a complete Transparent copy of the Document, free
207      of added material.  If you use the latter option, you must take
208      reasonably prudent steps, when you begin distribution of Opaque
209      copies in quantity, to ensure that this Transparent copy will
210      remain thus accessible at the stated location until at least one
211      year after the last time you distribute an Opaque copy (directly or
212      through your agents or retailers) of that edition to the public.
213
214      It is requested, but not required, that you contact the authors of
215      the Document well before redistributing any large number of copies,
216      to give them a chance to provide you with an updated version of the
217      Document.
218
219   4. MODIFICATIONS
220
221      You may copy and distribute a Modified Version of the Document
222      under the conditions of sections 2 and 3 above, provided that you
223      release the Modified Version under precisely this License, with the
224      Modified Version filling the role of the Document, thus licensing
225      distribution and modification of the Modified Version to whoever
226      possesses a copy of it.  In addition, you must do these things in
227      the Modified Version:
228
229        A. Use in the Title Page (and on the covers, if any) a title
230           distinct from that of the Document, and from those of previous
231           versions (which should, if there were any, be listed in the
232           History section of the Document).  You may use the same title
233           as a previous version if the original publisher of that
234           version gives permission.
235
236        B. List on the Title Page, as authors, one or more persons or
237           entities responsible for authorship of the modifications in
238           the Modified Version, together with at least five of the
239           principal authors of the Document (all of its principal
240           authors, if it has fewer than five), unless they release you
241           from this requirement.
242
243        C. State on the Title page the name of the publisher of the
244           Modified Version, as the publisher.
245
246        D. Preserve all the copyright notices of the Document.
247
248        E. Add an appropriate copyright notice for your modifications
249           adjacent to the other copyright notices.
250
251        F. Include, immediately after the copyright notices, a license
252           notice giving the public permission to use the Modified
253           Version under the terms of this License, in the form shown in
254           the Addendum below.
255
256        G. Preserve in that license notice the full lists of Invariant
257           Sections and required Cover Texts given in the Document’s
258           license notice.
259
260        H. Include an unaltered copy of this License.
261
262        I. Preserve the section Entitled “History”, Preserve its Title,
263           and add to it an item stating at least the title, year, new
264           authors, and publisher of the Modified Version as given on the
265           Title Page.  If there is no section Entitled “History” in the
266           Document, create one stating the title, year, authors, and
267           publisher of the Document as given on its Title Page, then add
268           an item describing the Modified Version as stated in the
269           previous sentence.
270
271        J. Preserve the network location, if any, given in the Document
272           for public access to a Transparent copy of the Document, and
273           likewise the network locations given in the Document for
274           previous versions it was based on.  These may be placed in the
275           “History” section.  You may omit a network location for a work
276           that was published at least four years before the Document
277           itself, or if the original publisher of the version it refers
278           to gives permission.
279
280        K. For any section Entitled “Acknowledgements” or “Dedications”,
281           Preserve the Title of the section, and preserve in the section
282           all the substance and tone of each of the contributor
283           acknowledgements and/or dedications given therein.
284
285        L. Preserve all the Invariant Sections of the Document, unaltered
286           in their text and in their titles.  Section numbers or the
287           equivalent are not considered part of the section titles.
288
289        M. Delete any section Entitled “Endorsements”.  Such a section
290           may not be included in the Modified Version.
291
292        N. Do not retitle any existing section to be Entitled
293           “Endorsements” or to conflict in title with any Invariant
294           Section.
295
296        O. Preserve any Warranty Disclaimers.
297
298      If the Modified Version includes new front-matter sections or
299      appendices that qualify as Secondary Sections and contain no
300      material copied from the Document, you may at your option designate
301      some or all of these sections as invariant.  To do this, add their
302      titles to the list of Invariant Sections in the Modified Version’s
303      license notice.  These titles must be distinct from any other
304      section titles.
305
306      You may add a section Entitled “Endorsements”, provided it contains
307      nothing but endorsements of your Modified Version by various
308      parties—for example, statements of peer review or that the text has
309      been approved by an organization as the authoritative definition of
310      a standard.
311
312      You may add a passage of up to five words as a Front-Cover Text,
313      and a passage of up to 25 words as a Back-Cover Text, to the end of
314      the list of Cover Texts in the Modified Version.  Only one passage
315      of Front-Cover Text and one of Back-Cover Text may be added by (or
316      through arrangements made by) any one entity.  If the Document
317      already includes a cover text for the same cover, previously added
318      by you or by arrangement made by the same entity you are acting on
319      behalf of, you may not add another; but you may replace the old
320      one, on explicit permission from the previous publisher that added
321      the old one.
322
323      The author(s) and publisher(s) of the Document do not by this
324      License give permission to use their names for publicity for or to
325      assert or imply endorsement of any Modified Version.
326
327   5. COMBINING DOCUMENTS
328
329      You may combine the Document with other documents released under
330      this License, under the terms defined in section 4 above for
331      modified versions, provided that you include in the combination all
332      of the Invariant Sections of all of the original documents,
333      unmodified, and list them all as Invariant Sections of your
334      combined work in its license notice, and that you preserve all
335      their Warranty Disclaimers.
336
337      The combined work need only contain one copy of this License, and
338      multiple identical Invariant Sections may be replaced with a single
339      copy.  If there are multiple Invariant Sections with the same name
340      but different contents, make the title of each such section unique
341      by adding at the end of it, in parentheses, the name of the
342      original author or publisher of that section if known, or else a
343      unique number.  Make the same adjustment to the section titles in
344      the list of Invariant Sections in the license notice of the
345      combined work.
346
347      In the combination, you must combine any sections Entitled
348      “History” in the various original documents, forming one section
349      Entitled “History”; likewise combine any sections Entitled
350      “Acknowledgements”, and any sections Entitled “Dedications”.  You
351      must delete all sections Entitled “Endorsements.”
352
353   6. COLLECTIONS OF DOCUMENTS
354
355      You may make a collection consisting of the Document and other
356      documents released under this License, and replace the individual
357      copies of this License in the various documents with a single copy
358      that is included in the collection, provided that you follow the
359      rules of this License for verbatim copying of each of the documents
360      in all other respects.
361
362      You may extract a single document from such a collection, and
363      distribute it individually under this License, provided you insert
364      a copy of this License into the extracted document, and follow this
365      License in all other respects regarding verbatim copying of that
366      document.
367
368   7. AGGREGATION WITH INDEPENDENT WORKS
369
370      A compilation of the Document or its derivatives with other
371      separate and independent documents or works, in or on a volume of a
372      storage or distribution medium, is called an “aggregate” if the
373      copyright resulting from the compilation is not used to limit the
374      legal rights of the compilation’s users beyond what the individual
375      works permit.  When the Document is included in an aggregate, this
376      License does not apply to the other works in the aggregate which
377      are not themselves derivative works of the Document.
378
379      If the Cover Text requirement of section 3 is applicable to these
380      copies of the Document, then if the Document is less than one half
381      of the entire aggregate, the Document’s Cover Texts may be placed
382      on covers that bracket the Document within the aggregate, or the
383      electronic equivalent of covers if the Document is in electronic
384      form.  Otherwise they must appear on printed covers that bracket
385      the whole aggregate.
386
387   8. TRANSLATION
388
389      Translation is considered a kind of modification, so you may
390      distribute translations of the Document under the terms of section
391      4.  Replacing Invariant Sections with translations requires special
392      permission from their copyright holders, but you may include
393      translations of some or all Invariant Sections in addition to the
394      original versions of these Invariant Sections.  You may include a
395      translation of this License, and all the license notices in the
396      Document, and any Warranty Disclaimers, provided that you also
397      include the original English version of this License and the
398      original versions of those notices and disclaimers.  In case of a
399      disagreement between the translation and the original version of
400      this License or a notice or disclaimer, the original version will
401      prevail.
402
403      If a section in the Document is Entitled “Acknowledgements”,
404      “Dedications”, or “History”, the requirement (section 4) to
405      Preserve its Title (section 1) will typically require changing the
406      actual title.
407
408   9. TERMINATION
409
410      You may not copy, modify, sublicense, or distribute the Document
411      except as expressly provided under this License.  Any attempt
412      otherwise to copy, modify, sublicense, or distribute it is void,
413      and will automatically terminate your rights under this License.
414
415      However, if you cease all violation of this License, then your
416      license from a particular copyright holder is reinstated (a)
417      provisionally, unless and until the copyright holder explicitly and
418      finally terminates your license, and (b) permanently, if the
419      copyright holder fails to notify you of the violation by some
420      reasonable means prior to 60 days after the cessation.
421
422      Moreover, your license from a particular copyright holder is
423      reinstated permanently if the copyright holder notifies you of the
424      violation by some reasonable means, this is the first time you have
425      received notice of violation of this License (for any work) from
426      that copyright holder, and you cure the violation prior to 30 days
427      after your receipt of the notice.
428
429      Termination of your rights under this section does not terminate
430      the licenses of parties who have received copies or rights from you
431      under this License.  If your rights have been terminated and not
432      permanently reinstated, receipt of a copy of some or all of the
433      same material does not give you any rights to use it.
434
435   10. FUTURE REVISIONS OF THIS LICENSE
436
437      The Free Software Foundation may publish new, revised versions of
438      the GNU Free Documentation License from time to time.  Such new
439      versions will be similar in spirit to the present version, but may
440      differ in detail to address new problems or concerns.  See
441      <https://www.gnu.org/licenses/>.
442
443      Each version of the License is given a distinguishing version
444      number.  If the Document specifies that a particular numbered
445      version of this License “or any later version” applies to it, you
446      have the option of following the terms and conditions either of
447      that specified version or of any later version that has been
448      published (not as a draft) by the Free Software Foundation.  If the
449      Document does not specify a version number of this License, you may
450      choose any version ever published (not as a draft) by the Free
451      Software Foundation.  If the Document specifies that a proxy can
452      decide which future versions of this License can be used, that
453      proxy’s public statement of acceptance of a version permanently
454      authorizes you to choose that version for the Document.
455
456   11. RELICENSING
457
458      “Massive Multiauthor Collaboration Site” (or “MMC Site”) means any
459      World Wide Web server that publishes copyrightable works and also
460      provides prominent facilities for anybody to edit those works.  A
461      public wiki that anybody can edit is an example of such a server.
462      A “Massive Multiauthor Collaboration” (or “MMC”) contained in the
463      site means any set of copyrightable works thus published on the MMC
464      site.
465
466      “CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0
467      license published by Creative Commons Corporation, a not-for-profit
468      corporation with a principal place of business in San Francisco,
469      California, as well as future copyleft versions of that license
470      published by that same organization.
471
472      “Incorporate” means to publish or republish a Document, in whole or
473      in part, as part of another Document.
474
475      An MMC is “eligible for relicensing” if it is licensed under this
476      License, and if all works that were first published under this
477      License somewhere other than this MMC, and subsequently
478      incorporated in whole or in part into the MMC, (1) had no cover
479      texts or invariant sections, and (2) were thus incorporated prior
480      to November 1, 2008.
481
482      The operator of an MMC Site may republish an MMC contained in the
483      site under CC-BY-SA on the same site at any time before August 1,
484      2009, provided the MMC is eligible for relicensing.
485
486 ADDENDUM: How to use this License for your documents
487 ====================================================
488
489 To use this License in a document you have written, include a copy of
490 the License in the document and put the following copyright and license
491 notices just after the title page:
492
493        Copyright (C)  YEAR  YOUR NAME.
494        Permission is granted to copy, distribute and/or modify this document
495        under the terms of the GNU Free Documentation License, Version 1.3
496        or any later version published by the Free Software Foundation;
497        with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
498        Texts.  A copy of the license is included in the section entitled ``GNU
499        Free Documentation License''.
500
501    If you have Invariant Sections, Front-Cover Texts and Back-Cover
502 Texts, replace the “with...Texts.” line with this:
503
504          with the Invariant Sections being LIST THEIR TITLES, with
505          the Front-Cover Texts being LIST, and with the Back-Cover Texts
506          being LIST.
507
508    If you have Invariant Sections without Cover Texts, or some other
509 combination of the three, merge those two alternatives to suit the
510 situation.
511
512    If your document contains nontrivial examples of program code, we
513 recommend releasing these examples in parallel under your choice of free
514 software license, such as the GNU General Public License, to permit
515 their use in free software.
516
517 \1f
518 File: m4.info,  Node: Indices,  Prev: Copying This Manual,  Up: Top
519
520 Appendix C Indices of concepts and macros
521 *****************************************
522
523 * Menu:
524
525 * Macro index::                 Index for all ‘m4’ macros
526 * Concept index::               Index for many concepts
527
528 \1f
529 File: m4.info,  Node: Macro index,  Next: Concept index,  Up: Indices
530
531 C.1 Index for all ‘m4’ macros
532 =============================
533
534 This index covers all ‘m4’ builtins, as well as several useful composite
535 macros.  References are exclusively to the places where a macro is
536 introduced the first time.
537
538 \0\b[index\0\b]
539 * Menu:
540
541 * __file__:                              Location.            (line   9)
542 * __gnu__:                               Platform macros.     (line  11)
543 * __line__:                              Location.            (line  10)
544 * __os2__:                               Platform macros.     (line  12)
545 * __program__:                           Location.            (line  11)
546 * __unix__:                              Platform macros.     (line  14)
547 * __windows__:                           Platform macros.     (line  16)
548 * argn:                                  Shift.               (line 256)
549 * array:                                 Define.              (line  55)
550 * array_set:                             Define.              (line  56)
551 * builtin:                               Builtin.             (line   8)
552 * capitalize:                            Patsubst.            (line  54)
553 * changecom:                             Changecom.           (line   9)
554 * changequote:                           Changequote.         (line   9)
555 * changeword:                            Changeword.          (line  22)
556 * cleardivert:                           Cleardivert.         (line  25)
557 * cond:                                  Shift.               (line  51)
558 * copy:                                  Composition.         (line 119)
559 * curry:                                 Composition.         (line  67)
560 * debugfile:                             Debug Output.        (line  10)
561 * debugmode:                             Debug Levels.        (line  77)
562 * decr:                                  Incr.                (line  10)
563 * define:                                Define.              (line   9)
564 * define_blind:                          Composition.         (line  10)
565 * defn:                                  Defn.                (line   9)
566 * divert:                                Divert.              (line   8)
567 * divnum:                                Divnum.              (line   8)
568 * dnl:                                   Dnl.                 (line   8)
569 * downcase:                              Patsubst.            (line  53)
570 * dquote:                                Shift.               (line 194)
571 * dquote_elt:                            Shift.               (line 195)
572 * dumpdef:                               Dumpdef.             (line   9)
573 * errprint:                              Errprint.            (line   8)
574 * esyscmd:                               Esyscmd.             (line   8)
575 * eval:                                  Eval.                (line   8)
576 * example:                               Manual.              (line  39)
577 * exch:                                  Arguments.           (line  12)
578 * fatal_error:                           M4exit.              (line  24)
579 * foreach:                               Foreach.             (line   8)
580 * foreachq:                              Foreach.             (line   9)
581 * forloop:                               Forloop.             (line   8)
582 * format:                                Format.              (line   8)
583 * ifdef:                                 Ifdef.               (line   9)
584 * ifelse:                                Ifelse.              (line  10)
585 * ifelse <1>:                            Ifelse.              (line  11)
586 * ifelse <2>:                            Ifelse.              (line  12)
587 * include:                               Include.             (line   8)
588 * incr:                                  Incr.                (line   9)
589 * index:                                 Index macro.         (line   8)
590 * indir:                                 Indir.               (line   8)
591 * join:                                  Shift.               (line 102)
592 * joinall:                               Shift.               (line 103)
593 * len:                                   Len.                 (line   8)
594 * m4exit:                                M4exit.              (line   9)
595 * m4wrap:                                M4wrap.              (line  13)
596 * maketemp:                              Mkstemp.             (line  11)
597 * mkstemp:                               Mkstemp.             (line  10)
598 * nargs:                                 Pseudo Arguments.    (line  12)
599 * os2:                                   Platform macros.     (line  13)
600 * patsubst:                              Patsubst.            (line   8)
601 * popdef:                                Pushdef.             (line  11)
602 * pushdef:                               Pushdef.             (line  10)
603 * quote:                                 Shift.               (line 193)
604 * regexp:                                Regexp.              (line   8)
605 * rename:                                Composition.         (line 120)
606 * reverse:                               Shift.               (line  31)
607 * shift:                                 Shift.               (line  16)
608 * sinclude:                              Include.             (line   9)
609 * stack_foreach:                         Stacks.              (line  11)
610 * stack_foreach_lifo:                    Stacks.              (line  12)
611 * stack_foreach_sep:                     Improved copy.       (line  15)
612 * stack_foreach_sep_lifo:                Improved copy.       (line  16)
613 * substr:                                Substr.              (line   8)
614 * syscmd:                                Syscmd.              (line   8)
615 * sysval:                                Sysval.              (line   8)
616 * traceoff:                              Trace.               (line  10)
617 * traceon:                               Trace.               (line   9)
618 * translit:                              Translit.            (line   8)
619 * undefine:                              Undefine.            (line   8)
620 * undivert:                              Undivert.            (line   8)
621 * unix:                                  Platform macros.     (line  15)
622 * upcase:                                Patsubst.            (line  52)
623 * windows:                               Platform macros.     (line  17)
624
625 \1f
626 File: m4.info,  Node: Concept index,  Prev: Macro index,  Up: Indices
627
628 C.2 Index for many concepts
629 ===========================
630
631 \0\b[index\0\b]
632 * Menu:
633
634 * argument currying:                     Composition.         (line  63)
635 * arguments to macros:                   Macro Arguments.     (line   6)
636 * arguments to macros <1>:               Arguments.           (line   6)
637 * arguments to macros, special:          Pseudo Arguments.    (line   6)
638 * arguments, joining:                    Shift.               (line  99)
639 * arguments, more than nine:             Arguments.           (line  54)
640 * arguments, more than nine <1>:         Shift.               (line 251)
641 * arguments, more than nine <2>:         Improved foreach.    (line 157)
642 * arguments, quoted macro:               Quoting Arguments.   (line   6)
643 * arguments, reversing:                  Shift.               (line  31)
644 * arithmetic:                            Arithmetic.          (line   6)
645 * arrays:                                Define.              (line  52)
646 * avoiding quadratic behavior:           Improved foreach.    (line  38)
647 * basic regular expressions:             Regexp.              (line   6)
648 * basic regular expressions <1>:         Patsubst.            (line   6)
649 * blind macro:                           Inhibiting Invocation.
650                                                               (line  13)
651 * blind macro <1>:                       Ifelse.              (line  52)
652 * blind macro <2>:                       Composition.         (line  10)
653 * bug reports:                           Bugs.                (line   6)
654 * builtins, indirect call of:            Builtin.             (line   6)
655 * builtins, special tokens:              Defn.                (line 101)
656 * call of builtins, indirect:            Builtin.             (line   6)
657 * call of macros, indirect:              Indir.               (line   6)
658 * case statement:                        Ifelse.              (line  69)
659 * changing comment delimiters:           Changecom.           (line   6)
660 * changing quote delimiters:             Changequote.         (line   6)
661 * changing syntax:                       Changeword.          (line   6)
662 * characters, translating:               Translit.            (line   6)
663 * command line:                          Invoking m4.         (line   6)
664 * command line, file names on the:       Command line files.  (line   6)
665 * command line, macro definitions on the: Preprocessor features.
666                                                               (line   6)
667 * command line, options:                 Invoking m4.         (line  10)
668 * commands, exit status from shell:      Sysval.              (line   6)
669 * commands, running shell:               Shell commands.      (line   6)
670 * comment delimiters, changing:          Changecom.           (line   6)
671 * comments:                              Comments.            (line   6)
672 * comments, copied to output:            Changecom.           (line  29)
673 * comparing strings:                     Ifelse.              (line   6)
674 * compatibility:                         Compatibility.       (line   6)
675 * composing macros:                      Composition.         (line   6)
676 * concatenating arguments:               Shift.               (line  99)
677 * conditional, short-circuiting:         Shift.               (line  51)
678 * conditionals:                          Ifdef.               (line   6)
679 * controlling debugging output:          Debug Levels.        (line   6)
680 * copying macros:                        Composition.         (line 116)
681 * counting loops:                        Forloop.             (line   6)
682 * currying arguments:                    Composition.         (line  63)
683 * debugging macros:                      Debugging.           (line   6)
684 * debugging output, controlling:         Debug Levels.        (line   6)
685 * debugging output, saving:              Debug Output.        (line   6)
686 * decrement operator:                    Incr.                (line   6)
687 * deferring expansion:                   M4wrap.              (line   6)
688 * deferring output:                      Diversions.          (line   6)
689 * defining new macros:                   Definitions.         (line   6)
690 * definition stack:                      Pushdef.             (line   6)
691 * definition stack <1>:                  Stacks.              (line   6)
692 * definitions, displaying macro:         Defn.                (line   6)
693 * definitions, displaying macro <1>:     Dumpdef.             (line   6)
694 * deleting macros:                       Undefine.            (line   6)
695 * deleting whitespace in input:          Dnl.                 (line   6)
696 * delimiters, changing:                  Changequote.         (line   6)
697 * delimiters, changing <1>:              Changecom.           (line   6)
698 * discarding diverted text:              Cleardivert.         (line   6)
699 * discarding input:                      Ifelse.              (line   6)
700 * discarding input <1>:                  Dnl.                 (line   6)
701 * discarding input <2>:                  Divert.              (line  42)
702 * displaying macro definitions:          Dumpdef.             (line   6)
703 * diversion numbers:                     Divnum.              (line   6)
704 * diverted text, discarding:             Cleardivert.         (line   6)
705 * diverting output to files:             Divert.              (line   6)
706 * dumping into frozen file:              Using frozen files.  (line   6)
707 * error messages, printing:              Errprint.            (line   6)
708 * errors, fatal:                         Operation modes.     (line  19)
709 * evaluation, of integer expressions:    Eval.                (line   6)
710 * examples, understanding:               Manual.              (line   6)
711 * executing shell commands:              Shell commands.      (line   6)
712 * exit status from shell commands:       Sysval.              (line   6)
713 * exiting from m4:                       M4exit.              (line   6)
714 * expansion of macros:                   Macro expansion.     (line   6)
715 * expansion, deferring:                  M4wrap.              (line   6)
716 * expansion, tracing macro:              Trace.               (line   6)
717 * expressions, evaluation of integer:    Eval.                (line   6)
718 * expressions, regular:                  Regexp.              (line   6)
719 * expressions, regular <1>:              Patsubst.            (line   6)
720 * extracting substrings:                 Substr.              (line   6)
721 * fast loading of frozen files:          Using frozen files.  (line   6)
722 * fatal errors:                          Operation modes.     (line  19)
723 * FDL, GNU Free Documentation License:   GNU Free Documentation License.
724                                                               (line   6)
725 * file format, frozen file:              Frozen file format.  (line   6)
726 * file inclusion:                        File Inclusion.      (line   6)
727 * file inclusion <1>:                    Undivert.            (line  13)
728 * file inclusion <2>:                    Undivert.            (line  89)
729 * file names, on the command line:       Command line files.  (line   6)
730 * files, diverting output to:            Divert.              (line   6)
731 * files, names of temporary:             Mkstemp.             (line   6)
732 * for each loops:                        Foreach.             (line   6)
733 * for loops:                             Forloop.             (line   6)
734 * formatted output:                      Format.              (line   6)
735 * Free Documentation License (FDL), GNU: GNU Free Documentation License.
736                                                               (line   6)
737 * frozen file format:                    Frozen file format.  (line   6)
738 * frozen files for fast loading:         Using frozen files.  (line   6)
739 * General Public License (GPL), GNU:     GNU General Public License.
740                                                               (line   6)
741 * GNU extensions:                        Inhibiting Invocation.
742                                                               (line  13)
743 * GNU extensions <1>:                    Define.              (line  41)
744 * GNU extensions <2>:                    Arguments.           (line  54)
745 * GNU extensions <3>:                    Indir.               (line   6)
746 * GNU extensions <4>:                    Builtin.             (line   6)
747 * GNU extensions <5>:                    Debug Levels.        (line  74)
748 * GNU extensions <6>:                    Debug Output.        (line   6)
749 * GNU extensions <7>:                    Search Path.         (line   6)
750 * GNU extensions <8>:                    Divert.              (line  54)
751 * GNU extensions <9>:                    Undivert.            (line  13)
752 * GNU extensions <10>:                   Undivert.            (line  89)
753 * GNU extensions <11>:                   Regexp.              (line   6)
754 * GNU extensions <12>:                   Patsubst.            (line   6)
755 * GNU extensions <13>:                   Format.              (line   6)
756 * GNU extensions <14>:                   Eval.                (line 113)
757 * GNU extensions <15>:                   Esyscmd.             (line   6)
758 * GNU extensions <16>:                   Mkstemp.             (line  58)
759 * GNU extensions <17>:                   Using frozen files.  (line   6)
760 * GNU extensions <18>:                   Extensions.          (line   6)
761 * GNU Free Documentation License:        GNU Free Documentation License.
762                                                               (line   6)
763 * GNU General Public License:            GNU General Public License.
764                                                               (line   6)
765 * GNU M4, history of:                    History.             (line   6)
766 * GPL, GNU General Public License:       GNU General Public License.
767                                                               (line   6)
768 * history of m4:                         History.             (line   6)
769 * included files, search path for:       Search Path.         (line   6)
770 * inclusion, of files:                   File Inclusion.      (line   6)
771 * inclusion, of files <1>:               Undivert.            (line  13)
772 * inclusion, of files <2>:               Undivert.            (line  89)
773 * increment operator:                    Incr.                (line   6)
774 * indirect call of builtins:             Builtin.             (line   6)
775 * indirect call of macros:               Indir.               (line   6)
776 * initialization, frozen state:          Using frozen files.  (line   6)
777 * input location:                        Preprocessor features.
778                                                               (line  28)
779 * input location <1>:                    Location.            (line   6)
780 * input tokens:                          Syntax.              (line   6)
781 * input, discarding:                     Ifelse.              (line   6)
782 * input, discarding <1>:                 Dnl.                 (line   6)
783 * input, discarding <2>:                 Divert.              (line  42)
784 * input, saving:                         M4wrap.              (line   6)
785 * integer arithmetic:                    Arithmetic.          (line   6)
786 * integer expression evaluation:         Eval.                (line   6)
787 * invoking m4:                           Invoking m4.         (line   6)
788 * invoking macros:                       Invocation.          (line   6)
789 * iterating over lists:                  Foreach.             (line   6)
790 * joining arguments:                     Shift.               (line  99)
791 * length of strings:                     Len.                 (line   6)
792 * lexical structure of words:            Changeword.          (line   6)
793 * License, code:                         Copying This Package.
794                                                               (line   6)
795 * License, manual:                       Copying This Manual. (line   6)
796 * limit, nesting:                        Limits control.      (line  43)
797 * literal output:                        Pseudo Arguments.    (line 106)
798 * local variables:                       Pushdef.             (line  79)
799 * location, input:                       Preprocessor features.
800                                                               (line  28)
801 * location, input <1>:                   Location.            (line   6)
802 * loops:                                 Shift.               (line  10)
803 * loops, counting:                       Forloop.             (line   6)
804 * loops, list iteration:                 Foreach.             (line   6)
805 * M4PATH:                                Search Path.         (line   9)
806 * macro composition:                     Composition.         (line   6)
807 * macro definitions, on the command line: Preprocessor features.
808                                                               (line   6)
809 * macro expansion, tracing:              Trace.               (line   6)
810 * macro invocation:                      Invocation.          (line   6)
811 * macro, blind:                          Inhibiting Invocation.
812                                                               (line  13)
813 * macro, blind <1>:                      Ifelse.              (line  52)
814 * macro, blind <2>:                      Composition.         (line  10)
815 * macros, arguments to:                  Macro Arguments.     (line   6)
816 * macros, arguments to <1>:              Arguments.           (line   6)
817 * macros, copying:                       Composition.         (line 116)
818 * macros, debugging:                     Debugging.           (line   6)
819 * macros, displaying definitions:        Defn.                (line   6)
820 * macros, displaying definitions <1>:    Dumpdef.             (line   6)
821 * macros, expansion of:                  Macro expansion.     (line   6)
822 * macros, how to define new:             Definitions.         (line   6)
823 * macros, how to delete:                 Undefine.            (line   6)
824 * macros, how to rename:                 Defn.                (line   6)
825 * macros, indirect call of:              Indir.               (line   6)
826 * macros, quoted arguments to:           Quoting Arguments.   (line   6)
827 * macros, recursive:                     Shift.               (line   6)
828 * macros, special arguments to:          Pseudo Arguments.    (line   6)
829 * macros, temporary redefinition of:     Pushdef.             (line   6)
830 * manipulating quotes:                   Shift.               (line 190)
831 * messages, printing error:              Errprint.            (line   6)
832 * more than nine arguments:              Arguments.           (line  54)
833 * more than nine arguments <1>:          Shift.               (line 251)
834 * more than nine arguments <2>:          Improved foreach.    (line 157)
835 * multibranches:                         Ifelse.              (line  69)
836 * names:                                 Names.               (line   6)
837 * nesting limit:                         Limits control.      (line  43)
838 * nine arguments, more than:             Arguments.           (line  54)
839 * nine arguments, more than <1>:         Shift.               (line 251)
840 * nine arguments, more than <2>:         Improved foreach.    (line 157)
841 * numbers:                               Manual.              (line  57)
842 * options, command line:                 Invoking m4.         (line  10)
843 * output, diverting to files:            Divert.              (line   6)
844 * output, formatted:                     Format.              (line   6)
845 * output, literal:                       Pseudo Arguments.    (line 106)
846 * output, saving debugging:              Debug Output.        (line   6)
847 * overview of m4:                        Intro.               (line   6)
848 * pattern substitution:                  Patsubst.            (line   6)
849 * platform macros:                       Platform macros.     (line   6)
850 * positional parameters, more than nine: Arguments.           (line  54)
851 * POSIX:                                 Extensions.          (line   6)
852 * POSIXLY_CORRECT:                       Invoking m4.         (line  10)
853 * POSIXLY_CORRECT <1>:                   Incompatibilities.   (line 144)
854 * preprocessor features:                 Preprocessor features.
855                                                               (line   6)
856 * printing error messages:               Errprint.            (line   6)
857 * pushdef stack:                         Pushdef.             (line   6)
858 * pushdef stack <1>:                     Stacks.              (line   6)
859 * quadratic behavior, avoiding:          Improved foreach.    (line  38)
860 * quote delimiters, changing:            Changequote.         (line   6)
861 * quote manipulation:                    Shift.               (line 190)
862 * quoted macro arguments:                Quoting Arguments.   (line   6)
863 * quoted string:                         Quoted strings.      (line   6)
864 * quoting rule of thumb:                 Quoting Arguments.   (line  22)
865 * recursive macros:                      Shift.               (line   6)
866 * redefinition of macros, temporary:     Pushdef.             (line   6)
867 * regular expressions:                   Changeword.          (line   6)
868 * regular expressions <1>:               Regexp.              (line   6)
869 * regular expressions <2>:               Patsubst.            (line   6)
870 * reloading a frozen file:               Using frozen files.  (line   6)
871 * renaming macros:                       Defn.                (line   6)
872 * renaming macros <1>:                   Composition.         (line 116)
873 * reporting bugs:                        Bugs.                (line   6)
874 * rescanning:                            Limits control.      (line  56)
875 * rescanning <1>:                        Inhibiting Invocation.
876                                                               (line  86)
877 * rescanning <2>:                        Pseudo Arguments.    (line 106)
878 * rescanning <3>:                        Defn.                (line  61)
879 * rescanning <4>:                        Other Incompatibilities.
880                                                               (line  52)
881 * reversing arguments:                   Shift.               (line  31)
882 * rule of thumb, quoting:                Quoting Arguments.   (line  22)
883 * running shell commands:                Shell commands.      (line   6)
884 * saving debugging output:               Debug Output.        (line   6)
885 * saving input:                          M4wrap.              (line   6)
886 * search path for included files:        Search Path.         (line   6)
887 * shell commands, exit status from:      Sysval.              (line   6)
888 * shell commands, running:               Shell commands.      (line   6)
889 * short-circuiting conditional:          Shift.               (line  51)
890 * special arguments to macros:           Pseudo Arguments.    (line   6)
891 * stack, macro definition:               Pushdef.             (line   6)
892 * stack, macro definition <1>:           Stacks.              (line   6)
893 * standard error, output to:             Dumpdef.             (line   6)
894 * standard error, output to <1>:         Trace.               (line   6)
895 * standard error, output to <2>:         Errprint.            (line   6)
896 * status of shell commands:              Sysval.              (line   6)
897 * status, setting m4 exit:               M4exit.              (line   6)
898 * string, quoted:                        Quoted strings.      (line   6)
899 * strings, length of:                    Len.                 (line   6)
900 * substitution by regular expression:    Patsubst.            (line   6)
901 * substrings, extracting:                Substr.              (line   6)
902 * substrings, locating:                  Index macro.         (line   6)
903 * suggestions, reporting:                Bugs.                (line   6)
904 * suppressing warnings:                  Macro Arguments.     (line  38)
905 * switch statement:                      Ifelse.              (line  69)
906 * synchronization lines:                 Preprocessor features.
907                                                               (line  28)
908 * syntax, changing:                      Changeword.          (line   6)
909 * temporary file names:                  Mkstemp.             (line   6)
910 * temporary redefinition of macros:      Pushdef.             (line   6)
911 * TMPDIR:                                Diversions.          (line  10)
912 * tokens:                                Syntax.              (line   6)
913 * tokens, builtin macro:                 Defn.                (line 101)
914 * tokens, special:                       Other tokens.        (line   6)
915 * tracing macro expansion:               Trace.               (line   6)
916 * translating characters:                Translit.            (line   6)
917 * undefining macros:                     Undefine.            (line   6)
918 * UNIX commands, exit status from:       Sysval.              (line   6)
919 * UNIX commands, running:                Shell commands.      (line   6)
920 * variables, local:                      Pushdef.             (line  79)
921 * warnings, suppressing:                 Macro Arguments.     (line  38)
922 * words:                                 Names.               (line   6)
923 * words, lexical structure of:           Changeword.          (line   6)
924