PEAR logo

PEAR_PackageFileManager : The Definitive Guide



PEAR_PackageFileManager Manual

First Edition

Edited by

Laurent Laville

This work is licensed under the Creative Commons Attribution License. To view a copy of this license, visit http://creativecommons.org/licenses/by/2.0/.

Revision History
Revision 1.6.0 November 17, 2006
The first edition of this Guide is now completed. It cover version 1.6.0 (stable) of PEAR_PackageFileManager.

Table of Contents

Preface
Organization of This Book
Pre-requisites
I. Introduction
1. About PEAR_PackageFileManager
2. FAQ - Frequently Asked Questions
II. Getting Started
3. package.xml 2.0
III. Tutorial
4. Introduction
5. Introducing PEAR_PackageFileManager
6. Setting options
7. Creating a new package
8. Maintaining users list
9. Using tasks to customize file installation
10. Maintaining dependencies list
11. Using custom file roles
12. Using custom file tasks
13. Handling Changelog
IV. Reference Guide
<channel> - What is a channel?
<uri> - When should I use <uri>?
<lead>, <developer>, <contributor>, and <helper> - Developer documentation for a release
<version> - versioning in package.xml 2.0
<stability> - specifying release and API stability
<license> - specifying software license and optional reference to license text
<notes> - about release changes
<contents> - specifying the contents of a release
<dir> - documenting a directory in the <contents> tag
<file> - documenting a file in the <contents> tag
tasks for <file>s - specialized file installation and manipulation
<compatible> - Alleviating strict versioning with <compatible>
<dependencies> - Dependency Specification in package.xml 2.0
<usesrole> - documenting custom file roles used in <contents>
<usestask> - documenting custom tasks used in <contents>
<phprelease>, <extbinrelease>, <extsrcrelease>, <bundle> - specifying the content type of a release

List of Tables

6.1. Reference of generation options for package.xml 2.0
7.1. First package/release with package.xml 1.0 and package.xml 2.0
10.1. setting PHP versions dependencies
10.2. setting PEAR installer dependencies
10.3. package.xml 1.0 dependencies
10.4. package.xml 2.0 dependencies
10.5. php extension dependencies version 1.0
10.6. php extension dependencies version 2.0
10.7. OS installation condition
10.8. Arch installation condition
11.1. extension role mapping reference
11.2. install custom file role handler
12.1. install custom file task handler
14. Converting package.xml 1.0 package dependencies to package.xml 2.0

List of Examples

13.1. create a RSS newsfeed
PEAR_PackageFileManager : The Definitive Guide v 1.6.0 : November 17, 2006