[perl5.git] / README.amiga

If you read this file _as_is_, just ignore the funny characters you
see. It is written in the POD format (see perlpod manpage) which is
specially designed to be readable as is.

=head1 NAME

perlamiga - Perl under Amiga OS

=head1 SYNOPSIS

One can read this document in the following formats:

	man perlamiga
	multiview perlamiga.guide

to list some (not all may be available simultaneously), or it may
be read I<as is>: either as F<README.amiga>, or F<pod/perlamiga.pod>.

A recent version of perl for the Amiga can be found at the Geek Gadgets
section of the Aminet:
  
      http://www.aminet.net/~aminet/dirs/dev_gg.html

=cut

Contents
 
 perlamiga - Perl under Amiga OS

       NAME 
       SYNOPSIS 
       DESCRIPTION 
         -  Prerequisites 
         -  Starting Perl programs under AmigaOS
         -  Shortcomings of Perl under AmigaOS
       INSTALLATION 
       Accessing documentation 
         -  Manpages 
         -  HTML 
         -  GNU info files 
         -  LaTeX docs 
       BUILD 
         -  Prerequisites 
         -  Getting the perl source 
         -  Application of the patches 
         -  Making 
         -  Testing 
         -  Installing the built perl 
       AUTHOR 
       SEE ALSO 

=head1 DESCRIPTION

=head2 Prerequisites

=over 6

=item B<Unix emulation for AmigaOS: ixemul.library>

