Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / awk / doc / igawk.1
1 .TH IGAWK 1 "Nov 3 1999" "Free Software Foundation" "Utility Commands"
2 .SH NAME
3 igawk \- gawk with include files
4 .SH SYNOPSIS
5 .B igawk
6 [ all
7 .I gawk
8 options ]
9 .B \-f
10 .I program-file
11 [
12 .B \-\^\-
13 ] file .\^.\^.
14 .br
15 .B igawk
16 [ all
17 .I gawk
18 options ]
19 [
20 .B \-\^\-
21 ]
22 .I program-text
23 file .\^.\^.
24 .SH DESCRIPTION
25 .I Igawk
26 is a simple shell script that adds the ability to have ``include files'' to
27 .IR gawk (1).
28 .PP
29 AWK programs for
30 .I igawk
31 are the same as for
32 .IR gawk ,
33 except that, in addition, you may have lines like
34 .RS
35 .sp
36 .ft B
37 @include getopt.awk
38 .ft R
39 .sp
40 .RE
41 in your program to include the file
42 .B getopt.awk
43 from either the current directory or one of the other directories
44 in the search path.
45 .SH OPTIONS
46 See
47 .IR gawk (1)
48 for a full description of the AWK language and the options that
49 .I gawk
50 supports.
51 .SH EXAMPLES
52 .nf
53 .ft B
54 cat << EOF > test.awk
55 @include getopt.awk
56 .sp
57 BEGIN {
58         while (getopt(ARGC, ARGV, "am:q") != \-1)
59                 \&.\^.\^.
60 }
61 EOF
62 .sp
63 igawk \-f test.awk
64 .ft R
65 .fi
66 .SH SEE ALSO
67 .IR gawk (1)
68 .PP
69 .IR "Effective AWK Programming" ,
70 Edition 1.0, published by the Free Software Foundation, 1995.
71 .SH AUTHOR
72 Arnold Robbins
73 .RB ( arnold@skeeve.com ).