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