~ubuntu-branches/ubuntu/gutsy/funnelweb-doc/gutsy

« back to all changes in this revision

Viewing changes to reference/interface_arguments.html

  • Committer: Bazaar Package Importer
  • Author(s): Yann Dirson
  • Date: 2002-03-28 23:21:07 UTC
  • Revision ID: james.westby@ubuntu.com-20020328232107-3d1jiqv1eqmco3j9
Tags: upstream-3.2d
ImportĀ upstreamĀ versionĀ 3.2d

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
<HTML>
 
3
<!--
 
4
***********************************************************************
 
5
FUNNELWEB MANUAL WEB PAGE
 
6
=========================
 
7
Copyright (c) Ross N. Williams 1992,1999. All rights reserved.
 
8
 
 
9
Permission is granted to redistribute and use this manual in
 
10
any medium, with or without modification, provided that all
 
11
notices (including, without limitation, the copyright
 
12
notice, this permission notice, any record of modification,
 
13
and all legal notices) are preserved on all copies, that all
 
14
modifications are clearly marked, and that modified versions
 
15
are not represented as the original version unless all the
 
16
modifications since the manual's original release by Ross N.
 
17
Williams (www.ross.net) consist of translations or other
 
18
transformations that alter only the manual's form, not its
 
19
content. THIS MANUAL IS PROVIDED "AS IS" AND WITHOUT ANY
 
20
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
 
21
LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND
 
22
FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT PERMITTED BY
 
23
LAW THERE IS ABSOLUTELY NO WARRANTY.
 
24
 
 
25
***********************************************************************
 
26
-->
 
27
 
 
28
<HEAD>
 
29
<TITLE>2.2 Command Line Arguments</TITLE>
 
30
<STYLE TYPE="text/css"> <!-- A {text-decoration: none} // --> </STYLE>
 
31
</HEAD>
 
32
<BODY BACKGROUND="binary/background.gif"
 
33
      BGCOLOR="#FFFFFF"
 
34
      TEXT="#000000"
 
35
      VLINK="#660000"
 
36
      LINK="#FF0000"
 
37
      ALINK="#CC0000">
 
38
 
 
39
<TABLE WIDTH="490">
 
40
<TR>
 
41
<TD WIDTH="130" VALIGN="top">
 
42
<IMG SRC="binary/d_clear.gif" ALT="" WIDTH="130" HEIGHT="1"><BR>
 
43
 
 
44
<FONT SIZE="2">
 
45
<BR>
 
46
 
 
47
<A HREF="http://www.ross.net/"
 
48
 TARGET="rosshome"
 
49
 onClick="window.open('','rosshome','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
 
50
>
 
51
 <IMG SRC="binary/rossnet_logo.gif"
 
52
  WIDTH="64" HEIGHT="32"
 
53
  BORDER="0" ALT="RossNet"
 
54
  HSPACE="0" VSPACE="1"></A><BR>
 
55
<BR>
 
56
 
 
57
<A HREF="../index.shtml"
 
58
 TARGET="funnelweb"
 
59
 onClick="window.open('','funnelweb','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
 
60
>
 
61
 <IMG SRC="binary/linklogo.gif"
 
62
  WIDTH="64" HEIGHT="32"
 
63
  BORDER="0" ALT="FunnelWeb"
 
64
  HSPACE="0" VSPACE="1"></A><BR>
 
65
<BR>
 
66
<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0><TR><TD BGCOLOR="#000000">
 
67
<A HREF="../tutorial/index.html"
 
68
 TARGET="funnelwebtutorial"
 
69
 onClick="window.open('','funnelwebtutorial','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
 
70
><FONT COLOR="#FFFFFF"><B>Tutorial</B></FONT></A><BR>
 
71
<BR>
 
72
<A HREF="../developer/index.html"
 
73
 TARGET="funnelwebdeveloper"
 
74
 onClick="window.open('','funnelwebdeveloper','location,status,menubar,scrollbars,resizable',false).focus(); return true;"
 
