Introduce NVef, NVff, and NVgf, use the middle one.
[perl.git] / README.amiga
1 If you read this file _as_is_, just ignore the funny characters you
2 see. It is written in the POD format (see perlpod manpage) which is
3 specially designed to be readable as is.
4
5 =head1 NAME
6
7 perlamiga - Perl under Amiga OS (possibly very outdated information)
8
9 =head1 SYNOPSIS
10
11 NOTE: No one has reported building Perl on the Amiga in a long
12 time.  The following information is highly unlikely to be correct.
13 If you would like to help the Amiga port to stay current, see:
14
15     http://us.aminet.net/aminet/dirs/dev_gg.html
16
17 for Amiga resources and information.
18
19 One can read this document in the following formats:
20
21         man perlamiga
22         multiview perlamiga.guide
23
24 to list some (not all may be available simultaneously), or it may
25 be read I<as is>: either as F<README.amiga>, or F<pod/perlamiga.pod>.
26
27 =cut
28
29 Contents
30  
31  perlamiga - Perl under Amiga OS
32
33        NAME 
34        SYNOPSIS 
35        DESCRIPTION 
36          -  Prerequisites 
37          -  Starting Perl programs under AmigaOS
38          -  Shortcomings of Perl under AmigaOS
39        INSTALLATION 
40        Accessing documentation 
41          -  Manpages 
42          -  HTML 
43          -  GNU info files 
44          -  LaTeX docs 
45        BUILD 
46          -  Prerequisites 
47          -  Getting the perl source 
48          -  Application of the patches 
49          -  Making 
50          -  Testing 
51          -  Installing the built perl 
52        AUTHOR 
53        SEE ALSO 
54
55 =head1 DESCRIPTION
56
57 =head2 Prerequisites
58
59 =over 6
60
61 =item B<Unix emulation for AmigaOS: ixemul.library>
62
63 You need the Unix emulation for AmigaOS, whose most important part is
64 B<ixemul.library>. For a minimum setup, get the following archives from
65 ftp://ftp.ninemoons.com/pub/ade/current or a mirror:
66
67 ixemul-46.0-bin.lha
68 ixemul-46.0-env-bin.lha
69 pdksh-4.9-bin.lha
70 ADE-misc-bin.lha
71
72 Note that there might be newer versions available by the time you read
73 this.
74
75 Note also that this is a minimum setup; you might want to add other
76 packages of B<ADE> (the I<Amiga Developers Environment>).
77
78 =item B<Version of Amiga OS>
79
80 You need at the very least AmigaOS version 2.0. Recommended is version 3.1.
81
82 =back
83
84 =head2 Starting Perl programs under AmigaOS
85
86 Start your Perl program F<foo> with arguments C<arg1 arg2 arg3> the
87 same way as on any other platform, by
88
89         perl foo arg1 arg2 arg3
90
91 If you want to specify perl options C<-my_opts> to the perl itself (as
92 opposed to to your program), use
93
94         perl -my_opts foo arg1 arg2 arg3
95
96 Alternately, you can try to get a replacement for the system's B<Execute>
97 command that honors the #!/usr/bin/perl syntax in scripts and set the s-Bit
98 of your scripts. Then you can invoke your scripts like under UNIX with
99
100         foo arg1 arg2 arg3
101
102 (Note that having *nixish full path to perl F</usr/bin/perl> is not
103 necessary, F<perl> would be enough, but having full path would make it
104 easier to use your script under *nix.)
105
106 =head2 Shortcomings of Perl under AmigaOS
107
108 Perl under AmigaOS lacks some features of perl under UNIX because of
109 deficiencies in the UNIX-emulation, most notably:
110
111 =over 6
112
113 =item fork()
114
115 =item some features of the UNIX filesystem regarding link count and file dates
116
117 =item inplace operation (the -i switch) without backup file
118
119 =item umask() works, but the correct permissions are only set when the file is
120       finally close()d
121
122 =back
123
124 =head1 INSTALLATION
125
126 Change to the installation directory (most probably ADE:), and
127 extract the binary distribution:
128
129 lha -mraxe x perl-5.003-bin.lha
130
131 or
132
133 tar xvzpf perl-5.003-bin.tgz
134
135 (Of course you need lha or tar and gunzip for this.)
136
137 For installation of the Unix emulation, read the appropriate docs.
138
139 =head1 Accessing documentation
140
141 =head2 Manpages
142
143 If you have C<man> installed on your system, and you installed perl
144 manpages, use something like this:
145
146         man perlfunc
147         man less
148         man ExtUtils.MakeMaker
149
150 to access documentation for different components of Perl. Start with
151
152         man perl
153
154 Note: You have to modify your man.conf file to search for manpages
155 in the /ade/lib/perl5/man/man3 directory, or the man pages for the
156 perl library will not be found. 
157
158 Note that dot (F<.>) is used as a package separator for documentation
159 for packages, and as usual, sometimes you need to give the section - C<3>
160 above - to avoid shadowing by the I<less(1) manpage>.
161
162
163 =head2 B<HTML>
164
165 If you have some WWW browser available, you can build B<HTML> docs.
166 Cd to directory with F<.pod> files, and do like this
167
168         cd /ade/lib/perl5/pod
169         pod2html
170
171 After this you can direct your browser the file F<perl.html> in this
172 directory, and go ahead with reading docs.
173
174 Alternatively you may be able to get these docs prebuilt from C<CPAN>.
175
176 =head2 B<GNU> C<info> files
177
178 Users of C<Emacs> would appreciate it very much, especially with
179 C<CPerl> mode loaded. You need to get latest C<pod2info> from C<CPAN>,
180 or, alternately, prebuilt info pages.
181
182 =head2 C<LaTeX> docs
183
184 can be constructed using C<pod2latex>.
185
186 =head1 BUILD
187
188 Here we discuss how to build Perl under AmigaOS.
189
190 =head2 Prerequisites
191
192 You need to have the latest B<ADE> (Amiga Developers Environment)
193 from ftp://ftp.ninemoons.com/pub/ade/current.
194 Also, you need a lot of free memory, probably at least 8MB.
195
196 =head2 Getting the perl source
197
198 You can either get the latest perl-for-amiga source from Ninemoons
199 and extract it with:
200
201   tar xvzpf perl-5.004-src.tgz
202
203 or get the official source from CPAN:
204
205   http://www.perl.com/CPAN/src/5.0
206
207 Extract it like this
208
209   tar xvzpf perl5.004.tar.gz
210
211 You will see a message about errors while extracting F<Configure>. This
212 is normal and expected. (There is a conflict with a similarly-named file
213 F<configure>, but it causes no harm.)
214
215 =head2 Making
216
217   sh configure.gnu --prefix=/ade
218
219 Now
220
221   make
222
223 =head2 Testing
224
225 Now run
226
227   make test
228
229 Some tests will be skipped because they need the fork() function:
230
231 F<io/pipe.t>, F<op/fork.t>, F<lib/filehand.t>, F<lib/open2.t>, F<lib/open3.t>, 
232 F<lib/io_pipe.t>, F<lib/io_sock.t>
233
234 =head2 Installing the built perl
235
236 Run
237
238   make install
239
240 =head1 AUTHOR
241
242 Norbert Pueschel, pueschel@imsdd.meb.uni-bonn.de
243
244 =head1 SEE ALSO
245
246 perl(1).
247
248 =cut