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
|
<HTML>
<HEAD>
<META NAME="description"
CONTENT="The FunnelWeb Reference Manual. FunnelWeb is a portable
free literate programming tool.">
<META NAME="keywords"
CONTENT="funnelweb,FunnelWeb,funnel,web,
reference manual,reference,manual,
literate programming,literate,programming,literate-programming,
documentation,
macro,macros,preprocessor,macro preprocessor,
software,free,freeware,
open source,open,source,gnu,gpl,copyleft,
web,development,tool,web tool">
<STYLE TYPE="text/css"> <!-- A {text-decoration: none} // --> </STYLE>
<TITLE>FunnelWeb Reference Manual</TITLE>
</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><STRONG><FONT SIZE="4">Version 3.2d (9 Jan 2000) for FunnelWeb V3.2</FONT></STRONG>
<P><FONT SIZE="+3">T</FONT>HIS REFERENCE MANUAL provides a concise
and precise definition of the functionality of the FunnelWeb
literate programming preprocessor. You should refer to this
manual when you have specific technical questions about
FunnelWeb. The SEARCH facility in the margin provides a
quick way to find what you need quickly. If you are not
already familiar with FunnelWeb, you may wish to refer to
the <A HREF="../tutorial/index.html"
TARGET="funnelwebtutorial"
onClick="window.open('','funnelwebtutorial','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>FunnelWeb Tutorial Manual</A> which provides a
structured introduction to FunnelWeb, along with lots of
examples and application-specific information. If you want
to compile FunnelWeb, refer to the
<A HREF="../developer/index.html"
TARGET="funnelwebdeveloper"
onClick="window.open('','funnelwebdeveloper','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
>FunnelWeb Developer Manual</A>
<P>
<FONT SIZE="4">
<DL>
<DT>
<DL>
<P><A HREF="intro.html"><B>1 Introduction</B></A><BR>
<FONT SIZE="3">
<DL>
<A HREF="intro_notation.html">1.1 Notation</A><BR>
<A HREF="intro_terminology.html">1.2 Terminology</A><BR>
<A HREF="intro_arch.html">1.3 An Architectural Overview</A><BR>
<A HREF="intro_diagnostics.html">1.4 Diagnostics</A><BR>
<A HREF="intro_typesetter.html">1.5 Typesetter Independence</A><BR>
</DL>
</FONT>
<P><A HREF="interface.html"><B>2 Command Line Interface</B></A><BR>
<FONT SIZE="3">
<DL>
<A HREF="interface_invoking.html">2.1 Invoking FunnelWeb</A><BR>
<A HREF="interface_arguments.html">2.2 Command Line Arguments</A><BR>
<A HREF="interface_options.html">2.3 Options</A><BR>
<A HREF="interface_inheritance.html">2.4 File Name Inheritance</A><BR>
<A HREF="interface_startup.html">2.5 FunnelWeb Startup</A><BR>
</DL>
</FONT>
<P><A HREF="scanner.html"><B>3 Scanner</B></A><BR>
<FONT SIZE="3">
<DL>
<A HREF="scanner_basic.html">3.1 Basic Input File Processing</A><BR>
<A HREF="scanner_special.html">3.2 Special Sequences</A><BR>
<A HREF="scanner_special_set.html">3.3 Setting the Special Character</A><BR>
<A HREF="scanner_special_ins.html">3.4 Inserting the Special Character into the Text</A><BR>
<A HREF="scanner_arbitrary.html">3.5 Inserting Arbitrary Characters into the Text</A><BR>
<A HREF="scanner_comments.html">3.6 Comments</A><BR>
<A HREF="scanner_quicknames.html">3.7 Quick Names</A><BR>
<A HREF="scanner_eol_ins.html">3.8 Inserting End of Line Markers</A><BR>
<A HREF="scanner_eol_supp.html">3.9 Suppressing End of Line Markers</A><BR>
<A HREF="scanner_include.html">3.10 Include Files</A><BR>
<A HREF="scanner_prag.html">3.11 Pragmas</A><BR>
<A HREF="scanner_prag_ind.html">3.12 Pragma: Indentation</A><BR>
<A HREF="scanner_prag_maxin.html">3.13 Pragma: Maximum Input Line Length</A><BR>
<A HREF="scanner_prag_maxout.html">3.14 Pragma: Maximum Output File Line Length</A><BR>
<A HREF="scanner_prag_type.html">3.15 Pragma: Typesetter</A><BR>
<A HREF="scanner_type.html">3.16 Freestanding Typesetter Directives</A><BR>
<A HREF="scanner_type_newpage.html">3.17 New Page Directives</A><BR>
<A HREF="scanner_type_contents.html">3.18 Table of Contents</A><BR>
<A HREF="scanner_type_vskip.html">3.19 Vertical Skip</A><BR>
<A HREF="scanner_type_title.html">3.20 Title</A><BR>
<A HREF="scanner_parser.html">3.21 Scanner/Parser Interface</A><BR>
</DL>
</FONT>
<P><A HREF="parser.html"><B>4 Parser</B></A><BR>
<FONT SIZE="3">
<DL>
<A HREF="parser_introduction.html">4.1 Introduction</A><BR>
<A HREF="parser_structure.html">4.2 High Level Structure</A><BR>
<A HREF="parser_freetext.html">4.3 Free Text</A><BR>
<A HREF="parser_type.html">4.4 Typesetter Directives</A><BR>
<A HREF="parser_type_section.html">4.5 Section Directive</A><BR>
<A HREF="parser_type_literal.html">4.6 Literal Directive</A><BR>
<A HREF="parser_type_emphasis.html">4.7 Emphasis Directive</A><BR>
<A HREF="parser_macros.html">4.8 Macros</A><BR>
<A HREF="parser_macros_name.html">4.9 Macro Names</A><BR>
<A HREF="parser_macros_params.html">4.10 Formal Parameter Lists</A><BR>
<A HREF="parser_expressions.html">4.11 Expressions</A><BR>
<A HREF="parser_macro_calls.html">4.12 Macro Calls</A><BR>
<A HREF="parser_parameters.html">4.13 Macro Formal Parameters</A><BR>
<A HREF="parser_static.html">4.14 Macros Are Static</A><BR>
</DL>
</FONT>
<P><A HREF="analyser.html"><B>5 Analyser</B></A><BR>
<P><A HREF="tangle.html"><B>6 Tangle</B></A><BR>
<P><A HREF="weave.html"><B>7 Weave</B></A><BR>
<P><A HREF="shell.html"><B>8 FunnelWeb Shell</B></A><BR>
<FONT SIZE="3">
<DL>
<A HREF="shell_introduction.html">8.1 Introduction</A><BR>
<A HREF="shell_statuses.html">8.2 Return Statuses</A><BR>
<A HREF="shell_linelen.html">8.3 Command Line Length</A><BR>
<A HREF="shell_strsubs.html">8.4 String Substitution</A><BR>
<A HREF="shell_processing.html">8.5 How a Command Line is Processed</A><BR>
<A HREF="shell_options.html">8.6 Options</A><BR>
</DL>
</FONT>
<P><A HREF="commands.html"><B>9 Shell Commands</B></A><BR>
<FONT SIZE="3">
<DL>
<A HREF="commands_introduction.html">9.1 Introduction</A><BR>
<A HREF="commands_absent.html">9.2 Absent</A><BR>
<A HREF="commands_codify.html">9.3 Codify</A><BR>
<A HREF="commands_compare.html">9.4 Compare</A><BR>
<A HREF="commands_define.html">9.5 Define</A><BR>
<A HREF="commands_diff.html">9.6 Diff</A><BR>
<A HREF="commands_diffsummary.html">9.7 Diffsummary</A><BR>
<A HREF="commands_diffzero.html">9.8 Diffzero</A><BR>
<A HREF="commands_eneo.html">9.9 Eneo</A><BR>
<A HREF="commands_execute.html">9.10 Execute</A><BR>
<A HREF="commands_exists.html">9.11 Exists</A><BR>
<A HREF="commands_fixeols.html">9.12 Fixeols</A><BR>
<A HREF="commands_fw.html">9.13 Fw</A><BR>
<A HREF="commands_help.html">9.14 Help</A><BR>
<A HREF="commands_here.html">9.15 Here</A><BR>
<A HREF="commands_quit.html">9.16 Quit</A><BR>
<A HREF="commands_set.html">9.17 Set</A><BR>
<A HREF="commands_show.html">9.18 Show</A><BR>
<A HREF="commands_skipto.html">9.19 Skipto</A><BR>
<A HREF="commands_status.html">9.20 Status</A><BR>
<A HREF="commands_tolerate.html">9.21 Tolerate</A><BR>
<A HREF="commands_trace.html">9.22 Trace</A><BR>
<A HREF="commands_write.html">9.23 Write</A><BR>
<A HREF="commands_writeu.html">9.24 Writeu</A><BR>
</DL>
</FONT>
<P><A HREF="glossary.html"><B>10 Glossary</B></A><BR>
<P><A HREF="references.html"><B>11 References</B></A><BR>
</DL>
</DL>
</FONT>
<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>
|