75
><FONT COLOR="#FFFFFF"><B>Developer</B></FONT></A><BR>
 
76
<BR>
 
77
<A HREF="index.html"><FONT COLOR="#FFFFFF"><B>Reference</B></FONT></A><BR>
 
78
<A HREF="intro.html"><FONT COLOR="#FFFFFF">1 Introduction</FONT></A><BR>
 
79
<A HREF="interface.html"><FONT COLOR="#FFFFFF">2 Interface</FONT></A><BR>
 
80
<A HREF="scanner.html"><FONT COLOR="#FFFFFF">3 Scanner</FONT></A><BR>
 
81
<A HREF="parser.html"><FONT COLOR="#FFFFFF">4 Parser</FONT></A><BR>
 
82
<A HREF="analyser.html"><FONT COLOR="#FFFFFF">5 Analyser</FONT></A><BR>
 
83
<A HREF="tangle.html"><FONT COLOR="#FFFFFF">6 Tangle</FONT></A><BR>
 
84
<A HREF="weave.html"><FONT COLOR="#FFFFFF">7 Weave</FONT></A><BR>
 
85
<A HREF="shell.html"><FONT COLOR="#FFFFFF">8 Shell</FONT></A><BR>
 
86
<A HREF="commands.html"><FONT COLOR="#FFFFFF">9 Commands</FONT></A><BR>
 
87
<A HREF="glossary.html"><FONT COLOR="#FFFFFF">10 Glossary</FONT></A><BR>
 
88
<A HREF="references.html"><FONT COLOR="#FFFFFF">11 References</FONT></A><BR>
 
89
 
 
90
<BR>
 
91
<A HREF="search.html"><FONT COLOR="#FFFFFF"><B>SEARCH</B></FONT></A><BR>
 
92
</FONT>
 
93
</TD></TR></TABLE>
 
94
 
 
95
 
 
96
</TD>
 
97
<TD WIDTH="360" VALIGN="top">
 
98
<FONT SIZE="3">
 
99
 
 
100
 
 
101
<A HREF="index.html"><IMG SRC="binary/title.gif"
 
102
 WIDTH="316" HEIGHT="24"
 
103
 BORDER="0" ALT="FunnelWeb Reference Manual"
 
104
 HSPACE="0" VSPACE="0"></A>
 
105
<P><FONT SIZE="5">2.2 Command Line Arguments</FONT><BR>
 
106
 
 
107
 
 
108
 
 
109
<P>Following the verb is the body of the command line
 
110
which FunnelWeb parses into zero or more
 
111
<STRONG>arguments</STRONG> separated by runs of one or more
 
112
blanks.
 
113
 
 
114
<P>
 
115
<PRE>
 
116
FunnelWeb_command_line =
 
117
   FunnelWeb_verb { {" "}+ argument }
 
118
</PRE>
 
119
 
 
120
<P>Because some operating systems convert their command
 
121
line to upper case before handing it to the invoked program,
 
122
FunnelWeb has been constructed so as to be
 
123
<I>insensitive</I>&nbsp; to the case of its command line
 
124
arguments. However, when dealing
 
125
internally with arguments, FunnelWeb <I>preserves</I>&nbsp; the
 
126
case of its command line arguments so that it will be able
 
127
to operate with operating systems (such as
 
128
Unix) whose file names are case dependent.
 
129
 
 
130
<P>A valid FunnelWeb argument consists of a
 
131
<STRONG>sign</STRONG>, an identifying <STRONG>letter</STRONG>,
 
132
and an optional <STRONG>string</STRONG> with no spaces
 
133
separating them.
 
134
 
 
135
<P>
 
136
<PRE>
 
137
argument  = sign id_letter [non_blank_string]
 
138
sign      = "+" | "-" | "="
 
139
id_letter = "B" | "C" | "D" | "F" | "H" | "I" |
 
140
            "J" | "K" | "L" | "O" | "Q" | "S" |
 
141
            "T" | "W" | "X"
 
142
</PRE>
 
143
 
 
144
<P>In addition there is a special form of argument that
 
