Unix Maven Plug-in

Trygve Laugstøl

Arktekk AS

$Id: handbook.xml 14315 2011-07-08 16:08:05Z trygvis $


Acknowledgements

Trygve Laugstøl would like to thank the following persons and companies in no particular order for their effort in helping with the development of the Unix Maven Plugin

  • Erik Drolshammer, Objectware for providing me with RPM related use cases and being helpful with testing new features.

  • Conax for providing use cases and allowing me to work on the plugin while on the clock.

  • Arktekk for sponsoring me to work on the plugin.

Preface
I. Guide
1. Introduction
1.1. Scope
1.2. About the plugin
1.3. How the Plugin Work
1.3.1. Meta Data Generation
1.3.2. Assembly Operation Execution
1.4. About the Alternatives to the Unix Maven Plugin
2. Concepts
2.1. Operation Modes
2.2. Package Formats
2.3. Platform
2.4. Package File System and File System Objects
3. Default Values
3.1. Default Assembly Operations
II. Example of Usage
Introduction to the Examples
4. Single, Standalone Application
4.1. The Deb version
4.1.1. pom.xml for the deb version
4.1.2. Resulting Deb
4.2. The Pkg version
4.2.1. pom.xml for the pkg version
4.2.2. Resulting PKG
4.3. The RPM version
4.3.1. pom.xml for RPM version
4.3.2. Resulting RPM
4.4. The Zip version
4.4.1. pom.xml for the zip version
4.4.2. Resulting ZIP
5. Other
III. Reference
6. Unix Package Definition
6.1. Deb
6.2. Pkg
6.3. Rpm
6.4. Version Calculation
6.4.1. Version Calculation for Snapshot Versions
6.4.2. Version Calculation for Release Versions
6.5. Mapping to Native Formats
6.5.1. Deb Specific Mappings
6.5.2. Pkg Specific Mappings
6.5.3. Rpm Specific Mappings
7. Action Scripts
7.1. Action Scripts in Primary Artifact Mode
7.2. Action Scripts in Attached Artifact Mode
8. Operating Requirements
9. Assembly Operations
9.1. Common Settings and Behaviour
9.1.1. Artifact Naming and Identification
9.1.2. File renaming
9.1.3. Includes and Excludes
9.1.4. File Attributes
9.2. Copy File
9.3. Copy Artifact
9.4. Make Directory
9.5. Set Attributes
9.6. Symlink
9.7. Copy Directory, Extract Artifact and Extract File
9.7.1. Copy Directory
9.7.2. Extract Artifact
9.7.3. Extract File
10. Creating Native Package Repositories
10.1. Creating Debian/APT Repositories
10.2. Creating RPM/Yum Repositories
10.3. Creating pkg-get/pkgutil Repositories
11. Troubleshooting
11.1. Debugging
IV. Useful Tips For Making Useful Packages
12. Package Command Reference
12.1. dpkg Commands
12.1.1. Listing All Files In a Package
12.2. rpm Commands
12.2.1. List All Files In a Package
12.2.2. List All Files In a Package With File Permissions
12.2.3. Listing All Available Software Groups
12.3. zip Commands
13. Snippets for Scripts
13.1. RedHat/Fedora
13.1.1. Making your server start on boot
V. Version History and Upgrading
Preface to Part IV
14. 1.0-alpha-4
14.1. Change Log
14.2. Upgrading from 1.0-alpha-3