This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
POSIX: MSVC defines all of these
[perl5.git] / README
1 Perl is Copyright (C) 1993 - 2023 by Larry Wall and others.
2
3 All rights reserved.
4
5 # ABOUT PERL
6
7 Perl is a general-purpose programming language originally developed for
8 text manipulation and now used for a wide range of tasks including
9 system administration, web development, network programming, GUI
10 development, and more.
11
12 The language is intended to be practical (easy to use, efficient,
13 complete) rather than beautiful (tiny, elegant, minimal).  Its major
14 features are that it's easy to use, supports both procedural and
15 object-oriented (OO) programming, has powerful built-in support for text
16 processing, and has one of the world's most impressive collections of
17 third-party modules.
18
19 For an introduction to the language's features, see pod/perlintro.pod.
20
21 For a discussion of the important changes in this release, see
22 pod/perldelta.pod.
23
24 There are also many Perl books available, covering a wide variety of topics,
25 from various publishers.  See pod/perlbook.pod for more information.
26
27
28 # INSTALLATION
29
30 If you're using a relatively modern operating system and want to
31 install this version of Perl locally, run the following commands:
32
33     ./Configure -des -Dprefix=$HOME/localperl
34     make test
35     make install
36
37 This will configure and compile perl for your platform, run the regression
38 tests, and install perl in a subdirectory "localperl" of your home directory.
39
40 If you run into any trouble whatsoever or you need to install a customized
41 version of Perl, you should read the detailed instructions in the "INSTALL"
42 file that came with this distribution.  Additionally, there are a number of
43 "README" files with hints and tips about building and using Perl on a wide
44 variety of platforms, some more common than others.
45
46 Once you have Perl installed, a wealth of documentation is available to you
47 through the 'perldoc' tool.  To get started, run this command:
48
49     perldoc perl
50
51
52 # IF YOU RUN INTO TROUBLE
53
54 Perl is a large and complex system that's used for everything from
55 knitting to rocket science.  If you run into trouble, it's quite
56 likely that someone else has already solved the problem you're
57 facing. Once you've exhausted the documentation, please report bugs to us
58 at the GitHub issue tracker at https://github.com/Perl/perl5/issues
59
60 While it was current when we made it available, Perl is constantly evolving
61 and there may be a more recent version that fixes bugs you've run into or
62 adds new features that you might find useful.
63
64 You can always find the latest version of perl on a CPAN (Comprehensive Perl
65 Archive Network) site near you at https://www.cpan.org/src/
66
67 If you want to submit a simple patch to the perl source, see the "SUPER
68 QUICK PATCH GUIDE" in pod/perlhack.pod.
69
70 Just a personal note:  I want you to know that I create nice things like this
71 because it pleases the Author of my story.  If this bothers you, then your
72 notion of Authorship needs some revision.  But you can use perl anyway. :-)
73
74 The author.
75
76
77 # LICENSING
78
79 This program is free software; you can redistribute it and/or modify
80 it under the terms of either:
81
82 a.  the GNU General Public License as published by the Free
83     Software Foundation; either version 1, or (at your option) any
84     later version, or
85
86 b.  the "Artistic License" which comes with this Kit.
87
88 This program is distributed in the hope that it will be useful,
89 but WITHOUT ANY WARRANTY; without even the implied warranty of
90 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See either
91 the GNU General Public License or the Artistic License for more details.
92
93 You should have received a copy of the Artistic License with this
94 Kit, in the file named "Artistic".  If not, I'll be glad to provide one.
95
96 You should also have received a copy of the GNU General Public License
97 along with this program in the file named "Copying". If not, write to the
98 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
99 Boston, MA 02110-1301, USA or visit their web page on the internet at
100 https://www.gnu.org/copyleft/gpl.html.
101
102 For those of you that choose to use the GNU General Public License,
103 my interpretation of the GNU General Public License is that no Perl
104 script falls under the terms of the GPL unless you explicitly put
105 said script under the terms of the GPL yourself.  Furthermore, any
106 object code linked with perl does not automatically fall under the
107 terms of the GPL, provided such object code only adds definitions
108 of subroutines and variables, and does not otherwise impair the
109 resulting interpreter from executing any standard Perl script.  I
110 consider linking in C subroutines in this manner to be the moral
111 equivalent of defining subroutines in the Perl language itself.  You
112 may sell such an object file as proprietary provided that you provide
113 or offer to provide the Perl source, as specified by the GNU General
114 Public License.  (This is merely an alternate way of specifying input
115 to the program.)  You may also sell a binary produced by the dumping of
116 a running Perl script that belongs to you, provided that you provide or
117 offer to provide the Perl source as specified by the GPL.  (The
118 fact that a Perl interpreter and your code are in the same binary file
119 is, in this case, a form of mere aggregation.)  This is my interpretation
120 of the GPL.  If you still have concerns or difficulties understanding
121 my intent, feel free to contact me.  Of course, the Artistic License
122 spells all this out for your protection, so you may prefer to use that.