summaryrefslogtreecommitdiffstats
path: root/doc/groff.html.node/Suppressing-Output.html
blob: bd32161a068ed220661eb7b5f874b1c25f16ae49 (plain)
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.0.3, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<!-- This manual documents GNU troff version 1.23.0.

Copyright � 1994-2023 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". -->
<title>Suppressing Output (The GNU Troff Manual)</title>

<meta name="description" content="Suppressing Output (The GNU Troff Manual)">
<meta name="keywords" content="Suppressing Output (The GNU Troff Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">

<link href="index.html" rel="start" title="Top">
<link href="Request-Index.html" rel="index" title="Request Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="GNU-troff-Reference.html" rel="up" title="GNU troff Reference">
<link href="Colors.html" rel="next" title="Colors">
<link href="Environments.html" rel="prev" title="Environments">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span.r {font-family: initial; font-weight: normal; font-style: normal}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>


</head>

<body lang="en">
<div class="section-level-extent" id="Suppressing-Output">
<div class="nav-panel">
<p>
Next: <a href="Colors.html" accesskey="n" rel="next">Colors</a>, Previous: <a href="Environments.html" accesskey="p" rel="prev">Environments</a>, Up: <a href="GNU-troff-Reference.html" accesskey="u" rel="up">GNU <code class="code">troff</code> Reference</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Request-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h3 class="section" id="Suppressing-Output-1">5.32 Suppressing Output</h3>

<dl class="first-deffn">
<dt class="deffn" id="index-_005cO_005bnum_005d"><span class="category-def">Escape&nbsp;sequence: </span><span><strong class="def-name"><code class="t">\O[</code><span class="r"><i class="slanted">num</i></span><code class="t">]</code></strong><a class="copiable-link" href='#index-_005cO_005bnum_005d'> &para;</a></span></dt>
<dd><a class="index-entry-id" id="index-_005cO"></a>
<a class="index-entry-id" id="index-suppressing-output-_0028_005cO_0029"></a>
<a class="index-entry-id" id="index-output_002c-suppressing-_0028_005cO_0029"></a>
<p>Suppress GNU <code class="code">troff</code> output of glyphs and geometric objects.  The
sequences <code class="code">\O2</code>, <code class="code">\O3</code>, <code class="code">\O4</code>, and <code class="code">\O5</code> are
intended for internal use by <code class="code">grohtml</code>.
</p>
<dl class="table">
<dt>&lsquo;<samp class="samp">\O0</samp>&rsquo;</dt>
<dd><p>Disable the emission of glyphs and geometric objects to the output
driver, provided that this sequence occurs at the outermost suppression
level (see <code class="code">\O3</code> and <code class="code">\04</code> below).  Horizontal motions
corresponding to non-overstruck glyph widths still occur.
</p>
</dd>
<dt>&lsquo;<samp class="samp">\O1</samp>&rsquo;</dt>
<dd><p>Enable the emission of glyphs and geometric objects to the output
driver, provided that this sequence occurs at the outermost suppression
level.
</p></dd>
</dl>

<a class="index-entry-id" id="index-opminx"></a>
<a class="index-entry-id" id="index-opminy"></a>
<a class="index-entry-id" id="index-opmaxx"></a>
<a class="index-entry-id" id="index-opmaxy"></a>
<p><code class="code">\O0</code> and <code class="code">\O1</code> also reset the four registers <code class="code">opminx</code>,
<code class="code">opminy</code>, <code class="code">opmaxx</code>, and <code class="code">opmaxy</code> to &minus;1.  These
four registers mark the top left and bottom right hand corners of a box
encompassing all written or drawn output.
</p>
<dl class="table">
<dt>&lsquo;<samp class="samp">\O2</samp>&rsquo;</dt>
<dd><p>At the outermost suppression level, enable emission of glyphs and
geometric objects, and write to the standard error stream the page
number and values of the four aforementioned registers encompassing
glyphs written since the last interpolation of a <code class="code">\O</code> sequence, as
well as the page offset, line length, image file name (if any),
horizontal and vertical device motion quanta, and input file name.
Numeric values are in basic units.
</p>
</dd>
<dt>&lsquo;<samp class="samp">\O3</samp>&rsquo;</dt>
<dd><p>Begin a nested suppression level.  <code class="command">grohtml</code> uses this mechanism
to create images of output preprocessed with <code class="command">gpic</code>,
<code class="command">geqn</code>, and <code class="command">gtbl</code>.  At startup, GNU <code class="code">troff</code> is at
the outermost suppression level.  <code class="command">pre-grohtml</code> generates these
sequences when processing the document, using GNU <code class="command">troff</code> with
the <code class="code">ps</code> output device, Ghostscript, and the PNM tools to produce
images in PNG format.  They start a new page if the device is not
<code class="code">html</code> or <code class="code">xhtml</code>, to reduce the number of images crossing a
page boundary.
</p>
</dd>
<dt>&lsquo;<samp class="samp">\O4</samp>&rsquo;</dt>
<dd><p>End a nested suppression level.
</p></dd>
</dl>

<dl class="table">
<dt>&lsquo;<samp class="samp">\O[5<var class="var">P</var><var class="var">file</var>]</samp>&rsquo;</dt>
<dd><p>At the outermost suppression level, write the name <code class="code">file</code> to the
standard error stream at position <var class="var">P</var>, which must be one of
<code class="code">l</code>, <code class="code">r</code>, <code class="code">c</code>, or&nbsp;<code class="code">i</code>, corresponding to left,
right, centered, and inline alignments within the document,
respectively.  <var class="var">file</var> is a name associated with the production of
the next image.
</p></dd>
</dl>
</dd></dl>

<dl class="first-deffn">
<dt class="deffn" id="index-_005cn_005b_002eO_005d"><span class="category-def">Register: </span><span><strong class="def-name"><code class="t">\n[.O]</code></strong><a class="copiable-link" href='#index-_005cn_005b_002eO_005d'> &para;</a></span></dt>
<dd><a class="index-entry-id" id="index-_002eO"></a>
<a class="index-entry-id" id="index-suppression-nesting-level-register"></a>
<a class="index-entry-id" id="index-nesting-level_002c-suppression_002c-register"></a>
<a class="index-entry-id" id="index-level_002c-suppression-nesting_002c-register"></a>
<p>Output suppression nesting level applied by <code class="code">\O3</code> and <code class="code">\O4</code>
escape sequences.
</p></dd></dl>



</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Colors.html">Colors</a>, Previous: <a href="Environments.html">Environments</a>, Up: <a href="GNU-troff-Reference.html">GNU <code class="code">troff</code> Reference</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Request-Index.html" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>