ReST Packager's Guide

An introduction to creating ReST packages.

Jeff M Larkin

Innovative Computing Laboratory, UT

Eric T Meek

Innovative Computing Laboratory, UT
Revision History
Revision 1.03/11/2005
Initial Public Release

Abstract

This document provides information for those interested in creating a ReST Installer package for a piece of software. It provides information detailing the process of package creation. It is assumed that the reader has at least a basic knowledge of the ReST project.


Table of Contents

1. ReST Package Basics
The Package Structure
The Package XML
2. Writing the package XML
Planning
Writing the XML
The Header
The 6 Steps
Command Options
Actions
Configuration Files
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 Examples

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