Introduced -devel and -extras subpackages for gawk
[platform/upstream/gawk.git] / README
1   Copyright (C) 2005, 2006, 2007, 2009, 2010, 2011, 2012
2   Free Software Foundation, Inc.
3   
4   Copying and distribution of this file, with or without modification,
5   are permitted in any medium without royalty provided the copyright
6   notice and this notice are preserved.
7
8 README:
9
10 This is GNU Awk 4.0.1. It is upwardly compatible with Brian Kernighan's
11 version of Unix awk.  It is almost completely compliant with the
12 2008 POSIX 1003.1 standard for awk. (See the note below about POSIX.)
13
14 This is a bug fix release. See NEWS and ChangeLog for details.
15
16 Work to be done is described briefly in the FUTURES file.  Changes in this
17 version are summarized in the NEWS file. Please read the LIMITATIONS file.
18
19 Read the file POSIX.STD for a discussion of issues where the standard
20 says one thing but gawk does something different.
21
22 To format the documentation with TeX, use at least version 2010-12-23.17
23 of texinfo.tex. There is a usable copy of texinfo.tex in the doc directory.
24
25 INSTALLATION:
26
27 Check whether there is a system-specific README file for your system under
28 the `README_d' directory.  If there's something there that you should
29 have read and didn't, and you bug me about it, I'm going to yell at you.
30
31 See the file INSTALL for installation instructions.
32
33 If you have neither bison nor yacc, use the awkgram.c file here.  It was
34 generated with bison, and has no proprietary code in it.  (Note that
35 modifying awkgram.y without bison or yacc will be difficult, at best.
36 You might want to get a copy of bison from the FSF too.)
37
38 If you have an MS-DOS, MS-Windows, or OS/2 system, use the stuff in the `pc'
39 directory.  Similarly, there is a separate directory for VMS.
40
41 Appendix B of ``GAWK: Effective Awk Programming'' discusses configuration
42 in detail. The configuration process is based on GNU Autoconf and
43 Automake.
44
45 After successful compilation, do `make check' to run the test suite.
46 There should be no output from the `cmp' invocations except in the
47 cases where there are small differences in floating point values, and
48 possibly in the case of strftime. Several of the tests ignore errors
49 on purpose; those are not a problem.  If there are other differences,
50 please investigate and report the problem.
51
52 PRINTING THE MANUAL
53
54 The `doc' directory contains a recent version of texinfo.tex, which will
55 be necessary for printing the manual.  Use `make dvi' to get a DVI file
56 from the manual. In the `doc' directory, use `make postscript' to get
57 PostScript versions of the manual, the man page, and the reference card.
58 Use `make pdf' to get PDF versions of the manuals, the man page and
59 the reference card.
60
61 BUG REPORTS AND FIXES (Un*x systems):
62
63 Please coordinate changes through Arnold Robbins. In particular, see
64 the section in the manual on reporting bugs. Note that comp.lang.awk
65 is about the worst place to post a gawk bug report. Please, use the
66 mechanisms outlined in the manual.
67
68 Email should be sent to bug-gawk@gnu.org.  This is now a separate mailing
69 list at GNU Central.  The advantage to using this address is that bug
70 reports are archived at GNU Central.
71
72 Arnold Robbins
73
74 BUG REPORTS AND FIXES, non-Unix systems:
75
76 MS-DOS with DJGPP:
77         Scott Deifik
78         scottd.mail@sbcglobal.net
79
80 MS-Windows with MinGW:
81         Eli Zaretskii
82         eliz@gnu.org
83
84 OS/2:
85         Andreas Buening
86         andreas.buening@nexgo.de
87
88 VMS:
89         Pat Rankin
90         r.pat.rankin@gmail.com
91
92 z/OS (OS/390):
93         Dave Pitts
94         dpitts@cozx.com