xref: /illumos-gate/usr/src/cmd/perl/contrib/Sun/Solaris/Lgrp/README (revision b30d193948be5a7794d7ae3ba0ed9c2f72c88e0f)
1#
2# CDDL HEADER START
3#
4# The contents of this file are subject to the terms of the
5# Common Development and Distribution License (the "License").
6# You may not use this file except in compliance with the License.
7#
8# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9# or http://www.opensolaris.org/os/licensing.
10# See the License for the specific language governing permissions
11# and limitations under the License.
12#
13# When distributing Covered Code, include this CDDL HEADER in each
14# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15# If applicable, add the following below this CDDL HEADER, with the
16# fields enclosed by brackets "[]" replaced with your own identifying
17# information: Portions Copyright [yyyy] [name of copyright owner]
18#
19# CDDL HEADER END
20#
21
22#
23# Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
24# Use is subject to license terms.
25#
26# ident	"%Z%%M%	%I%	%E% SMI"
27#
28
29Licensing
30---------
31You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32or http://www.opensolaris.org/os/licensing.
33See the License for the specific language governing permissions
34and limitations under the License.
35
36Availability
37------------
38This module is only available for Solaris 9u6 onwards.
39
40Description
41-----------
42This module provided access to the Solaris locality group library
43liblgrp(3LIB). It provides both functional and object-oriented interface to all
44functions defined in liblgrp(3LIB).
45
46The t directory contains two files: Lgrp.t and Lgrp_api.t which contain lots
47of examples (and serve as tests).
48
49Installation
50------------
51
521. Uncompress and untar the archive
532. cd to the module directory
543. perl Makefile.PL; make test; make install
55
56If you are using gcc and wish to build this module against the perl shipped as
57part of Solaris, see the Solaris-PerlGcc module, also available from CPAN.
58