summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/perlplan9.1
blob: f540c73acd19ba41349a47e8797b40e6d68eae5a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PERLPLAN9 1"
.TH PERLPLAN9 1 2024-01-12 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
perlplan9 \- Plan 9\-specific documentation for Perl
.SH DESCRIPTION
.IX Header "DESCRIPTION"
These are a few notes describing features peculiar to
Plan 9 Perl. As such, it is not intended to be a replacement
for the rest of the Perl 5 documentation (which is both 
copious and excellent). If you have any questions to 
which you can't find answers in these man pages, contact 
Luther Huffman at lutherh@stratcom.com and we'll try to 
answer them.
.SS "Invoking Perl"
.IX Subsection "Invoking Perl"
Perl is invoked from the command line as described in 
perl. Most perl scripts, however, do have a first line 
such as "#!/usr/local/bin/perl". This is known as a shebang 
(shell-bang) statement and tells the OS shell where to find 
the perl interpreter. In Plan 9 Perl this statement should be 
"#!/bin/perl" if you wish to be able to directly invoke the 
script by its name.
     Alternatively, you may invoke perl with the command "Perl"
instead of "perl". This will produce Acme-friendly error
messages of the form "filename:18".
.PP
Some scripts, usually identified with a *.PL extension, are 
self-configuring and are able to correctly create their own 
shebang path from config information located in Plan 9 
Perl. These you won't need to be worried about.
.SS "What's in Plan 9 Perl"
.IX Subsection "What's in Plan 9 Perl"
Although Plan 9 Perl currently only  provides static 
loading, it is built with a number of useful extensions. 
These include Opcode, FileHandle, Fcntl, and POSIX. Expect 
to see others (and DynaLoading!) in the future.
.SS "What's not in Plan 9 Perl"
.IX Subsection "What's not in Plan 9 Perl"
As mentioned previously, dynamic loading isn't currently 
available nor is MakeMaker. Both are high-priority items.
.SS "Perl5 Functions not currently supported in Plan 9 Perl"
.IX Subsection "Perl5 Functions not currently supported in Plan 9 Perl"
Some, such as \f(CW\*(C`chown\*(C'\fR and \f(CW\*(C`umask\*(C'\fR aren't provided 
because the concept does not exist within Plan 9. Others,
such as some of the socket-related functions, simply
haven't been written yet. Many in the latter category 
may be supported in the future.
.PP
The functions not currently implemented include:
.PP
.Vb 5
\&    chown, chroot, dbmclose, dbmopen, getsockopt, 
\&    setsockopt, recvmsg, sendmsg, getnetbyname, 
\&    getnetbyaddr, getnetent, getprotoent, getservent, 
\&    sethostent, setnetent, setprotoent, setservent, 
\&    endservent, endnetent, endprotoent, umask
.Ve
.PP
There may be several other functions that have undefined 
behavior so this list shouldn't be considered complete.
.SS "Signals in Plan 9 Perl"
.IX Subsection "Signals in Plan 9 Perl"
For compatibility with perl scripts written for the Unix 
environment, Plan 9 Perl uses the POSIX signal emulation
provided in Plan 9's ANSI POSIX Environment (APE). Signal stacking
isn't supported. The signals provided are:
.PP
.Vb 4
\&    SIGHUP, SIGINT, SIGQUIT, SIGILL, SIGABRT,
\&    SIGFPE, SIGKILL, SIGSEGV, SIGPIPE, SIGPIPE, SIGALRM, 
\&    SIGTERM, SIGUSR1, SIGUSR2, SIGCHLD, SIGCONT,
\&    SIGSTOP, SIGTSTP, SIGTTIN, SIGTTOU
.Ve
.SH "COMPILING AND INSTALLING PERL ON PLAN 9"
.IX Header "COMPILING AND INSTALLING PERL ON PLAN 9"
WELCOME to Plan 9 Perl, brave soul!
.PP
.Vb 5
\&   This is a preliminary alpha version of Plan 9 Perl. Still to be
\&implemented are MakeMaker and DynaLoader. Many perl commands are
\&missing or currently behave in an inscrutable manner. These gaps will,
\&with perseverance and a modicum of luck, be remedied in the near
\&future.To install this software:
.Ve
.PP
1. Create the source directories and libraries for perl by running the
plan9/setup.rc command (i.e., located in the plan9 subdirectory).
Note: the setup routine assumes that you haven't dearchived these
files into /sys/src/cmd/perl. After running setup.rc you may delete
the copy of the source you originally detarred, as source code has now
been installed in /sys/src/cmd/perl. If you plan on installing perl
binaries for all architectures, run "setup.rc \-a".
.PP
2. After making sure that you have adequate privileges to build system
software, from /sys/src/cmd/perl/5.00301 (adjust version
appropriately) run:
.PP
.Vb 1
\&        mk install
.Ve
.PP
If you wish to install perl versions for all architectures (68020,
mips, sparc and 386) run:
.PP
.Vb 1
\&        mk installall
.Ve
.PP
3. Wait. The build process will take a *long* time because perl
bootstraps itself. A 75MHz Pentium, 16MB RAM machine takes roughly 30
minutes to build the distribution from scratch.
.SS "Installing Perl Documentation on Plan 9"
.IX Subsection "Installing Perl Documentation on Plan 9"
This perl distribution comes with a tremendous amount of
documentation. To add these to the built-in manuals that come with
Plan 9, from /sys/src/cmd/perl/5.00301 (adjust version appropriately)
run:
.PP
.Vb 1
\&        mk man
.Ve
.PP
To begin your reading, start with:
.PP
.Vb 1
\&        man perl
.Ve
.PP
This is a good introduction and will direct you towards other man
pages that may interest you.
.PP
(Note: "mk man" may produce some extraneous noise. Fear not.)
.SH BUGS
.IX Header "BUGS"
"As many as there are grains of sand on all the beaches of the 
world . . ." \- Carl Sagan
.SH "Revision date"
.IX Header "Revision date"
This document was revised 09\-October\-1996 for Perl 5.003_7.
.SH AUTHOR
.IX Header "AUTHOR"
Direct questions, comments, and the unlikely bug report (ahem) direct
comments toward:
.PP
Luther Huffman, lutherh@stratcom.com, 
Strategic Computer Solutions, Inc.