Description

TealInstall is a universal PalmOS installer program for Windows, and is provided as a tool for other developers releasing software for PalmOS. Using it, developers can release their products with a simple guided installation process, bypassing the cumbersome Palm Install tool that stymies many less sophisticated users. It is not intended, however, to be an application for use by end users. TealInstall supports the installation of both bundled and unbundled files, PC and PalmOS files, and supports optional license agreements, component selection, and readme files.

Contents

This archive contains the following files:

Program Files:
TEALINST.EXE The "TealInstall" program file

Manual files:
INSTDOC.PDF This manual in Adobe PDF format

INSTDOC.HTM This manual in HTML format
INSTDOC.PRC This manual in TealDoc Palm-readable format
INSTALL.INI Sample installation file

Installing

No installation needed. However, the program file TEALINST.EXE will need to be coupled with a configuration .INI file to be useful. One is provided as a demonstration to install the INSTDOC.PRC doc file. If you double-click on the TealInst.exe file, you can install the document file to your Palm.

Chapter 1 - Overview

TealInstall provides a complete installation program for simple distribution and installation for program and data files on the Palm. It supports installation of both individual files in specified by pathname, or of files bundled with the Installer executable for simple one-file download and installation. It can also be called from the command line to install specific files to specific users as part of a batch operation. It does not, however, provide a mechanism for installing conduits or other PC-resident files, as there are products such as InstallShield® for PC-based installation.

Background

While the Palm desktop software provides a convenient interface for synchronizing data on PalmOS handhelds, installation of third party applications is still too confusing for many customers. TealInstall is designed to provide a simple interface which leads novice customers through a familiar series of installation screens similar to other PC-based installers.

Operation Walk-thru

The installation process normally takes the user through six basic screens, as follows:

Welcome screen

The welcome screen appears briefly while TealInstall initializes itself and scans the system for installed users.

License Agreement

Optionally, a license agreement can be shown to the user. If accepted, installation continues to the next page. If declined, TealInstall exits.

File Selection

Optionally, a file selection screen can give the user an opportunity to select files for installation. Individual files can be mandatory, default to yes, or default to no. Brief instructions for this screen can also be customized.

User Selection

The user selection screen lets the customer choose which Palm unit to install the selected file. Alternatively, TealInstall can be set up to automatically choose the first Palm user found; useful if only one Palm user is expected on the target computer.

Copying Progress

The copying progress screen shows the progress of each file being copied to the selected user’s install folder.

Completion

At the end of the process, the completion screen appears. If a readme file is present, a button to read the readme file is also present.

Readme screen

The Readme file shows a simple scrolling field of text which is useful for displaying last minute instructions and errata.

Chapter 2 - Control File

TealInstall operates using two components: the individual files to be installed on the Palm, and a text control file which lists the files to install and determines the contents of the install screens. The control file is a simple text file, and defaults to the name “INSTALL.INI”.

A simple sample control file appears below.

LICENSE

License Agreement

This is the license agreement.

.

FILES

*TealDoc program file

tealdoc.prc

+TealDoc manual document

docdoc.pdb

Click "Continue" to install the selected files at the next HotSync.

.

USERS CHOOSE

README

This is the Readme File.

So there.

.

An explanation of each section of the example file appears below. While some sections are optional, they must appear in this stated order.

LICENSE

The LICENSE field is optional, and determines the content of the License agreement. If present, the tag “LICENSE” should appear on a line by itself followed by the terms of the license agreement. The last line should be a period (.) on a line by itself to terminate this section.

LICENSE

License Agreement

This is the license agreement.

.

INSTALLDIR (for PC files)

If installing PC files along with this installation (such as when installing hotsync conduits), user the optional INSTALLDIR section to define a default installation directory and a registry path where this should be stored so that it may be accessible to your conduit or other PC applications. This section is required if installing PC files using any of the other PC-install sections below.

INSTALLDIR TealFlub "Software\TealPoint\TealFlub\1.0\install"

MKDIR (for PC files)

Optionally creates a subfolder in your user-defined installation folder for PC files.

MKDIR Plugins

COPYFILE (for PC files)

Optionally copies a bundled file to your installation folder.

COPYFILE TealFlub.exe Plugins\TealFlub.exe

RUNEXE (for PC files)

