~vcs-imports/gawk/master

« back to all changes in this revision

Viewing changes to README

  • Committer: Arnold D. Robbins
  • Date: 2010-07-16 09:41:09 UTC
  • Revision ID: git-v1:8c042f99cc7465c86351d21331a129111b75345d
Tags: gawk-3.0.0
Move to gawk-3.0.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
README:
2
2
 
3
 
This is GNU Awk 2.15. It should be upwardly compatible with the System
4
 
V Release 4 awk.  It is almost completely compliant with POSIX 1003.2.
 
3
This is GNU Awk 3.0. It should be upwardly compatible with the Bell
 
4
Labs research version of awk.  It is almost completely compliant with
 
5
the 1993 POSIX 1003.2 standard for awk.
5
6
 
6
7
This release adds new features -- see NEWS for details.
7
8
 
8
 
See the installation instructions, below.
 
9
See the file INSTALL for installation instructions.
9
10
 
10
11
Known problems are given in the PROBLEMS file.  Work to be done is
11
12
described briefly in the FUTURES file.  Verified ports are listed in
15
16
Read the file POSIX for a discussion of how the standard says comparisons
16
17
should be done vs. how they really should be done and how gawk does them.
17
18
  
18
 
To format the documentation with TeX, you must use texinfo.tex 2.53
19
 
or later.  Otherwise footnotes look unacceptable.
 
19
To format the documentation with TeX, use at least version 2.151 of
 
20
texinfo.tex. There is a usable copy of texinfo.tex in the doc directory.
20
21
 
21
 
If you wish to remake the Info files, you should use makeinfo. The 2.15 
22
 
version of makeinfo works with no errors.
 
22
The Info file now comes with the distribution.
23
23
 
24
24
The man page is up to date.
25
25
 
26
26
INSTALLATION:
27
27
 
28
 
Check whether there is a system-specific README file for your system.
29
 
 
30
 
A quick overview of the installation process is in the file INSTALL.
31
 
 
32
 
Makefile.in may need some tailoring.  The only changes necessary should
33
 
be to change installation targets or to change compiler flags.
34
 
The changes to make in Makefile.in are commented and should be obvious.
35
 
 
36
 
All other changes should be made in a config file.  Samples for
37
 
various systems are included in the config directory.  Starting with
38
 
2.11, our intent has been to make the code conform to standards (ANSI,
39
 
POSIX, SVID, in that order) whenever possible, and to not penalize
40
 
standard conforming systems.  We have included substitute versions of
41
 
routines not universally available.  Simply add the appropriate define
42
 
for the missing feature(s) on your system.
 
28
Check whether there is a system-specific README file for your system under
 
29
the `README_d' directory.
 
30
 
 
31
See the file INSTALL.
43
32
 
44
33
If you have neither bison nor yacc, use the awktab.c file here.  It was
45
 
generated with bison, and should have no AT&T code in it.  (Note that
46
 
modifying awk.y without bison or yacc will be difficult, at best.  You might
47
 
want to get a copy of bison from the FSF too.)
48
 
 
49
 
If no config file is included for your system,  start by copying one
50
 
for a similar system.  One way of determining the defines needed is to
51
 
try to load gawk with nothing defined and see what routines are
52
 
unresolved by the loader.  This should give you a good idea of how to
53
 
proceed.
54
 
 
55
 
The next release will use the FSF autoconfig program, so we are no longer 
56
 
soliciting new config files.
57
 
 
58
 
If you have an MS-DOS or OS/2 system, use the stuff in the pc directory.
59
 
For an Atari there is an atari directory and similarly one for VMS.
60
 
 
61
 
Chapter 16 of The GAWK Manual discusses configuration in detail.
62
 
(However, it does not discuss OS/2 configuration, see README.pc for
63
 
the details. The manual is being massively revised for 2.16.)
64
 
 
65
 
After successful compilation, do 'make test' to run a small test
 
34
generated with bison, and has no AT&T code in it.  (Note that modifying
 
35
awk.y without bison or yacc will be difficult, at best.  You might want
 
36
to get a copy of bison from the FSF too.)
 
37
  
 
38
If you have an MS-DOS or OS/2 system, use the stuff in the `pc' directory.
 
