Commit | Line | Data |
5a83b7cf |
1 | =pod |
2 | |
3 | Devel::Size - Perl extension for finding the memory usage of Perl variables |
4 | |
5 | =head1 SYNOPSIS |
6 | |
7 | use Devel::Size qw(size total_size); |
8 | |
9 | my $size = size("A string"); |
10 | |
11 | my @foo = (1, 2, 3, 4, 5); |
12 | my $other_size = size(\@foo); |
13 | |
14 | my $foo = {a => [1, 2, 3], |
9fc9ab86 |
15 | b => {a => [1, 3, 4]} |
5a83b7cf |
16 | }; |
17 | my $total_size = total_size($foo); |
18 | |
19 | =head1 DESCRIPTION |
20 | |
21 | This module figures out the real size of Perl variables in bytes, as |
22 | accurately as possible. |
23 | |
24 | =head1 Build and Install |
25 | |
26 | To build and install this module, you need: |
27 | |
9fc9ab86 |
28 | Perl |
29 | a working C or C++ compiler |
30 | a make (or namke on Windows) utility |
5a83b7cf |
31 | |
32 | Follow these steps: |
33 | |
34 | On Linux, Cygwin, or Unix: |
35 | |
9fc9ab86 |
36 | perl Makefile.PL |
37 | make |
38 | make test |
39 | sudo make install |
40 | |
5a83b7cf |
41 | On Windows: |
42 | |
9fc9ab86 |
43 | perl Makefile.PL |
44 | nmake |
45 | nmake test |
46 | nmake install |
5a83b7cf |
47 | |
48 | =head1 BUGREPORTS |
49 | |
50 | Please report bugs to: |
51 | |
9fc9ab86 |
52 | http://rt.cpan.org/NoAuth/Bugs.html?Dist=Devel-Size |
5a83b7cf |
53 | |
54 | =head1 COPYRIGHT |
55 | |
b7621729 |
56 | Copyright (C) 2005 Dan Sugalski, Copyright (C) 2007-2008 Tels |
5a83b7cf |
57 | |
58 | This module is free software; you can redistribute it and/or modify it |
59 | under the same terms as Perl v5.8.8. |
60 | |
61 | =cut |