Optionally runs an EXE file on your PC. Typically used to launch a necessary PC plug-in or sub-installer you’ve copied to the install folder. The path to the file is followed by any command line parameters you wish to pass. Use the text “$(INSTALLDIR) to pass the path to the default install folder.

RUNEXE $(INSTALLDIR)\plugins\tealflub.exe –I $(INSTALLDIR)

SHORTCUT (for PC files)

The SHORTCUT command adds a windows shortcut command to the user’s start menu, giving it a path to a file installed in the program installation folder defined by INSTALLDIR. The keyword “SHORTCUT” is followed by the filename to link to the shortcut, and then by the short and long descriptions for the shortcut on subsequent two lines.

SHORTCUT AgntDoc.pdf

Read TealAgent Manual

TealAgent Manual in Adobe Acrobat format

FILES (PalmOS Files)

The FILES section lists up to eight PalmOS files to be installed along with their brief description. After the FILES tag, the descriptions and filenames should appear in pairs with the description on one line followed by the filename (or complete path) on the next. In addition, each description line should begin with a symbol determining how the file listing should appear:

* = The file is required

+ = The file is optional, defaulting to selected

- = The file is optional, defaulting to not selected

! = The file is selected but hidden from user view

Following the individual files is one or more lines for the brief instructions that appear to the right on this page. This text can fill multiple lines, and is terminated by a space (.) on a line by itself. If no user-selectable files are indicated (only hidden files) then TealInstall automatically advances to the next page.

FILES

*TealDoc program file

tealdoc.prc

+TealDoc manual document

docdoc.pdb

Click "Continue" to install the selected files at the next HotSync.

.

USERS (PalmOS Files)

The USERS section determines how the Palm to install is selected. Currently, the only options are CHOOSE, which gives the user a choice of all installed users, or LAST, which automatically selects the last user installed in the desktop configuration. If this option is omitted, the first Palm user found is automatically installed.

USERS CHOOSE

FINISHTEXT

FINISHTEXT optionally customizes the “installation complete” text shown after PalmOS files are copied. Text for this tag must fit on the same line as FINISHTEXT.

FINISHTEXT Shortcuts have been added to your start menu.

README

The README section adds a “View Readme” button to the completion screen. Text for this screen should be added following the README tag, and terminated with a period (.) on a line by itself.

README

This is the Readme File.

So there.

.

Chapter 3 – Advanced Features

Testing

To test an installation, simply create an INSTALL.INI file and place it in the same folder as TealInstall. While TealInstall with support installing files by full path, we recommend placing these files in the same folder for simplicity. Then, simply run TealInstall to test the installation.

Bundling

Once all the files have been set up properly and tested, you may wish to bundle them together in a single executable. Individual files to be installed and/or the configuration file can be bound. While a mix of bundled and unbundled files may be used, bundled files always take precedence over unbundled ones of the same name. By bundling the configuration file but not the files to install, a single archive can provide a simple installation for Windows customers but not exclude other platforms. On the other hand, bundling all the files together provides the simplest single solution for Windows-only install.

Bundling files is done by running TealInstall from the command line, passing it arguments to perform the particular function. Since the TealInstall program is not writeable while it is running, you should make a copy of the TealInst.exe executable and use the original program to modify the copy. The following options are available:

-a <.exe file> <file to bundle> - bundle a file to the executable

-r <.exe file> - remove all bundled files from an .exe

Example bundling session:

copy tealinst.exe setup.exe

tealinst -a setup.exe teadoc.prc

tealinst -a setup.exe docdoc.pdb

tealinst -a setup.exe install.ini

Note: The install .ini file should always be last, following the installation files, if both are present. Files with spaces in them should be surrounded by quotes (“ “).

Batch Mode

TealInstall also supports a few command line parameters which allow it to be used as a simple batch installer. Note that since TealInstall is a Windows program, a DOS batch file will not wait until the program returns before executing the next line in the batch file. The following options are available:

-f <file to install> - install a file to a Palm

-u <.exe file> - install to specified user name

-x - don’t show completion screen; just exit

-s <startup file> - use specified startup file, not INSTALL.INI

Appendix A - Revision History

Version 1.00 April 4, 2001

• First release of program.

Appendix B - Credits

Manual by Vince Lee and Tex Tennison

Appendix C - Contact Info

