m4-doc 1.4.18-1 / usr / share / doc / m4-doc / Cleardivert.html

This file is indexed.

/usr/share/doc/m4-doc/Cleardivert.html is in m4-doc 1.4.18-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- 
This manual (31 December 2016) is for GNU M4 (version
1.4.18), a package containing an implementation of the m4 macro
language.

Copyright (C) 1989-1994, 2004-2014, 2016 Free Software
Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License,
Version 1.3 or any later version published by the Free Software
Foundation; with no Invariant Sections, no Front-Cover Texts, and no
Back-Cover Texts.  A copy of the license is included in the section
entitled "GNU Free Documentation License." -->
<!-- Created by GNU Texinfo 6.3, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU M4 1.4.18 macro processor: Cleardivert</title>

<meta name="description" content="GNU M4 1.4.18 macro processor: Cleardivert">
<meta name="keywords" content="GNU M4 1.4.18 macro processor: Cleardivert">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Indices.html#Indices" rel="index" title="Indices">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Diversions.html#Diversions" rel="up" title="Diversions">
<link href="Text-handling.html#Text-handling" rel="next" title="Text handling">
<link href="Divnum.html#Divnum" rel="prev" title="Divnum">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Cleardivert"></a>
<div class="header">
<p>
Previous: <a href="Divnum.html#Divnum" accesskey="p" rel="prev">Divnum</a>, Up: <a href="Diversions.html#Diversions" accesskey="u" rel="up">Diversions</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Indices.html#Indices" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Discarding-diverted-text"></a>
<h3 class="section">10.4 Discarding diverted text</h3>

<a name="index-discarding-diverted-text"></a>
<a name="index-diverted-text_002c-discarding"></a>
<p>Often it is not known, when output is diverted, whether the diverted
text is actually needed.  Since all non-empty diversion are brought back
on the main output stream when the end of input is seen, a method of
discarding a diversion is needed.  If all diversions should be
discarded, the easiest is to end the input to <code>m4</code> with
&lsquo;<samp>divert(`-1')</samp>&rsquo; followed by an explicit &lsquo;<samp>undivert</samp>&rsquo;:
</p>
<div class="example">
<pre class="example">divert(`1')
Diversion one: divnum
divert(`2')
Diversion two: divnum
divert(`-1')
undivert
^D
</pre></div>

<p>No output is produced at all.
</p>
<p>Clearing selected diversions can be done with the following macro:
</p>
<dl>
<dt><a name="index-cleardivert"></a>Composite: <strong>cleardivert</strong> <em>(<span class="roman">[</span><var>diversions&hellip;</var><span class="roman">]</span>)</em></dt>
<dd><p>Discard the contents of each of the listed numeric <var>diversions</var>.
</p></dd></dl>

<div class="example">
<pre class="example">define(`cleardivert',
`pushdef(`_n', divnum)divert(`-1')undivert($@)divert(_n)popdef(`_n')')
&rArr;
</pre></div>

<p>It is called just like <code>undivert</code>, but the effect is to clear the
diversions, given by the arguments.  (This macro has a nasty bug!  You
should try to see if you can find it and correct it; or see <a href="Improved-cleardivert.html#Improved-cleardivert">Answers</a>).
</p>



</body>
</html>

APT Browse - Built by Thomas Orozco.