Pod typos, pod2man bugs, and miscellaneous installation comments
[perl.git] / x2p / a2p.pod
1 =head1 NAME
2
3 a2p - Awk to Perl translator
4
5 =head1 SYNOPSIS
6
7 B<a2p [options] filename>
8
9 =head1 DESCRIPTION
10
11 I<A2p> takes an awk script specified on the command line (or from
12 standard input) and produces a comparable I<perl> script on the
13 standard output.
14
15 =head2 Options
16
17 Options include:
18
19 =over 5
20
21 =item B<-DE<lt>numberE<gt>>
22
23 sets debugging flags.
24
25 =item B<-FE<lt>characterE<gt>>
26
27 tells a2p that this awk script is always invoked with this B<-F>
28 switch.
29
30 =item B<-nE<lt>fieldlistE<gt>>
31
32 specifies the names of the input fields if input does not have to be
33 split into an array.  If you were translating an awk script that
34 processes the password file, you might say:
35
36         a2p -7 -nlogin.password.uid.gid.gcos.shell.home
37
38 Any delimiter can be used to separate the field names.
39
40 =item B<-E<lt>numberE<gt>>
41
42 causes a2p to assume that input will always have that many fields.
43
44 =back
45
46 =head2 "Considerations"
47
48 A2p cannot do as good a job translating as a human would, but it
49 usually does pretty well.  There are some areas where you may want to
50 examine the perl script produced and tweak it some.  Here are some of
51 them, in no particular order.
52
53 There is an awk idiom of putting int() around a string expression to
54 force numeric interpretation, even though the argument is always
55 integer anyway.  This is generally unneeded in perl, but a2p can't
56 tell if the argument is always going to be integer, so it leaves it
57 in.  You may wish to remove it.
58
59 Perl differentiates numeric comparison from string comparison.  Awk
60 has one operator for both that decides at run time which comparison to
61 do.  A2p does not try to do a complete job of awk emulation at this
62 point.  Instead it guesses which one you want.  It's almost always
63 right, but it can be spoofed.  All such guesses are marked with the
64 comment "C<#???>".  You should go through and check them.  You might
65 want to run at least once with the B<-w> switch to perl, which will
66 warn you if you use == where you should have used eq.
67
68 Perl does not attempt to emulate the behavior of awk in which
69 nonexistent array elements spring into existence simply by being
70 referenced.  If somehow you are relying on this mechanism to create
71 null entries for a subsequent for...in, they won't be there in perl.
72
73 If a2p makes a split line that assigns to a list of variables that
74 looks like (Fld1, Fld2, Fld3...) you may want to rerun a2p using the
75 B<-n> option mentioned above.  This will let you name the fields
76 throughout the script.  If it splits to an array instead, the script
77 is probably referring to the number of fields somewhere.
78
79 The exit statement in awk doesn't necessarily exit; it goes to the END
80 block if there is one.  Awk scripts that do contortions within the END
81 block to bypass the block under such circumstances can be simplified
82 by removing the conditional in the END block and just exiting directly
83 from the perl script.
84
85 Perl has two kinds of array, numerically-indexed and associative.  Awk
86 arrays are usually translated to associative arrays, but if you happen
87 to know that the index is always going to be numeric you could change
88 the {...} to [...].  Iteration over an associative array is done using
89 the keys() function, but iteration over a numeric array is NOT.  You
90 might need to modify any loop that is iterating over the array in
91 question.
92
93 Awk starts by assuming OFMT has the value %.6g.  Perl starts by
94 assuming its equivalent, $#, to have the value %.20g.  You'll want to
95 set $# explicitly if you use the default value of OFMT.
96
97 Near the top of the line loop will be the split operation that is
98 implicit in the awk script.  There are times when you can move this
99 down past some conditionals that test the entire record so that the
100 split is not done as often.
101
102 For aesthetic reasons you may wish to change the array base $[ from 1
103 back to perl's default of 0, but remember to change all array
104 subscripts AND all substr() and index() operations to match.
105
106 Cute comments that say "# Here is a workaround because awk is dumb"
107 are passed through unmodified.
108
109 Awk scripts are often embedded in a shell script that pipes stuff into
110 and out of awk.  Often the shell script wrapper can be incorporated
111 into the perl script, since perl can start up pipes into and out of
112 itself, and can do other things that awk can't do by itself.
113
114 Scripts that refer to the special variables RSTART and RLENGTH can
115 often be simplified by referring to the variables $`, $& and $', as
116 long as they are within the scope of the pattern match that sets them.
117
118 The produced perl script may have subroutines defined to deal with
119 awk's semantics regarding getline and print.  Since a2p usually picks
120 correctness over efficiency.  it is almost always possible to rewrite
121 such code to be more efficient by discarding the semantic sugar.
122
123 For efficiency, you may wish to remove the keyword from any return
124 statement that is the last statement executed in a subroutine.  A2p
125 catches the most common case, but doesn't analyze embedded blocks for
126 subtler cases.
127
128 ARGV[0] translates to $ARGV0, but ARGV[n] translates to $ARGV[$n].  A
129 loop that tries to iterate over ARGV[0] won't find it.
130
131 =head1 ENVIRONMENT
132
133 A2p uses no environment variables.
134
135 =head1 AUTHOR
136
137 Larry Wall E<lt>F<lwall@jpl-devvax.Jpl.Nasa.Gov>E<gt>
138
139 =head1 FILES
140
141 =head1 SEE ALSO
142
143  perl   The perl compiler/interpreter
144  
145  s2p    sed to perl translator
146
147 =head1 DIAGNOSTICS
148
149 =head1 BUGS
150
151 It would be possible to emulate awk's behavior in selecting string
152 versus numeric operations at run time by inspection of the operands,
153 but it would be gross and inefficient.  Besides, a2p almost always
154 guesses right.
155
156 Storage for the awk syntax tree is currently static, and can run out.