autogen-doc 1:5.18.7-3 / usr / share / doc / autogen-doc / autogen.html / output-controls.html

This file is indexed.

/usr/share/doc/autogen-doc/autogen.html/output-controls.html is in autogen-doc 1:5.18.7-3.

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
117
118
119
120
121
122
123
124
125
126
127
128
129
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU AutoGen version 5.18, updated December 2015.

Copyright (C) 1992-2015 by Bruce Korb.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. -->
<!-- Created by GNU Texinfo 6.0, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU AutoGen - The Automated Program Generator: output controls</title>

<meta name="description" content="GNU AutoGen - The Automated Program Generator: output controls">
<meta name="keywords" content="GNU AutoGen - The Automated Program Generator: output controls">
<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="AutoOpts.html#AutoOpts" rel="index" title="AutoOpts">
<link href="Function-Index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Template-File.html#Template-File" rel="up" title="Template File">
<link href="Augmenting-AutoGen.html#Augmenting-AutoGen" rel="next" title="Augmenting AutoGen">
<link href="guile-command.html#guile-command" rel="prev" title="guile command">
<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.nocodebreak {white-space: nowrap}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: serif; 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="output-controls"></a>
<div class="header">
<p>
Previous: <a href="native-macros.html#native-macros" accesskey="p" rel="prev">native macros</a>, Up: <a href="Template-File.html#Template-File" accesskey="u" rel="up">Template File</a> &nbsp; [<a href="Function-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="AutoOpts.html#AutoOpts" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Redirecting-Output"></a>
<h3 class="section">3.7 Redirecting Output</h3>
<a name="index-Redirecting-Output"></a>
<a name="index-diversion"></a>

<p>AutoGen provides a means for redirecting the template output to different
files or, in <samp>M4</samp> parlance, to various diversions.  It is accomplished
by providing a set of Scheme functions named <code>out-*</code>
(see <a href="AutoGen-Functions.html#AutoGen-Functions">AutoGen Functions</a>).
</p>
<dl compact="compact">
<dt>&lsquo;<samp>out-push-new (see <a href="SCM-out_002dpush_002dnew.html#SCM-out_002dpush_002dnew">SCM out-push-new</a>)</samp>&rsquo;</dt>
<dd><p>This allows you to logically &quot;push&quot; output files onto a stack.
If you supply a string name, then a file by that name is created
to hold the output.  If you do not supply a name, then the text is
written to a scratch pad and retrieved by passing a <code>#t</code> argument
to the <code>out-pop</code> (see <a href="SCM-out_002dpop.html#SCM-out_002dpop">SCM out-pop</a>) function.
</p>
</dd>
<dt>&lsquo;<samp>out-pop (see <a href="SCM-out_002dpop.html#SCM-out_002dpop">SCM out-pop</a>)</samp>&rsquo;</dt>
<dd><p>This function closes the current output file and resumes output to the next
one in the stack.  At least one output must have been pushed onto the output
stack with the <code>out-push-new</code> (see <a href="SCM-out_002dpush_002dnew.html#SCM-out_002dpush_002dnew">SCM out-push-new</a>) function.  If
<code>#t</code> is passed in as an argument, then the entire contents of the
diversion (or file) is returned.
</p>
</dd>
<dt>&lsquo;<samp>out-suspend (see <a href="SCM-out_002dsuspend.html#SCM-out_002dsuspend">SCM out-suspend</a>)</samp>&rsquo;</dt>
<dd><p>This function does not close the current output, but instead sets it aside
for resumption by the given name with <code>out-resume</code>.  The current output
must have been pushed on the output queue with <code>out-push-new</code>
(see <a href="SCM-out_002dpush_002dnew.html#SCM-out_002dpush_002dnew">SCM out-push-new</a>).
</p>
</dd>
<dt>&lsquo;<samp>out-resume (see <a href="SCM-out_002dresume.html#SCM-out_002dresume">SCM out-resume</a>)</samp>&rsquo;</dt>
<dd><p>This will put a named file descriptor back onto the top of
stack so that it becomes the current output again.
</p>
</dd>
<dt>&lsquo;<samp>out-switch (see <a href="SCM-out_002dswitch.html#SCM-out_002dswitch">SCM out-switch</a>)</samp>&rsquo;</dt>
<dd><p>This closes the current output and creates a new file,
purging any preexisting one.  This is a shortcut for &quot;pop&quot;
followed by &quot;push&quot;, but this can also be done at the base level.
</p>
</dd>
<dt>&lsquo;<samp>out-move (see <a href="SCM-out_002dmove.html#SCM-out_002dmove">SCM out-move</a>)</samp>&rsquo;</dt>
<dd><p>Renames the current output file without closing it.
</p></dd>
</dl>

<p>There are also several functions for determining the output
status.  See <a href="AutoGen-Functions.html#AutoGen-Functions">AutoGen Functions</a>.
</p>

<hr>
<div class="header">
<p>
Previous: <a href="native-macros.html#native-macros" accesskey="p" rel="prev">native macros</a>, Up: <a href="Template-File.html#Template-File" accesskey="u" rel="up">Template File</a> &nbsp; [<a href="Function-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="AutoOpts.html#AutoOpts" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>

APT Browse - Built by Thomas Orozco.