Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 128 lines (65 sloc) 2.57 kB
71944f8 @Leont Added documentation on install
authored
1 =pod
2
3 =head1 NAME
4
5 libperl++ - Install
6
7 =head1 VERSION
8
9 XXX
e71fd19 @Leont Improvements to the install documentation
authored
10
71944f8 @Leont Added documentation on install
authored
11 =head1 SYNOPSIS
12
13 perl Build.PL
14 ./Build
15 ./Build test
16 ./Build install
17
18 =head1 BEFORE YOU START
19
e71fd19 @Leont Improvements to the install documentation
authored
20 Compiling libperl++ requires a number of dependencies to be fullfilled
71944f8 @Leont Added documentation on install
authored
21
22 =over 4
23
24 =item * perl 5.8 or higher. perl 5.10 or higher is recommended.
25
2d27e70 @Leont Added some honesty do the install documentation
authored
26 =item * A recent C++ compiler. Compilers that should be able to compile libperl++ are:
71944f8 @Leont Added documentation on install
authored
27
28 =over 2
29
8805bd6 @Leont libperl++ requires GCC 4.5 since 508ff7d1
authored
30 =item * GCC 4.5 or higher
71944f8 @Leont Added documentation on install
authored
31
2d27e70 @Leont Added some honesty do the install documentation
authored
32 GCC support is well tested.
33
71944f8 @Leont Added documentation on install
authored
34 =item * MS Visual C++ 2010
35
2d27e70 @Leont Added some honesty do the install documentation
authored
36 Note that due to the state of Perl's C++ toolchain on Windows, MSVC++ support is sadly theoretical currently.
37
71944f8 @Leont Added documentation on install
authored
38 =back
39
2d27e70 @Leont Added some honesty do the install documentation
authored
40 Recent version of the Intel and Codeweavers compilers might work too, but have not been tried in any way.
71944f8 @Leont Added documentation on install
authored
41
42 =item * The Boost libraries. Note that this only includes headers, not runtime libraries.
43
e71fd19 @Leont Improvements to the install documentation
authored
44 =item * Some Perl libraries
45
46 =over 4
47
40d7286 @Leont Updated dependencies
authored
48 =item * Archive::Tar (included in perl 5.10.0)
49
e71fd19 @Leont Improvements to the install documentation
authored
50 =item * ExtUtils::CBuilder (included in perl 5.10.0)
51
3c276b4 @Leont Created a mixin structure for extentions to L::B
authored
52 =item * Module::Load (included in perl 5.10.0)
53
40d7286 @Leont Updated dependencies
authored
54 =item * TAP::Harness 3 (included in perl 5.10.1)
e71fd19 @Leont Improvements to the install documentation
authored
55
40d7286 @Leont Updated dependencies
authored
56 =back
e71fd19 @Leont Improvements to the install documentation
authored
57
58 =back
59
71944f8 @Leont Added documentation on install
authored
60 =head1 BUILDING
61
62 libperl++'s build process is Build.PL compatible. All actions take options in the form C<options=value>, though if no value is given 1 is assumed.
63
64 =head2 Creating the Build executable
65
66 The Build executable can be generated by issuing
67
68 perl Build.PL
69
61bd3a8 @Leont Renamed silent option to quiet
authored
70 Any options given to it will be saved and passed on to all subsequent calls of Build. Most options for Build actions are specific for that action, except C<quiet>, which is used by almost all Build actions. The default is 0.
71944f8 @Leont Added documentation on install
authored
71
72 =head2 Building the library
73
74 ./Build
75
2d27e70 @Leont Added some honesty do the install documentation
authored
76 This can take one option:
77
af19110 @Leont Refactored create_by_system, added include_dirs
authored
78 =over 4
79
85ff322 @Leont Add install options
authored
80 =item * --include_dir <dir>
af19110 @Leont Refactored create_by_system, added include_dirs
authored
81
d953a66 @Leont Fixups to include_dir argument
authored
82 This argument adds a directory to the include path. It can be repeated to include multiple paths. In particular, you may need this on some platforms to indicate the location of boost.
af19110 @Leont Refactored create_by_system, added include_dirs
authored
83
84 =back
71944f8 @Leont Added documentation on install
authored
85
86 =head2 Running tests
87
88 ./Build test
89
61bd3a8 @Leont Renamed silent option to quiet
authored
90 The amount of information given depends on the value of C<quiet>. It can take values from -1 to 3, from printing out individual tests to printing out nothing.
71944f8 @Leont Added documentation on install
authored
91
92 =head2 Installing the library
93
94 ./Build install
95
96 Install can take a number of options
97
98 =over 4
99
85ff322 @Leont Add install options
authored
100 =item * --install_path type=path
101
102 This sets the install path of C<type> to C<path>. Type can be any of these:
103
104 =over 4
105
106 =item * lib
107
108 =item * headers
109
110 =item * libdoc
111
112 =item * so
113
114 =back
115
116 =item * --installdirs <target>
71944f8 @Leont Added documentation on install
authored
117
85ff322 @Leont Add install options
authored
118 Sets the install target to C<target>. Target should be either C<site> (the default), C<vendor> or C<core>.
71944f8 @Leont Added documentation on install
authored
119
85ff322 @Leont Add install options
authored
120 =item * --install_base <base-path>
71944f8 @Leont Added documentation on install
authored
121
85ff322 @Leont Add install options
authored
122 Install the targets to paths derived from C<base-path>.
71944f8 @Leont Added documentation on install
authored
123
124 =back
125
126 =cut
127
Something went wrong with that request. Please try again.