145
does not begin with a sign.
 
146
 
 
147
<P>
 
148
<PRE>
 
149
argument = non_blank_string_not_starting_with_+_=_or_-
 
150
</PRE>
 
151
 
 
152
<P>This form is exactly equivalent to the same string with
 
153
"<TT>+F</TT>" prepended to it.
 
154
 
 
155
<P>The semantic effect of these arguments is defined in
 
156
terms of <STRONG>options</STRONG> which are the internal
 
157
parameters of FunnelWeb and which correspond closely with
 
158
the set of legal command line arguments. FunnelWeb has a
 
159
predefined set of options each identified by an identifying
 
160
letter having two attributes: a <I>string</I>&nbsp;, and a
 
161
<I>boolean</I>&nbsp;. The boolean determines whether an option
 
162
is turned <I>on</I>&nbsp; or <I>off</I>&nbsp;. The string contains
 
163
additional information depending on the option.
 
164
 
 
165
<P>When FunnelWeb starts up, its options have predefined
 
166
default values. FunnelWeb then parses its command line
 
167
sequentially from left to right executing the effect of each
 
168
argument on the argument's corresponding option.  The sign
 
169
and the string components of the argument are processed
 
170
<I>independently</I>&nbsp;. A sign of <SAMP>+</SAMP> turns the
 
171
option on. A sign of <SAMP>-</SAMP> turns the option off. A
 
172
sign of <SAMP>=</SAMP> leaves the option's boolean attribute
 
173
unchanged. The argument string replaces the string of the
 
174
corresponding option, unless the argument string is empty,
 
175
in which case the option string is not changed.
 
176
 
 
177
<P>Because FunnelWeb processes its command line arguments
 
178
from left to right, a later argument can cancel the effect
 
179
of an earlier one. For example <SAMP>fw +t -t</SAMP> will
 
180
result in the <SAMP>t</SAMP> option ending up <I>off</I>&nbsp;.
 
181
This allows users to set up their own default arguments by
 
182
defining a symbol in their operating system's command
 
183
language. For example, a Unix user who wants FunnelWeb to
 
184
delete all identical output files and create a documentation
 
185
file on each run with a default <SAMP>.typ</SAMP> extension
 
186
could simply place the following definition in their
 
187
"<TT>.login</TT>" file.
 
188
 
 
189
<P>
 
190
<PRE>
 
191
alias fw fw +d +t.typ
 
192
</PRE>
 
193
 
 
194
<P>These default options can then later be easily
 
195
overridden on the command line.
 
196
 
 
197
 
 
198
<P>
 
199
<TABLE WIDTH="100%">
 
200
<TR>
 
201
<TD ALIGN="left"   VALIGN="bottom"><A HREF="interface_invoking.html"><IMG SRC="binary/fw_left.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Prev"></A></TD>
 
202
<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>
 
203
<TD ALIGN="right"  VALIGN="bottom"><A HREF="interface_options.html"><IMG SRC="binary/fw_right.gif" HEIGHT="32" WIDTH="32" BORDER="0" ALT="Next"></A></TD>
 
204
</TR>
 
205
</TABLE>
 
206
 
 
207
 
 
208
 
 
209
<P>
 
210
<HR>
 
211
<FONT SIZE="2">
 
212
<A HREF="mailto:webmaster@ross.net">Webmaster</A>&nbsp;&nbsp;&nbsp;
 
213
<A HREF="copyright.html">Copyright &copy; Ross N. Williams 1992,1999. All rights reserved.</A><BR>
 
214
</FONT>
 
215
 
 
216
</FONT>
 
217
</TD>
 
218
</TR>
 
219
</TABLE>
 
220
 
 
221
 
 
222
</FONT>
 
223
</BODY>
 
224
 
 
225
<!-- *********************************************************************** -->
 
226
<!--      End Of A FunnelWeb Manual Web Page (www.ross.net/funnelweb/)       -->
 
227
<!-- *********************************************************************** -->
 
228
 
 
229
</HTML>