summaryrefslogtreecommitdiff
path: root/web/fweb/READ_ME-1.6x
blob: 62abccdf78f811b8cae850ae3ad46d1f8fe78c3e (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
			     FWEB version 1.6x
			    September 23, 1998

  (See the BUGS list at the end of this file.)

  FWEB v1.6x (where 'x' is a number like '3') is available via
anonymous ftp from

	ftp.pppl.gov:/pub/fweb/fweb-1.6x.tar.gz

This release is primarily intended to add support for large projects that
involve multiple web source files.  In particular, the indexes created by
weaving those files can be merged.

  To unpack the release,

	gunzip fweb-1.6x.tar.gz
	tar -xf fweb-1.6x.tar

or, if you have gnu tar,

	gtar -zxf fweb-1.6x.tar.gz

This creates the directory fweb-1.6x with the four subdirectories Boot,
Demos, Manual, and Web:

	Boot   --- Presently almost entirely useless; ignore it.
	Demos  --- Presently empty.
	Manual --- Documentation, style files, etc.
	Web    --- *.c and *.h files for installation; source code.

  Major points to note with this release are:

	* For detailed installation instructions, see the READ_ME.FWEB file
in the top-level directory of the release.

	* As fusion research in the U.S. collapses around us, time for
serious work on FWEB has been severely limited.  Nevertheless, it's
probably time to users to upgrade to Version 1.6.  There won't be another
release for a couple of years.

	* Executables for the IBM-PC are not yet provided.  

	* For a list of the principle new features with version 1.6x, see
the texinfo documentation, menu item `New Features'.


				   BUGS
			       Version 1.62

* The command-line option `-n!' MUST NOT be used if you reference ANY
built-in FWEB functions, such as $PI or $IF.  With that option, the
built-in functions will not be properly defined.  This is an egregious
mistake that I hope to correct soon.

* fweave is not presently fully compatible with ``Standard C++''---i.e.,
the first ANSI/ISO specification.  In particular, FWEB has no provision for
dealing with the scoping requirements introduced by namespaces.  In fact,
FWEB has little understanding of scope at all, so even in pre-Standard C++
the introduction of class types in a local scope isn't handled in a
sensible way by fweave.  That is, types (highlighted in boldface) once
defined remain defined for the duration of the code.

  It is feasible to fix most of this, but since several previous authors did
not have such scoping requirements in mind, the fix requires some real
work.  I hope to do that for the next major release (sometime in the next
century). 

* In Fortran codes, ftangle incorrectly indents the first module comment.

	Temporary fix:  Use either of `-Tv' or `-#'.

* Higher-order (> 127) characters in strings may or may not be processed
correctly.