You need the Unix emulation for AmigaOS, whose most important part is
B<ixemul.library>. For a minimum setup, get the latest versions
of the following packages from the Aminet archives (http://www.aminet.net/~aminet/):

	ixemul-bin
	ixemul-env-bin
	pdksh-bin

Note also that this is a minimum setup; you might want to add other
packages of B<ADE> (the I<Amiga Developers Environment>).

=item B<Version of Amiga OS>

You need at the very least AmigaOS version 2.0. Recommended is version 3.1.

=back

=head2 Starting Perl programs under AmigaOS

Start your Perl program F<foo> with arguments C<arg1 arg2 arg3> the
same way as on any other platform, by

	perl foo arg1 arg2 arg3

If you want to specify perl options C<-my_opts> to the perl itself (as
opposed to to your program), use

	perl -my_opts foo arg1 arg2 arg3

Alternately, you can try to get a replacement for the system's B<Execute>
command that honors the #!/usr/bin/perl syntax in scripts and set the s-Bit
of your scripts. Then you can invoke your scripts like under UNIX with

	foo arg1 arg2 arg3

(Note that having *nixish full path to perl F</usr/bin/perl> is not
necessary, F<perl> would be enough, but having full path would make it
easier to use your script under *nix.)

=head2 Shortcomings of Perl under AmigaOS

Perl under AmigaOS lacks some features of perl under UNIX because of
deficiencies in the UNIX-emulation, most notably:

=over 6

=item fork()

=item some features of the UNIX filesystem regarding link count and file dates

=item inplace operation (the -i switch) without backup file

=item umask() works, but the correct permissions are only set when the file is
      finally close()d

=back

=head1 INSTALLATION

Change to the installation directory (most probably ADE:), and
extract the binary distribution:

lha -mraxe x perl-$VERSION-bin.lha

or

tar xvzpf perl-$VERSION-bin.tgz

(Of course you need lha or tar and gunzip for this.)

For installation of the Unix emulation, read the appropriate docs.

=head1 Accessing documentation

=head2 Manpages

If you have C<man> installed on your system, and you installed perl
manpages, use something like this:

	man perlfunc
	man less
	man ExtUtils.MakeMaker

to access documentation for different components of Perl. Start with

	man perl

Note: You have to modify your man.conf file to search for manpages
in the /ade/lib/perl5/man/man3 directory, or the man pages for the
perl library will not be found. 

Note that dot (F<.>) is used as a package separator for documentation
for packages, and as usual, sometimes you need to give the section - C<3>
above - to avoid shadowing by the I<less(1) manpage>.


=head2 B<HTML>

If you have some WWW browser available, you can build B<HTML> docs.
Cd to directory with F<.pod> files, and do like this

	cd /ade/lib/perl5/pod
	pod2html

After this you can direct your browser the file F<perl.html> in this
directory, and go ahead with reading docs.

Alternatively you may be able to get these docs prebuilt from C<CPAN>.

=head2 B<GNU> C<info> files

Users of C<Emacs> would appreciate it very much, especially with
C<CPerl> mode loaded. You need to get latest C<pod2info> from C<CPAN>,
or, alternately, prebuilt info pages.

=head2 C<LaTeX> docs

can be constructed using C<pod2latex>.

=head1 BUILD

Here we discuss how to build Perl under AmigaOS.

=head2 Prerequisites

You need to have the latest B<ixemul> (Unix emulation for Amiga)
from Aminet.

=head2 Getting the perl source

You can either get the latest perl-for-amiga source from Ninemoons
and extract it with:

  tar xvzpf perl-$VERSION-src.tgz

or get the official source from CPAN:

  http://www.perl.com/CPAN/src/5.0

Extract it like this

  tar xvzpf perl-$VERSION.tar.gz

You will see a message about errors while extracting F<Configure>. This
is normal and expected. (There is a conflict with a similarly-named file
F<configure>, but it causes no harm.)

=head2 Making

=over 4

=item *

remember to use a healthy sized stack (I used 2000000)

=item *

your PATH environment variable must include /bin (e.g. ".:/bin" is good)
(or, more precisely, it must include the directory where you have your
basic UNIX utilities like test, cat, sed, and so on)

=item *
	
  sh Configure -Dprefix=/ade -Dloclibpth=/ade/lib

=item *

now type make depend

	when the make depend has ended load the gnumakefile into a editor and
	go to the end of the file
	move upwards in the file until you reach av.o: EXTERN.h
	and delete all lines down to # WARNING: Put....

=item *

now go to the x2p directory

	load the gnumakefile
	go to the end moveup until you reach hash.o: EXTERN.h
	and delete all lines dowonwards until you reach
	# WARNING: Put nothing....

=item *

Now!

  make

=back

=head2 Testing

Now run

  make test

Some tests will be skipped because they need the fork() function:

F<io/pipe.t>, F<op/fork.t>, F<lib/filehand.t>, F<lib/open2.t>, F<lib/open3.t>, 
F<lib/io_pipe.t>, F<lib/io_sock.t>

=head2 Installing the built perl

Run

  make install

=head1 AUTHORS

Norbert Pueschel, pueschel@imsdd.meb.uni-bonn.de
Jan-Erik Karlsson, trg@privat.utfors.se

=head1 SEE ALSO

perl(1).

=cut
Commit	Line	Data
0a753a76	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
c0c066b9	7	perlamiga - Perl under Amiga OS
0a753a76	8
	9	=head1 SYNOPSIS
	10
	11	One can read this document in the following formats:
	12
	13	man perlamiga
	14	multiview perlamiga.guide
	15
	16	to list some (not all may be available simultaneously), or it may
	17	be read I<as is>: either as F<README.amiga>, or F<pod/perlamiga.pod>.
	18
c0c066b9 JH	19	A recent version of perl for the Amiga can be found at the Geek Gadgets
	20	section of the Aminet:
	21
	22	http://www.aminet.net/~aminet/dirs/dev_gg.html
	23
0a753a76	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
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
	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
c0c066b9 JH	61	B<ixemul.library>. For a minimum setup, get the latest versions
c0c066b9 JH	62	of the following packages from the Aminet archives (http://www.aminet.net/~aminet/):
0a753a76	63
c0c066b9 JH	64	ixemul-bin
	65	ixemul-env-bin
	66	pdksh-bin
0a753a76	67
	68	Note also that this is a minimum setup; you might want to add other
	69	packages of B<ADE> (the I<Amiga Developers Environment>).
	70
	71	=item B<Version of Amiga OS>
	72
	73	You 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
	79	Start your Perl program F<foo> with arguments C<arg1 arg2 arg3> the
	80	same way as on any other platform, by
	81
	82	perl foo arg1 arg2 arg3
	83
	84	If you want to specify perl options C<-my_opts> to the perl itself (as
	85	opposed to to your program), use
	86
	87	perl -my_opts foo arg1 arg2 arg3
	88
	89	Alternately, you can try to get a replacement for the system's B<Execute>
	90	command that honors the #!/usr/bin/perl syntax in scripts and set the s-Bit
	91	of 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
	96	necessary, F<perl> would be enough, but having full path would make it
	97	easier to use your script under *nix.)
	98
b971f6e4	99	=head2 Shortcomings of Perl under AmigaOS
	100
	101	Perl under AmigaOS lacks some features of perl under UNIX because of
	102	deficiencies in the UNIX-emulation, most notably:
	103
	104	=over 6
	105
	106	=item fork()
	107
	108	=item some features of the UNIX filesystem regarding link count and file dates
	109
	110	=item inplace operation (the -i switch) without backup file
	111
	112	=item umask() works, but the correct permissions are only set when the file is
	113	finally close()d
0498d68d	114
b971f6e4	115	=back
b971f6e4	116
0a753a76	117	=head1 INSTALLATION
	118
	119	Change to the installation directory (most probably ADE:), and
	120	extract the binary distribution:
	121
f23f9bed	122	lha -mraxe x perl-$VERSION-bin.lha
0a753a76	123
	124	or
	125
f23f9bed	126	tar xvzpf perl-$VERSION-bin.tgz
0a753a76	127
	128	(Of course you need lha or tar and gunzip for this.)
	129
	130	For installation of the Unix emulation, read the appropriate docs.
	131
	132	=head1 Accessing documentation
	133
	134	=head2 Manpages
	135
	136	If you have C<man> installed on your system, and you installed perl
	137	manpages, use something like this:
	138
	139	man perlfunc
	140	man less
	141	man ExtUtils.MakeMaker
	142
	143	to access documentation for different components of Perl. Start with
	144
	145	man perl
	146
	147	Note: You have to modify your man.conf file to search for manpages
	148	in the /ade/lib/perl5/man/man3 directory, or the man pages for the
	149	perl library will not be found.
	150
	151	Note that dot (F<.>) is used as a package separator for documentation
	152	for packages, and as usual, sometimes you need to give the section - C<3>
	153	above - to avoid shadowing by the I<less(1) manpage>.
	154
	155
	156	=head2 B<HTML>
	157
	158	If you have some WWW browser available, you can build B<HTML> docs.
	159	Cd to directory with F<.pod> files, and do like this
	160
	161	cd /ade/lib/perl5/pod
	162	pod2html
	163
	164	After this you can direct your browser the file F<perl.html> in this
	165	directory, and go ahead with reading docs.
	166
	167	Alternatively you may be able to get these docs prebuilt from C<CPAN>.
	168
	169	=head2 B<GNU> C<info> files
	170
	171	Users of C<Emacs> would appreciate it very much, especially with
	172	C<CPerl> mode loaded. You need to get latest C<pod2info> from C<CPAN>,
	173	or, alternately, prebuilt info pages.
	174
	175	=head2 C<LaTeX> docs
	176
	177	can be constructed using C<pod2latex>.
	178
	179	=head1 BUILD
	180
	181	Here we discuss how to build Perl under AmigaOS.
	182
	183	=head2 Prerequisites
	184
f23f9bed SP	185	You need to have the latest B<ixemul> (Unix emulation for Amiga)
f23f9bed SP	186	from Aminet.
0a753a76	187
	188	=head2 Getting the perl source
	189
	190	You can either get the latest perl-for-amiga source from Ninemoons
	191	and extract it with:
	192
f23f9bed	193	tar xvzpf perl-$VERSION-src.tgz
0a753a76	194
	195	or get the official source from CPAN:
	196
	197	http://www.perl.com/CPAN/src/5.0
	198
	199	Extract it like this
	200
c0c066b9	201	tar xvzpf perl-$VERSION.tar.gz
0a753a76	202
	203	You will see a message about errors while extracting F<Configure>. This
	204	is normal and expected. (There is a conflict with a similarly-named file
	205	F<configure>, but it causes no harm.)
	206
	207	=head2 Making
b8e4d24f	208
c0c066b9 JH	209	=over 4
	210
	211	=item *
	212
	213	remember to use a healthy sized stack (I used 2000000)
	214
	215	=item *
	216
	217	your PATH environment variable must include /bin (e.g. ".:/bin" is good)
	218	(or, more precisely, it must include the directory where you have your
	219	basic UNIX utilities like test, cat, sed, and so on)
	220
	221	=item *
	222
	223	sh Configure -Dprefix=/ade -Dloclibpth=/ade/lib
0a753a76	224
c0c066b9	225	=item *
0a753a76	226
c0c066b9 JH	227	now type make depend
	228
	229	when the make depend has ended load the gnumakefile into a editor and
	230	go to the end of the file
	231	move upwards in the file until you reach av.o: EXTERN.h
	232	and delete all lines down to # WARNING: Put....
	233
	234	=item *
	235
	236	now go to the x2p directory
	237
	238	load the gnumakefile
	239	go to the end moveup until you reach hash.o: EXTERN.h
	240	and delete all lines dowonwards until you reach
	241	# WARNING: Put nothing....
	242
	243	=item *
	244
	245	Now!
0a753a76	246
	247	make
	248
c0c066b9 JH	249	=back
c0c066b9 JH	250
0a753a76	251	=head2 Testing
	252
	253	Now run
	254
	255	make test
	256
b971f6e4	257	Some tests will be skipped because they need the fork() function:
0a753a76	258
b971f6e4	259	F<io/pipe.t>, F<op/fork.t>, F<lib/filehand.t>, F<lib/open2.t>, F<lib/open3.t>,
b971f6e4	260	F<lib/io_pipe.t>, F<lib/io_sock.t>
0a753a76	261
	262	=head2 Installing the built perl
	263
	264	Run
	265
	266	make install
	267
c0c066b9	268	=head1 AUTHORS
0a753a76	269
0a753a76	270	Norbert Pueschel, pueschel@imsdd.meb.uni-bonn.de
c0c066b9	271	Jan-Erik Karlsson, trg@privat.utfors.se
0a753a76	272
	273	=head1 SEE ALSO
	274
	275	perl(1).
	276
	277	=cut