README
1IPC::MMA is Copyright (C) 2008-2010, Craig MacKenna <craig@animalhead.com>
2
3DESCRIPTION
4
5 IPC::MMA allows data to be shared among related Unix/Linux processes
6 in a straightforward way. It provides methods to create and
7 destroy shared memory segments and to create, access, and maintain
8 data structures within segments. Perl scalars, arrays, and hashes
9 can be stored in shared memory. There are six possible kinds of
10 arrays: general-purpose scalars, signed or unsigned integers,
11 floating-point numbers, fixed-length strings/records, and single-bit
12 booleans.
13
14LICENSE INFORMATION
15
16 This module is free software; you may redistribute it and/or modify
17 it under the same terms as Perl 5.10.1. For more details, see the
18 full text of the licenses at
19
20 <http://www.perlfoundation.org/artistic_license_1_0> and
21 <http://www.gnu.org/licenses/gpl-2.0.html>.
22
23 This program is distributed in the hope that it will be useful, but
24 it is provided "as is" and without any express or implied warranties.
25 For details, see the full text of the licenses at the above URLs.
26
27PREREQUISITE
28
29 This module requires Ralf Engelschall's mm library. It was developed
30 with version 1.4.2. See http://www.ossp.org/pkg/lib/mm/ for more
31 about mm.
32
33 Experienced users may prefer to install mm from a different source:
34
35 debian/ubuntu: $ sudo apt-get install libmm-dev
36 FreeBSD ports: $ cd ports/devel/mm # (wherever ports lives)
37 $ sudo make
38 $ sudo make install
39
40INSTALLATION
41
42 Your computer needs to have the mm library before you can use
43 IPC::MMA. Many Unix/Linux systems include this library. If you
44 need to download and install mm, see the preceding section.
45
46 The easy way to install IPC::MMA:
47
48 $ perl -MCPAN -e "install IPC::MMA"
49
50 The classic way:
51
52 Choose a directory to use for installing.
53 Move/download the distribution file IPC-MMA-n.nn.tar.gz into it
54 cd into it
55 $ tar -xf IPC-MMA-n.nn.tar.gz
56
57 This will produce a new directory IPC-MMA-n.nn.
58
59 $ cd IPC-MMA-n.nn
60 $ perl Makefile.PL
61 $ make
62 $ make test
63
64 Assuming those steps don't show any problems:
65
66 $ sudo make install (or just make install if you're superuser)
67
68 Either of the above alternatives should install IPC::MMA into the
69 Perl library.
70
71 See the POD documentation for further details. Once the module
72 is installed, you should be able to read the documentation by
73 typing the following from the command-line:
74
75 $ perldoc IPC::MMA
76
77 Or if your man system is configured in a compatible way:
78
79 $ man IPC::MMA
80
81
82NOTES
83 This module requires perl 5.6 or later.
84
85 The initial use of the array functions of this module was to track
86 related-file accesses on our Apache web server, and thus optimize
87 use of the HTTP keep-alive feature. Watch CPAN for this module
88 in the future (its working name is Apache2::CloseKeepAlive).
89
90 Craig MacKenna <craig@animalhead.com>
91 Jan 4 2010
92