TealInstall by TealPoint Software

©2001-2005 All Rights Reserved.

TealPoint Software

454 Las Gallinas Ave #318

San Rafael, CA 94903-3618

We look forward to hearing from you.

Please visit us at www.tealpoint.com, or email us at contact@tealpoint.com.

Appendix D - License Agreement

TealInstall is free for use and distribution by any developer when used for installation of a freeware or shareware product. While the program file TEALINST.EXE may be renamed, the program itself must remain in its original, unmodified form except for files bundled to the executable using TealInstall’s bundling capabilities.

TealPoint Software maintains all copyright and authorship rights to the program, and developers must display the following text in their product manuals and information:

“TealInstall by TealPoint Software ©2001, All Rights Reserved. Used with permission.”

For other corporate and commercial use, contact us a business@tealpoint.com to obtain a use license.

Appendix E - Products

Visit us online for our complete product line, including:

TEALAGENT

A Palm data converter, installer, and web clipper, TealAgent intelligently formats local, network, and web-resident data for the Palm handhelds, converting them to standard TealDoc, TealMeal, and TealInfo files.

TEALDOC

A Doc format text reader that's nice... without the price! TealDoc reads thousands of free docs and ebooks on the web, and has exclusive support for images, link buttons, protected documents, and more.

TEALECHO

Palm text entry as it always should have been. Real-time preview in digital ink lets you see what you're writing, increasing speed and accuracy

TEALGLANCE

Keep the info you need the most at your fingertips. Shows date, time, upcoming appointments, and to-do items at power up.

TEALINFO

The reference library at your fingertips; TealInfo lets you make or browse from hundreds of free interactive TealInfo Folio files, which are mini information applets with lists, tables, popup windows, and more.

TEALLAUNCH

Lets you quickly launch your favorite apps and useful system and editing functions. Powerful button-programming features map functions and apps to hundreds of keypresses and keypress combos.

TEALLOCK

What the security app should have been: custom text and images, graffiti shortcuts for hide privates, show privates, and lock, and automatic locking when turned off or by time.

TEALMAGNIFY

Never squint at a phone number again. An ever-ready magnifying glass compatible with most any program.

TEALMASTER

A hackmaster-compatible system extensions manager with advanced features such as multiple profiles, hack priorities, delete-protection, and automatic timed reenable after system reset.

TEALMEAL

Answer the day's biggest question... where to go for lunch! A Restaurant chooser and editable database.

TEALMOVIE

Play movies and videos on your Palm with sound! Amazing system supports smooth video, sound playback, and full screen display. Includes windows encoder for making your own movies.

TEALNOTES

Sticky notes for your PalmPilot! Draw freehand notes, maps and doodles directly into your Memos, To-do entries, datebook entries--almost anywhere.

TEALPAINT

The most full-featured paint and sketch program on the Pilot. Includes 16 patterns, 12 brushes, paint bucket, magnified mode, text tool, lasso tool, screen-grabber, color and grayscale support and much more.

TEALPHONE

The better Address book app, with large, easy-to-see numbers, viewing by first, last, or company name, advanced searching, and more!

TEALPRINT

The all-in-one PalmPilot printing solution. Print both text and graphics to Infared, Serial, and Parallel Printers (with adapter), and even any Windows printer with exclusive 'HotSync' printing!

TEALSCRIPT

Graffiti reinvented; a replacement for the system text recognition system that allows you to tune, modify, and add your own strokes

TEALTOOLS

An invaluable collection of pop-up Palm Desk Accessories, including a pop- up calculator, lock/stopwatch, preferences panel, editing panel, memopad, and a file and backup manager.

Appendix F - Disclaimer

We at TealPoint Software are committed to providing quality, easy-to-use software. However, this product is provided without warranty and the user accepts full responsibility for any damages, consequential or otherwise, resulting from its use.

This archive is freely redistributable, provided it is made available only in its complete, unmodified form with no additional files and for noncommercial purposes only. Any other use must have prior written authorization from TealPoint Software.

Unauthorized commercial use includes, but is not limited to:

§ A product for sale.

§ Accompanying a product for sale.

§ Accompanying a magazine, book or other publication for sale.

§ Distribution with "Media", "Copying" or other incidental costs.

§ Available for download with access or download fees.

Thank you.