Debian Codegraph @

admin/0readme.txt

raw
1 ================================================================================
2
3 FUNNELWEB V3.2
4 ==============
5 Date : 13 May 1999.
6 Author : Ross N. Williams ([email protected]).
7 WWW : http://www.ross.net/funnelweb/
8 FTP : ftp://ftp.ross.net/clients/ross/funnelweb/
9 Copyright : Copyright (c) Ross N. Williams 1992. All rights reserved.
10
11
12 What Is FunnelWeb?
13 ------------------
14 FunnelWeb is a powerful literate-programming macro
15 preprocessor that enables you to weave programs and
16 documentation together. FunnelWeb is a production-quality
17 tool that was specifically engineered for practical everyday
18 use:
19
20 * Can be used with any programming language.
21 * Runs on most platforms.
22 * Free of charge; entirely non-commercial.
23 * Source available under a GNU licence.
24 * Reference, tutorial, and developer manuals.
25 * Mature and essentially bug-free (released 1992).
26 * Simple; specifically designed to minimize errors.
27 * High speed; doesn't stretch the development cycle.
28 * Generates documentation in HTML and TeX forms.
29 * FunnelWeb user community mailing list.
30
31 FunnelWeb is also a powerful general purpose text file
32 preparation tool that has found many applications outside
33 the area of literate programming. In particular, FunnelWeb
34 is an excellent tool for the preparation of web sites.
35
36 For more information visit:
37
38 http://www.ross.net/funnelweb/
39 http://www.ross.net/funnelweb/tutorial/
40 http://www.ross.net/funnelweb/reference/
41 http://www.ross.net/funnelweb/developer/
42
43
44 Copyright And Licensing
45 -----------------------
46 Copyright (c) Ross N. Williams 1992. All rights reserved.
47
48 FunnelWeb is free software; you can redistribute it and/or modify
49 it under the terms of Version 2 of the GNU General Public License as
50 published by the Free Software Foundation (http://www.gnu.org/).
51
52 FunnelWeb is distributed WITHOUT ANY WARRANTY; without even the implied
53 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
54 See Version 2 of the GNU General Public License for more details.
55
56 A copy of Version 2 of the GNU General Public License should appear
57 at the end of this readme document. If it does not, you can obtain a
58 copy as follows:
59 ftp://prep.ai.mit.edu/pub/gnu/COPYING-2.0
60 or write to:
61 Free Software Foundation, Inc.,
62 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
63
64 The source code for FunnelWeb is available somewhere within:
65
66 ftp://ftp.ross.net/clients/ross/funnelweb/
67
68
69 Obtaining FunnelWeb
70 -------------------
71 The FunnelWeb web is at:
72
73 http://www.ross.net/funnelweb/
74
75 This web contains instructions on how to obtain and install
76 FunnelWeb. If you do not have web access, take a look in the
77 following FTP archive:
78
79 ftp://ftp.ross.net/clients/ross/funnelweb/
80
81 There may be one or more subdirectories named by FunnelWeb
82 version number. Choose the highest version number and look
83 there for the FunnelWeb distribution files.
84
85 IMPORTANT: The "Win32" version of FunnelWeb is for
86 both "Windows 95" and "Windows NT".
87
88
89 Unpacking FunnelWeb
90 ------------------
91 FunnelWeb is shipped as a single archive file. Here are examples
92 of how to unpack FunnelWeb on various kinds of platforms. The
93 V characters stand for the FunnelWeb version number.
94
95 Win32 : Use WinZip's GUI to "Extract" the FunnelWeb directory.
96 MS-DOS : pkunzip -d funwvVVV.zip
97 MacOS : Drop funnelweb_vVVV_mac.hqx onto Stuffit Expander.
98 Unix : tar -xf funnelweb_vVVV_solaris.tar
99 OpenVMS : unzip funnelweb_vVVV_vmsvax.zip
100
101 If all goes well, a small directory tree called "funnelweb"
102 will be created. The directory tree should look something
103 like this:
104
105 funnelweb - The FunnelWeb directory.
106 0readme.txt - This document.
107 funnelweb.exe - The FunnelWeb executable.
108
109 Here's where to find the unpacking utilities. If you can't
110 access these servers, try doing an Archie search for files
111 of similar names to find copies on other servers. They're
112 everywhere.
113
114 Win32 : http://www.winzip.com/
115 MS-DOS : ftp://cs.nyu.edu/pub/local/porter/pkunzip.exe
116 MacOS : ftp://ftp.amug.org//pub/info-mac/cmp/stuffit-expander*.hqx
117 OpenVMS : ftp://ftp.wku.edu/vms/unzip.exe (and unzip.alpha_exe).
118 Unix : The tar command is part of Unix.
119
120
121 Install The FunnelWeb Executable
122 --------------------------------
123 Move the FunnelWeb executable to a permanent place on your
124 disk. You can place the FunnelWeb directory anywhere you
125 like. Here are some suggested places:
126
127 Win32 : C:\FW\
128 MS-DOS : C:\FW\
129 MacOS : HardDisk:FunnelWeb:FunnelWeb
130 OpenVMS : SYS$SYSDEVICE:[FUNNELWEB]FUNNELWEB.EXE;1
131 Unix : /usr/local/bin/fw
132
133
134 Make The Executable Available
135 -----------------------------
136 Make the FunnelWeb executable available for execution in
137 your shell (as the command "fw") by either defining
138 a symbol for it or placing the executable in the "path".
139 Here are some examples of how to do this:
140
141 Win32 : PATH=%PATH%;C:\FW
142 MS-DOS : PATH=%PATH%;C:\FW
143 MacOS : No action required.
144 OpenVMS : fw == "$sys$sysdevice:[funnelweb]FUNNELWEB.EXE"
145 Unix : alias fw /usr/local/bin/fw
146 or Unix : set path=($path /usr/local/bin)
147
148 Put the definition in an appropriate login script
149 (e.g. AUTOEXEC.BAT, .login, LOGIN.COM) so that the fw
150 command will be available next time you log in.
151
152 Set Protections
153 ---------------
154 Under some operating systems, you should set appropriate
155 protections on the executable file so that it can be
156 executed. You should also protect the other files too.
157 Here are some examples:
158
159 Win32 : Set appropriate protections.
160 Win95 : No action required.
161 MS-DOS : No action required .
162 MacOS : No action required (unless installing on a server).
163 Unix : chmod go=rx /usr/local/bin/fw
164 OpenVMS : set prot=(s:rwed,o:rwed,g:e,w:e) funnelweb.exe
165
166 More Information
167 ----------------
168 More information on FunnelWeb can be found at:
169
170 http://www.ross.net/funnelweb/
171 http://www.ross.net/funnelweb/tutorial/
172 http://www.ross.net/funnelweb/reference/
173 http://www.ross.net/funnelweb/developer/
174
175 The next step is to visit the FunnelWeb Tutorial in the tutorial web.
176
177 ================================================================================
178
179 GNU GENERAL PUBLIC LICENSE
180 Version 2, June 1991
181
182 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
183 675 Mass Ave, Cambridge, MA 02139, USA
184 Everyone is permitted to copy and distribute verbatim copies
185 of this license document, but changing it is not allowed.
186
187 Preamble
188
189 The licenses for most software are designed to take away your
190 freedom to share and change it. By contrast, the GNU General Public
191 License is intended to guarantee your freedom to share and change free
192 software--to make sure the software is free for all its users. This
193 General Public License applies to most of the Free Software
194 Foundation's software and to any other program whose authors commit to
195 using it. (Some other Free Software Foundation software is covered by
196 the GNU Library General Public License instead.) You can apply it to
197 your programs, too.
198
199 When we speak of free software, we are referring to freedom, not
200 price. Our General Public Licenses are designed to make sure that you
201 have the freedom to distribute copies of free software (and charge for
202 this service if you wish), that you receive source code or can get it
203 if you want it, that you can change the software or use pieces of it
204 in new free programs; and that you know you can do these things.
205
206 To protect your rights, we need to make restrictions that forbid
207 anyone to deny you these rights or to ask you to surrender the rights.
208 These restrictions translate to certain responsibilities for you if you
209 distribute copies of the software, or if you modify it.
210
211 For example, if you distribute copies of such a program, whether
212 gratis or for a fee, you must give the recipients all the rights that
213 you have. You must make sure that they, too, receive or can get the
214 source code. And you must show them these terms so they know their
215 rights.
216
217 We protect your rights with two steps: (1) copyright the software, and
218 (2) offer you this license which gives you legal permission to copy,
219 distribute and/or modify the software.
220
221 Also, for each author's protection and ours, we want to make certain
222 that everyone understands that there is no warranty for this free
223 software. If the software is modified by someone else and passed on, we
224 want its recipients to know that what they have is not the original, so
225 that any problems introduced by others will not reflect on the original
226 authors' reputations.
227
228 Finally, any free program is threatened constantly by software
229 patents. We wish to avoid the danger that redistributors of a free
230 program will individually obtain patent licenses, in effect making the
231 program proprietary. To prevent this, we have made it clear that any
232 patent must be licensed for everyone's free use or not licensed at all.
233
234 The precise terms and conditions for copying, distribution and
235 modification follow.
236
237 GNU GENERAL PUBLIC LICENSE
238 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
239
240 0. This License applies to any program or other work which contains
241 a notice placed by the copyright holder saying it may be distributed
242 under the terms of this General Public License. The "Program", below,
243 refers to any such program or work, and a "work based on the Program"
244 means either the Program or any derivative work under copyright law:
245 that is to say, a work containing the Program or a portion of it,
246 either verbatim or with modifications and/or translated into another
247 language. (Hereinafter, translation is included without limitation in
248 the term "modification".) Each licensee is addressed as "you".
249
250 Activities other than copying, distribution and modification are not
251 covered by this License; they are outside its scope. The act of
252 running the Program is not restricted, and the output from the Program
253 is covered only if its contents constitute a work based on the
254 Program (independent of having been made by running the Program).
255 Whether that is true depends on what the Program does.
256
257 1. You may copy and distribute verbatim copies of the Program's
258 source code as you receive it, in any medium, provided that you
259 conspicuously and appropriately publish on each copy an appropriate
260 copyright notice and disclaimer of warranty; keep intact all the
261 notices that refer to this License and to the absence of any warranty;
262 and give any other recipients of the Program a copy of this License
263 along with the Program.
264
265 You may charge a fee for the physical act of transferring a copy, and
266 you may at your option offer warranty protection in exchange for a fee.
267
268 2. You may modify your copy or copies of the Program or any portion
269 of it, thus forming a work based on the Program, and copy and
270 distribute such modifications or work under the terms of Section 1
271 above, provided that you also meet all of these conditions:
272
273 a) You must cause the modified files to carry prominent notices
274 stating that you changed the files and the date of any change.
275
276 b) You must cause any work that you distribute or publish, that in
277 whole or in part contains or is derived from the Program or any
278 part thereof, to be licensed as a whole at no charge to all third
279 parties under the terms of this License.
280
281 c) If the modified program normally reads commands interactively
282 when run, you must cause it, when started running for such
283 interactive use in the most ordinary way, to print or display an
284 announcement including an appropriate copyright notice and a
285 notice that there is no warranty (or else, saying that you provide
286 a warranty) and that users may redistribute the program under
287 these conditions, and telling the user how to view a copy of this
288 License. (Exception: if the Program itself is interactive but
289 does not normally print such an announcement, your work based on
290 the Program is not required to print an announcement.)
291
292 These requirements apply to the modified work as a whole. If
293 identifiable sections of that work are not derived from the Program,
294 and can be reasonably considered independent and separate works in
295 themselves, then this License, and its terms, do not apply to those
296 sections when you distribute them as separate works. But when you
297 distribute the same sections as part of a whole which is a work based
298 on the Program, the distribution of the whole must be on the terms of
299 this License, whose permissions for other licensees extend to the
300 entire whole, and thus to each and every part regardless of who wrote it.
301
302 Thus, it is not the intent of this section to claim rights or contest
303 your rights to work written entirely by you; rather, the intent is to
304 exercise the right to control the distribution of derivative or
305 collective works based on the Program.
306
307 In addition, mere aggregation of another work not based on the Program
308 with the Program (or with a work based on the Program) on a volume of
309 a storage or distribution medium does not bring the other work under
310 the scope of this License.
311
312 3. You may copy and distribute the Program (or a work based on it,
313 under Section 2) in object code or executable form under the terms of
314 Sections 1 and 2 above provided that you also do one of the following:
315
316 a) Accompany it with the complete corresponding machine-readable
317 source code, which must be distributed under the terms of Sections
318 1 and 2 above on a medium customarily used for software interchange; or,
319
320 b) Accompany it with a written offer, valid for at least three
321 years, to give any third party, for a charge no more than your
322 cost of physically performing source distribution, a complete
323 machine-readable copy of the corresponding source code, to be
324 distributed under the terms of Sections 1 and 2 above on a medium
325 customarily used for software interchange; or,
326
327 c) Accompany it with the information you received as to the offer
328 to distribute corresponding source code. (This alternative is
329 allowed only for noncommercial distribution and only if you
330 received the program in object code or executable form with such
331 an offer, in accord with Subsection b above.)
332
333 The source code for a work means the preferred form of the work for
334 making modifications to it. For an executable work, complete source
335 code means all the source code for all modules it contains, plus any
336 associated interface definition files, plus the scripts used to
337 control compilation and installation of the executable. However, as a
338 special exception, the source code distributed need not include
339 anything that is normally distributed (in either source or binary
340 form) with the major components (compiler, kernel, and so on) of the
341 operating system on which the executable runs, unless that component
342 itself accompanies the executable.
343
344 If distribution of executable or object code is made by offering
345 access to copy from a designated place, then offering equivalent
346 access to copy the source code from the same place counts as
347 distribution of the source code, even though third parties are not
348 compelled to copy the source along with the object code.
349
350 4. You may not copy, modify, sublicense, or distribute the Program
351 except as expressly provided under this License. Any attempt
352 otherwise to copy, modify, sublicense or distribute the Program is
353 void, and will automatically terminate your rights under this License.
354 However, parties who have received copies, or rights, from you under
355 this License will not have their licenses terminated so long as such
356 parties remain in full compliance.
357
358 5. You are not required to accept this License, since you have not
359 signed it. However, nothing else grants you permission to modify or
360 distribute the Program or its derivative works. These actions are
361 prohibited by law if you do not accept this License. Therefore, by
362 modifying or distributing the Program (or any work based on the
363 Program), you indicate your acceptance of this License to do so, and
364 all its terms and conditions for copying, distributing or modifying
365 the Program or works based on it.
366
367 6. Each time you redistribute the Program (or any work based on the
368 Program), the recipient automatically receives a license from the
369 original licensor to copy, distribute or modify the Program subject to
370 these terms and conditions. You may not impose any further
371 restrictions on the recipients' exercise of the rights granted herein.
372 You are not responsible for enforcing compliance by third parties to
373 this License.
374
375 7. If, as a consequence of a court judgment or allegation of patent
376 infringement or for any other reason (not limited to patent issues),
377 conditions are imposed on you (whether by court order, agreement or
378 otherwise) that contradict the conditions of this License, they do not
379 excuse you from the conditions of this License. If you cannot
380 distribute so as to satisfy simultaneously your obligations under this
381 License and any other pertinent obligations, then as a consequence you
382 may not distribute the Program at all. For example, if a patent
383 license would not permit royalty-free redistribution of the Program by
384 all those who receive copies directly or indirectly through you, then
385 the only way you could satisfy both it and this License would be to
386 refrain entirely from distribution of the Program.
387
388 If any portion of this section is held invalid or unenforceable under
389 any particular circumstance, the balance of the section is intended to
390 apply and the section as a whole is intended to apply in other
391 circumstances.
392
393 It is not the purpose of this section to induce you to infringe any
394 patents or other property right claims or to contest validity of any
395 such claims; this section has the sole purpose of protecting the
396 integrity of the free software distribution system, which is
397 implemented by public license practices. Many people have made
398 generous contributions to the wide range of software distributed
399 through that system in reliance on consistent application of that
400 system; it is up to the author/donor to decide if he or she is willing
401 to distribute software through any other system and a licensee cannot
402 impose that choice.
403
404 This section is intended to make thoroughly clear what is believed to
405 be a consequence of the rest of this License.
406
407 8. If the distribution and/or use of the Program is restricted in
408 certain countries either by patents or by copyrighted interfaces, the
409 original copyright holder who places the Program under this License
410 may add an explicit geographical distribution limitation excluding
411 those countries, so that distribution is permitted only in or among
412 countries not thus excluded. In such case, this License incorporates
413 the limitation as if written in the body of this License.
414
415 9. The Free Software Foundation may publish revised and/or new versions
416 of the General Public License from time to time. Such new versions will
417 be similar in spirit to the present version, but may differ in detail to
418 address new problems or concerns.
419
420 Each version is given a distinguishing version number. If the Program
421 specifies a version number of this License which applies to it and "any
422 later version", you have the option of following the terms and conditions
423 either of that version or of any later version published by the Free
424 Software Foundation. If the Program does not specify a version number of
425 this License, you may choose any version ever published by the Free Software
426 Foundation.
427
428 10. If you wish to incorporate parts of the Program into other free
429 programs whose distribution conditions are different, write to the author
430 to ask for permission. For software which is copyrighted by the Free
431 Software Foundation, write to the Free Software Foundation; we sometimes
432 make exceptions for this. Our decision will be guided by the two goals
433 of preserving the free status of all derivatives of our free software and
434 of promoting the sharing and reuse of software generally.
435
436 NO WARRANTY
437
438 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
439 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
440 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
441 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
442 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
443 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
444 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
445 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
446 REPAIR OR CORRECTION.
447
448 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
449 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
450 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
451 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
452 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
453 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
454 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
455 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
456 POSSIBILITY OF SUCH DAMAGES.
457
458 END OF TERMS AND CONDITIONS
459
460 Appendix: How to Apply These Terms to Your New Programs
461
462 If you develop a new program, and you want it to be of the greatest
463 possible use to the public, the best way to achieve this is to make it
464 free software which everyone can redistribute and change under these terms.
465
466 To do so, attach the following notices to the program. It is safest
467 to attach them to the start of each source file to most effectively
468 convey the exclusion of warranty; and each file should have at least
469 the "copyright" line and a pointer to where the full notice is found.
470
471 <one line to give the program's name and a brief idea of what it does.>
472 Copyright (C) 19yy <name of author>
473
474 This program is free software; you can redistribute it and/or modify
475 it under the terms of the GNU General Public License as published by
476 the Free Software Foundation; either version 2 of the License, or
477 (at your option) any later version.
478
479 This program is distributed in the hope that it will be useful,
480 but WITHOUT ANY WARRANTY; without even the implied warranty of
481 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
482 GNU General Public License for more details.
483
484 You should have received a copy of the GNU General Public License
485 along with this program; if not, write to the Free Software
486 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
487
488 Also add information on how to contact you by electronic and paper mail.
489
490 If the program is interactive, make it output a short notice like this
491 when it starts in an interactive mode:
492
493 Gnomovision version 69, Copyright (C) 19yy name of author
494 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
495 This is free software, and you are welcome to redistribute it
496 under certain conditions; type `show c' for details.
497
498 The hypothetical commands `show w' and `show c' should show the appropriate
499 parts of the General Public License. Of course, the commands you use may
500 be called something other than `show w' and `show c'; they could even be
501 mouse-clicks or menu items--whatever suits your program.
502
503 You should also get your employer (if you work as a programmer) or your
504 school, if any, to sign a "copyright disclaimer" for the program, if
505 necessary. Here is a sample; alter the names:
506
507 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
508 `Gnomovision' (which makes passes at compilers) written by James Hacker.
509
510 <signature of Ty Coon>, 1 April 1989
511 Ty Coon, President of Vice
512
513 This General Public License does not permit incorporating your program into
514 proprietary programs. If your program is a subroutine library, you may
515 consider it more useful to permit linking proprietary applications with the
516 library. If this is what you want to do, use the GNU Library General
517 Public License instead of this License.
518
519 ================================================================================