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