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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
<HTML>
<!--
***********************************************************************
FUNNELWEB MANUAL WEB PAGE
=========================
Copyright (c) Ross N. Williams 1992,1999. All rights reserved.
Permission is granted to redistribute and use this manual in
any medium, with or without modification, provided that all
notices (including, without limitation, the copyright
notice, this permission notice, any record of modification,
and all legal notices) are preserved on all copies, that all
modifications are clearly marked, and that modified versions
are not represented as the original version unless all the
modifications since the manual's original release by Ross N.
Williams (www.ross.net) consist of translations or other
transformations that alter only the manual's form, not its
content. THIS MANUAL IS PROVIDED "AS IS" AND WITHOUT ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND
FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT PERMITTED BY
LAW THERE IS ABSOLUTELY NO WARRANTY.
***********************************************************************
-->
<HEAD>
<TITLE>2.3 Options</TITLE>
<STYLE TYPE="text/css"> <!-- A {text-decoration: none} // --> </STYLE>
</HEAD>
<BODY BACKGROUND="binary/background.gif"
BGCOLOR="#FFFFFF"
TEXT="#000000"
VLINK="#660000"
LINK="#FF0000"
ALINK="#CC0000">
<TABLE WIDTH="490">
<TR>
<TD WIDTH="130" VALIGN="top">
<IMG SRC="binary/d_clear.gif" ALT="" WIDTH="130" HEIGHT="1"><BR>
<FONT SIZE="2">
<BR>
<A HREF="http://www.ross.net/"
TARGET="rosshome"
onClick="window.open('','rosshome','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>
<IMG SRC="binary/rossnet_logo.gif"
WIDTH="64" HEIGHT="32"
BORDER="0" ALT="RossNet"
HSPACE="0" VSPACE="1"></A><BR>
<BR>
<A HREF="../index.shtml"
TARGET="funnelweb"
onClick="window.open('','funnelweb','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>
<IMG SRC="binary/linklogo.gif"
WIDTH="64" HEIGHT="32"
BORDER="0" ALT="FunnelWeb"
HSPACE="0" VSPACE="1"></A><BR>
<BR>
<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0><TR><TD BGCOLOR="#000000">
<A HREF="../tutorial/index.html"
TARGET="funnelwebtutorial"
onClick="window.open('','funnelwebtutorial','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
><FONT COLOR="#FFFFFF"><B>Tutorial</B></FONT></A><BR>
<BR>
<A HREF="../developer/index.html"
TARGET="funnelwebdeveloper"
onClick="window.open('','funnelwebdeveloper','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
><FONT COLOR="#FFFFFF"><B>Developer</B></FONT></A><BR>
<BR>
<A HREF="index.html"><FONT COLOR="#FFFFFF"><B>Reference</B></FONT></A><BR>
<A HREF="intro.html"><FONT COLOR="#FFFFFF">1 Introduction</FONT></A><BR>
<A HREF="interface.html"><FONT COLOR="#FFFFFF">2 Interface</FONT></A><BR>
<A HREF="scanner.html"><FONT COLOR="#FFFFFF">3 Scanner</FONT></A><BR>
<A HREF="parser.html"><FONT COLOR="#FFFFFF">4 Parser</FONT></A><BR>
<A HREF="analyser.html"><FONT COLOR="#FFFFFF">5 Analyser</FONT></A><BR>
<A HREF="tangle.html"><FONT COLOR="#FFFFFF">6 Tangle</FONT></A><BR>
<A HREF="weave.html"><FONT COLOR="#FFFFFF">7 Weave</FONT></A><BR>
<A HREF="shell.html"><FONT COLOR="#FFFFFF">8 Shell</FONT></A><BR>
<A HREF="commands.html"><FONT COLOR="#FFFFFF">9 Commands</FONT></A><BR>
<A HREF="glossary.html"><FONT COLOR="#FFFFFF">10 Glossary</FONT></A><BR>
<A HREF="references.html"><FONT COLOR="#FFFFFF">11 References</FONT></A><BR>
<BR>
<A HREF="search.html"><FONT COLOR="#FFFFFF"><B>SEARCH</B></FONT></A><BR>
</FONT>
</TD></TR></TABLE>
</TD>
<TD WIDTH="360" VALIGN="top">
<FONT SIZE="3">
<A HREF="index.html"><IMG SRC="binary/title.gif"
WIDTH="316" HEIGHT="24"
BORDER="0" ALT="FunnelWeb Reference Manual"
HSPACE="0" VSPACE="0"></A>
<P><FONT SIZE="5">2.3 Options</FONT><BR>
<P>FunnelWeb's options are internal parameters which can
be modified by corresponding arguments on FunnelWeb's
command line. A description of each argument and option
follows.
<P><BLOCKQUOTE><B>B1...B6:
Tracedumps:</B> These
six
options have been provided to assist in the debugging and
testing of FunnelWeb. They determine which of six possible
trace dumps are to be written to the listing file. Only the
boolean attributes of these options are ever used. The six
dumps are identified by the digits <SAMP>1..6</SAMP> as
follows: </BLOCKQUOTE>
<P>
<OL>
<LI> Dump a hexdump of each mapped input and include file.
<LI> Dump the global line list created by the scanner.
<LI> Dump the token list created by the scanner.
<LI> Dump the macro table created by the parser.
<LI> Dump the document list created by the parser.
<LI> Dump a table summarizing CPU and real time usage.
</OL>
<P>Because these options are so closely related, a hack
has been pulled to enable them to all to be controlled by
the <SAMP>B</SAMP> argument. The string argument to the
<SAMP>B</SAMP> argument determines which of the six options are
to be affected by the sign. Examples: <SAMP>+B134</SAMP> turns
on options <SAMP>B1</SAMP>, <SAMP>B3</SAMP>, and <SAMP>B4</SAMP>.
<SAMP>-B1</SAMP> turns off option <SAMP>B1</SAMP>.
<SAMP>Default: -B123456</SAMP>.
<P><BLOCKQUOTE><B>B7: Determinism:</B> If the <SAMP>B7</SAMP>
option is turned on, FunnelWeb suppresses the output of
anything non-deterministic, or
machine dependent. This assists in regression testing. Only
the boolean attribute is used in this option. This option is
controlled by the <SAMP>B7</SAMP> argument which falls under
the same argument syntax as the other <SAMP>B</SAMP> options.
Examples: <SAMP>+B7</SAMP>, <SAMP>-B7</SAMP>.
<SAMP>Default: -B7</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>C: Listing File
Context:</B> The <SAMP>C</SAMP> option is always turned on and cannot be
turned off. Its only attribute is a number which determines
the number of lines of context that the lister will place
around lines flagged with diagnostics in the listing file
(if a listing file is written). A value of 100 indicates
infinite context which means that
the entire listing file will be written out if a single
diagnostic occurs. The value of this number can be specified
by specifying it as a string of decimal digits to the
<SAMP>+C</SAMP> argument. Examples: <SAMP>+C100</SAMP>,
<SAMP>+C10</SAMP>. <SAMP>Default: +C2</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>D: Delete Identical Output Files:</B> Only the
boolean attribute of this option is
used. When
turned on, the option causes the suppression (deletion) of
product files and documentation files (but not listing or
journal files) that are identical to the currently existing
files of the same name. For example, if FunnelWeb is
instructed to generate <SAMP>stack.h</SAMP> as an product file,
and the text to be written to <SAMP>stack.h</SAMP> is identical
to the currently existing <SAMP>stack.h</SAMP>, then FunnelWeb
will simply not write any product file, leaving the
currently existing <SAMP>stack.h</SAMP> as it is (and in
particular leaving the file's date attribute the same). This
prevents unnecessary <SAMP>make</SAMP> propagations. For
example, in a C program, if <SAMP>stack.fw</SAMP> is a
FunnelWeb input file that generates <SAMP>stack.h</SAMP> and
<SAMP>stack.c</SAMP>, a modification to <SAMP>stack.fw</SAMP> that
affects <SAMP>stack.c</SAMP> but does not affect
<SAMP>stack.h</SAMP> will not provoke the recompilation of
modules that <SAMP>#include stack.h</SAMP>, so long as the
intervening FunnelWeb run has <SAMP>+D</SAMP> set. Examples:
<SAMP>-D</SAMP>, <SAMP>+D</SAMP>. <SAMP>Default: -D</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>F: FunnelWeb Input
File:</B> If this option is turned on,
FunnelWeb processes the input
file whose name is specified by the option string. Examples:
<SAMP>+Fsloth.fw</SAMP>, <SAMP>+Fwalrus</SAMP>, <SAMP>-F</SAMP>.
<SAMP>Default: -F</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>H: Display Help
Message:</B> If this
option is turned on, FunnelWeb
displays the message specified by the argument string. Each
message has a name. The main help message is called
"<TT>menu</TT>" and contains a list of the other help
messages. Examples: <SAMP>+Hregistration</SAMP>,
<SAMP>+Hoptions</SAMP>. <SAMP>Default: -Hmenu</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>I: Include default file
specification:</B> This
option
is always turned on and cannot be turned off. Its string
attribute is used as the default file specification for
include files. Usually this option is used to specify a
directory from which include files should be obtained.
Examples: <SAMP>=I/usr/dave/includes/</SAMP>.
<SAMP>Default: +I</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>J: Journal File:</B> If
this option is turned on, FunnelWeb generates
a
journal file. A journal file contains a log of all the
console input and output to FunnelWeb during a single
invocation of the FunnelWeb program (Note: The <SAMP>Q</SAMP>
option does not affect this.). The journal file is
particularly useful for examining what happened during a
FunnelWeb shell run. The string attribute is the name of the
journal file. Examples: <SAMP>+Jjournfile</SAMP>, <SAMP>-J</SAMP>.
<SAMP>Default: -J</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>K: Keyboard:</B> If this
option
is turned on, FunnelWeb enters an interactive mode in which
the user can enter FunnelWeb shell commands interactively.
The string attribute is unused. Examples: <SAMP>+K</SAMP>,
<SAMP>-K</SAMP>. <SAMP>Default: -K</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>L: Listing File:</B> If
this option is turned on, FunnelWeb generates
a
listing file containing a summary of a run on FunnelWeb
proper. The string argument is the name of the listing file
to be created. Examples: <SAMP>+L</SAMP>, <SAMP>-L</SAMP>,
<SAMP>+Llisting.lis</SAMP>. <SAMP>Default: -L</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>O: Product Files:</B> If this option is turned
on, FunnelWeb generates a product file for each macro in the
input file that is bound to an output file. The string
attribute contributes to the name of the product files. This
option is controlled by the <SAMP>O</SAMP> argument because
product files used to be called "<STRONG>O</STRONG>utput
files"). Examples: <SAMP>-O</SAMP>,
<SAMP>+O/usr/dave/product/</SAMP>. <SAMP>Default: +O</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>Q: Quiet:</B> If this
option is turned on, FunnelWeb suppresses
all
output to the screen (standard output) unless one or more
errors occur, in which case a single line summarizing the
errors is sent to standard output at the end of the run. If
this option is turned off, FunnelWeb writes to the console
in its normal garrulous way. The string attribute is unused
in this option. Examples: <SAMP>-Q</SAMP>, <SAMP>+Q</SAMP>.
<SAMP>Default: -Q</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>S: Screen:</B> If this
option is turned on, FunnelWeb writes
all diagnostics to the screen
(standard output) as well as to the listing file. By
default, they are sent only to the listing file. This option
has a single numerical attribute that can be specified as a
decimal string in the string component of the <SAMP>S</SAMP>
argument. The number is the number of lines of context that
should surround each diagnostic sent to the
screen. Examples: <SAMP>-S</SAMP>,
<SAMP>+S6</SAMP>, <SAMP>+S0</SAMP>. <SAMP>Default: -S</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>T: TeX Documentation
file:</B> If this option is turned on,
FunnelWeb
generates a documentation file in TeX format. The string
argument contributes to the name of the documentation file
to be created. By default this option is turned off, as
experience has shown that most FunnelWeb runs are made
during program development; documentation runs occur far
more rarely. This option is controlled by the <SAMP>T</SAMP>
command line argument because documentation files used to be
called typesetter files. Examples: <SAMP>-T</SAMP>,
<SAMP>+Tsloth.tex</SAMP>. <SAMP>Default: -T</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>U: HTML Documentation
file:</B> If this option is turned on,
FunnelWeb
generates a documentation file in HTML format. The string
argument contributes to the name of the documentation file
to be created. By default this option is turned off, as
experience has shown that most FunnelWeb runs are made
during program development; documentation runs occur far
more rarely. <SAMP>U</SAMP> was chosen for this feature
because it follows <SAMP>T</SAMP>, and <SAMP>H</SAMP> and
<SAMP>W</SAMP> were already allocated to other functions.
Examples: <SAMP>-U</SAMP>,
<SAMP>+Usloth.html</SAMP>. <SAMP>Default: -U</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>W: Width of Product
Files:</B> If this
option
is turned on, a limit is placed on the length of lines in
product files generated during the run. Lines that breach
the limit are flagged with error messages. This option has a
single numerical attribute that can be specified as a
decimal string in the string component of the <SAMP>W</SAMP>
argument. The number is the specified maximum width. This
option is one of two limits that are placed on the width of
product files. The other limit is an attribute of the input
file that defaults to 80 characters, but can be raised or
lowered using an output line length pragma. The width that
is enforced is the lower of this value and the value of the
<SAMP>W</SAMP> option (if turned on). Examples: <SAMP>-W</SAMP>,
<SAMP>+W100</SAMP>. <SAMP>Default: -W80</SAMP>.</BLOCKQUOTE>
<P><BLOCKQUOTE><B>X: Execute:</B> If this
option is turned on,
FunnelWeb executes the FunnelWeb shell script file specified
by the string attribute. Examples: <SAMP>+Xmaster</SAMP>,
<SAMP>-X</SAMP>. <SAMP>Default: -X</SAMP>.</BLOCKQUOTE>
<P>
<TABLE WIDTH="100%">
<TR>
<TD ALIGN="left" VALIGN="bottom"><A HREF="interface_arguments.html"><IMG SRC="binary/fw_left.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Prev"></A></TD>
<TD ALIGN="center" VALIGN="bottom"><A HREF="interface.html"><IMG SRC="binary/fw_up.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Up"></A></TD>
<TD ALIGN="right" VALIGN="bottom"><A HREF="interface_inheritance.html"><IMG SRC="binary/fw_right.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Next"></A></TD>
</TR>
</TABLE>
<P>
<HR>
<FONT SIZE="2">
<A HREF="mailto:webmaster@ross.net">Webmaster</A>
<A HREF="copyright.html">Copyright © Ross N. Williams 1992,1999. All rights reserved.</A><BR>
</FONT>
</FONT>
</TD>
</TR>
</TABLE>
</FONT>
</BODY>
<!-- *********************************************************************** -->
<!-- End Of A FunnelWeb Manual Web Page (www.ross.net/funnelweb/) -->
<!-- *********************************************************************** -->
</HTML>
|
