awk/README.md

97 lines
3.2 KiB
Markdown
Raw Normal View History

2019-12-11 13:52:54 -05:00
# The One True Awk
This is the version of `awk` described in _The AWK Programming Language_,
by Al Aho, Brian Kernighan, and Peter Weinberger
(Addison-Wesley, 1988, ISBN 0-201-07981-X).
## Copyright
2020-01-01 15:45:04 -05:00
Copyright (C) Lucent Technologies 1997<br/>
2012-12-22 10:35:39 -05:00
All Rights Reserved
Permission to use, copy, modify, and distribute this software and
its documentation for any purpose and without fee is hereby
granted, provided that the above copyright notice appear in all
copies and that both that the copyright notice and this
permission notice and warranty disclaimer appear in supporting
documentation, and that the name Lucent Technologies or any of
its entities not be used in advertising or publicity pertaining
to distribution of the software without specific, written prior
permission.
LUCENT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.
IN NO EVENT SHALL LUCENT OR ANY OF ITS ENTITIES BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.
2019-12-11 13:52:54 -05:00
## Distribution and Reporting Problems
2012-12-22 10:35:39 -05:00
Changes, mostly bug fixes and occasional enhancements, are listed
2019-12-11 13:52:54 -05:00
in `FIXES`. If you distribute this code further, please please please
distribute `FIXES` with it.
If you find errors, please report them
to bwk@cs.princeton.edu.
Please _also_ open an issue in the GitHub issue tracker, to make
it easy to track issues.
Thanks.
## Submitting Pull Requests
Pull requests are welcome. However, please create them with a request
to merge into the `staging` branch instead of into the `master` branch.
This allows us to do testing, and to make any additional edits or changes
after the merge but before merging to `master`.
## Building
2012-12-22 10:35:39 -05:00
The program itself is created by
2019-12-11 13:52:54 -05:00
2012-12-22 10:35:39 -05:00
make
2019-12-11 13:52:54 -05:00
2012-12-22 10:35:39 -05:00
which should produce a sequence of messages roughly like this:
yacc -d awkgram.y
2019-12-11 13:52:54 -05:00
conflicts: 43 shift/reduce, 85 reduce/reduce
2012-12-22 10:35:39 -05:00
mv y.tab.c ytab.c
mv y.tab.h ytab.h
cc -c ytab.c
cc -c b.c
cc -c main.c
cc -c parse.c
cc maketab.c -o maketab
./maketab >proctab.c
cc -c proctab.c
cc -c tran.c
cc -c lib.c
cc -c run.c
cc -c lex.c
cc ytab.o b.o main.o parse.o proctab.o tran.o lib.o run.o lex.o -lm
2019-12-11 13:52:54 -05:00
This produces an executable `a.out`; you will eventually want to
move this to some place like `/usr/bin/awk`.
2012-12-22 10:35:39 -05:00
2019-12-11 13:52:54 -05:00
If your system does not have `yacc` or `bison` (the GNU
2020-01-01 15:45:04 -05:00
equivalent), you need to install one of them first.
2012-12-22 10:35:39 -05:00
2019-12-11 13:52:54 -05:00
NOTE: This version uses ANSI C (C 99), as you should also. We have
2019-12-11 14:15:38 -05:00
compiled this without any changes using `gcc -Wall` and/or local C
2012-12-22 10:35:39 -05:00
compilers on a variety of systems, but new systems or compilers
may raise some new complaint; reports of difficulties are
welcome.
2019-12-11 13:52:54 -05:00
This compiles without change on Macintosh OS X using `gcc` and
2012-12-22 10:35:39 -05:00
the standard developer tools.
2019-12-11 13:52:54 -05:00
The version of `malloc` that comes with some systems is sometimes
astonishly slow. If `awk` seems slow, you might try fixing that.
2012-12-22 10:35:39 -05:00
More generally, turning on optimization can significantly improve
2019-12-11 13:52:54 -05:00
`awk`'s speed, perhaps by 1/3 for highest levels.
2019-12-11 13:53:26 -05:00
#### Last Updated
2020-01-01 15:45:04 -05:00
Wed Jan 1 22:44:38 IST 2020