ReST Packager's Guide

An introduction to creating ReST packages.

Eric T Meek

Innovative Computing Laboratory, UT

Jeff M Larkin

Innovative Computing Laboratory, UT
Revision History
Revision $Revision: 1.19 $$Date: 2006/05/25 $
Current CVS Version.
Revision 1.05/25/2006
Initial Public Release

Abstract

The most important aspect of creating any software package is distributing it in an uncomplicated and unified manner. However, creating robust software packages which are uncomplicated requires much planning. Using the ReST Packager, however, lessens the burden of pre-planning by providing a step-by-step wizard breaking down package creation into manageable sections. Each section has extensive documentation regarding the purpose of each feature and has color coded fields which show which are required and which are optional. Each feature has helpful tooltips providing a quick reminder of how to use it. It should be noted not all features available in the Packager are implemented in the Installer. However, filling out each feature available in the packager ensures completeness and compatibility with future versions of ReST. Essentially, the ReST Packager serves as a guide through the difficult process of creating robust ReST packages. This, in-turn, guides users though installing the software just packaged in a unified manner both in remote heterogeneous and future supported installation environments.


Table of Contents

1. ReST Package Basics
The Package Structure
Planning
2. The Packager GUI
The Package Header
Configuration Files
The Package Files
The Package Commands
Creating the commands
The 6 Steps
Package Commands
Command Options
Actions
3. Creating and using the package file
4. Conclusions
I. Package XML Elements
action - Commands that can be run after a package has been installed.
actions - Wrapper element for multiple action elements.
backgroundcolor - Declare the background color that should be used in the ReST applications when referencing this package.
backgroundimage - Declare the background image that should be used in the ReST applications when referencing this package.
base - Gives the base directory for this package.
checksumuri - Give the uri to a file that contains the checksum for this package.
command - Run a command on the remote system.
compilation - The 3rd of the 5 steps to installing a package.
completion - The 5th of the 5 steps to installing a package.
configfile - Declare a file that must be configured by the user.
configuration - The 2nd of the 5 steps to installing a package.
def - Defines a substitution or command option in a pre set.
description - Provide a description of the package.
explorerattributes - Contains attributes to customize the look and feel of the ReST Explorer for a specific package.
header - Provide basic metadata about the package.
icon - Defines the icon to appear in the titlebar of a ReST application when referencing this ReST package.
info - Give additional information about the software contained in this package.
infouri - Give a link to a text file containing additional information about the software contained in this package.
installation - The 4th of the 5 steps to installing a package.
installerattributes - Contains attributes to customize the look and feel of the ReST Installer for a specific package.
license - Define the licensing terms of the included software.
licenseuri - Define the licensing terms of the included software.
monitorattributes - Contains attributes to customize the look and feel of the ReST Monitor for a specific package.
name - Gives the name of the packager.
option - Declares configurable options for a command.
package - The ReST Package root element.
packagedir - Declare a directory within the structure of the package file.
packager - Information about the person who created this ReST Package.
packagesrc - Declares a file that appears in the ReST package.
patch - Declares a patch file to be applied to the sources contained in this file. (NOT CURRENTLY SUPPORTED)
pre - A set of predefined options and substitutions.
predefs - Provide groups of pre-defined command options and configuration substitutions.
preparation - The 1st of the 5 steps to installing a package.
sub - Defines a substitution that will be made in a configuration file.
title - The title the will appear in the ReST applications for this package.
uninstallation - An option additional step to define how to uninstall a package.
uri - A standard URI that may be used to provide more information about a package or package author.
version - Give the version of packaged software.
II. Complete Package XML
Complete Package XML Example - Show the complete XML of a package.

List of Figures

2.1. Create Header
2.2. Select Configuration Files
2.3. Configuring Substitutions
2.4. Configuring Substitutions
2.5. Adding Files
2.6. Command Sections
2.7. A Package Command
2.8. A Package Command Option
2.9. The Action Setup Panel
2.10. The Action Command Option Setup Panel

List of Examples

2.1. Boolean Substation
2.2. The 6 Steps
2.3. Command Option XML
2.4. Package Actions XML
3.1. Running the ReST Packager.
3.2. Installing a Package
7. Action Example
8. Actions Example
9. Command Example
10. Configfile XML Example
11. Sample Configuration File Stub
12. Package Header Example
13. License Example
14. Licenseuri Example
15. Predef and Def Example
16. Example Package XML