39
Similarly, there are separate directories for Ataris, Amigas, and VMS.
 
40
 
 
41
Appendix B of The GAWK Manual discusses configuration in detail. The
 
42
configuration process is now based on Autoconf, so the whole business
 
43
should be considerably simpler than it was in gawk 2.X.Y.
 
44
 
 
45
After successful compilation, do 'make check' to run a small test
66
46
suite.  There should be no output from the 'cmp' invocations except in
67
 
the cases where there are small differences in floating point values.
68
 
If there are other differences, please investigate and report the
69
 
problem.
 
47
the cases where there are small differences in floating point values,
 
48
and possibly in the case of strftime. Several of the tests ignore
 
49
errors on purpose; those are not a problem.  If there are other
 
50
differences, please investigate and report the problem.
70
51
 
71
52
PRINTING THE MANUAL
72
53
 
73
 
The 'support' directory contains texinfo.tex 2.115, which will be necessary
74
 
for printing the manual, and the texindex.c program from the texinfo
75
 
distribution which is also necessary.  See the makefile for the steps needed
76
 
to get a DVI file from the manual.
77
 
 
78
 
CAVEATS
79
 
 
80
 
The existence of a patchlevel.h file does *N*O*T* imply a commitment on
81
 
our part to issue bug fixes or patches.  It is there in case we should
82
 
decide to do so.
 
54
The 'doc' directory contains a recent version of texinfo.tex, which will be
 
55
necessary for printing the manual.  Use `make dvi' to get a DVI file from
 
56
the manual. In the `doc' directory, use `make postscript' to get a PostScript
 
57
version of the manual.
83
58
 
84
59
BUG REPORTS AND FIXES (Un*x systems):
85
60
 
86
 
Please coordinate changes through David Trueman and/or Arnold Robbins.
87
 
 
88
 
David Trueman
89
 
Department of Mathematics, Statistics and Computing Science,
90
 
Dalhousie University, Halifax, Nova Scotia, Canada
91
 
 
92
 
UUCP:           {uunet utai watmath}!dalcs!david
93
 
INTERNET:       david@cs.dal.ca
 
61
Please coordinate changes through Arnold Robbins. In particular, see
 
62
the section in the manual on reporting bugs. Note that comp.lang.awk is
 
63
about the worst place to post a gawk bug report. Please, use the mechanisms
 
64
outlined in the manual.
94
65
 
95
66
Arnold Robbins
96
 
1736 Reindeer Drive
97
 
Atlanta, GA, 30329-3528, USA
98
 
 
99
 
INTERNET:       arnold@skeeve.atl.ga.us
100
 
UUCP:           { gatech, emory, emoryu1 }!skeeve!arnold
 
67
INTERNET:       arnold@gnu.ai.mit.edu
101
68
 
102
69
BUG REPORTS AND FIXES (non-Unix ports):
103
70
 
104
71
MS-DOS:
105
72
        Scott Deifik
106
 
        AMGEN Inc.
107
 
        Amgen Center, Bldg.17-Dept.393
108
 
        Thousand Oaks, CA  91320-1789
109
 
        Tel-805-499-5725  ext.4677
110
 
        Fax-805-498-0358
111
73
        scottd@amgen.com
112
74
 
 
75
        Darrel Hankerson
 
76
        hankedr@mail.auburn.edu
 
77
 
113
78
VMS:
114
79
        Pat Rankin
115
 
        rankin@eql.caltech.edu (e-mail only)
 
80
        rankin@eql.caltech.edu
116
81
 
117
82
Atari ST:
118
83
        Michal Jaegermann
119
 
        michal@gortel.phys.ualberta.ca (e-mail only)
 
84
        michal@gortel.phys.ualberta.ca
120
85
 
121
86
OS/2:
122
87
        Kai Uwe Rommel
123
 
        rommel@ars.muc.de (e-mail only)
124
 
        Darrel Hankerson
125
 
        hankedr@mail.auburn.edu (e-mail only)
 
88
        rommel@ars.de
 
89
 
 
90
Amiga:
 
91
        Fred Fish
 
92
        fnf@amigalib.com