NAME

LCFG::Build::Utils::OSXPkg - LCFG software building utilities

VERSION

This documentation refers to LCFG::Build::Utils::OSXPkg version 0.5.1

DESCRIPTION

This module provides a suite of utilities to help in building MacOSX packages from LCFG projects, particularly LCFG components. The methods are mostly used by tools which implement the LCFG::Build::Tool base class (e.g. LCFG::Build::Tool::OSXPkg) but typically they are designed to be generic enough to be used elsewhere.

SUBROUTINES/METHODS

There is one public method you can call on this class.

build( $outdir, $tarfile, $dirname, $pkgname, $pkgversion, $pkgident, $filters, $scriptdir, $nopayload )

This method assumes that $tarfile contains sources that cmake can build and install. pkgbuild is then called to create the package.

$outdir

Absolute path to the directory where the package will be created.

$tarfile

Absolute path to the tarfile to unpack, build and package.

$pkgname

The full name of the package you want to generate, e.g. lcfg-foo-1.2.3-4. .pkg will be appended to this for you.

$pkgversion

The version of the package, e.g. 1.2.3.4.

$pkgident

A package identifier to pass to pkgbuild, e.g. org.lcfg.

$filters

A reference to an array of filter expressions to pass to pkgbuild.

$scriptdir

Absolute path to a directory of scripts to pass to pkgbuild. There is no filtering of the files in this directory and pkgbuild will copy all its contents into the package.

$nopayload

A boolean that flags whether the package should be created with or without a payload.

DEPENDENCIES

For building packages you will need CMake and pkgbuild.

PLATFORMS

This is the list of platforms on which we have tested this software. We expect this software to work on any Unix-like platform which is supported by Perl.

Mac OS X 10.7

BUGS AND LIMITATIONS

There are no known bugs in this application. Please report any problems to bugs@lcfg.org, feedback and patches are also always very welcome.

AUTHOR

Kenneth MacDonald <Kenneth.MacDonald@ed.ac.uk>
Stephen Quinney <squinney@inf.ed.ac.uk>

LICENSE AND COPYRIGHT

Copyright (C) 2008-2012 University of Edinburgh. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the terms of the GPL, version 2 or later.