Dec 312017
 
Updated version of Open INSTALL, a great installation package for software publishers.
File INSTALL3.ZIP from The Programmer’s Corner in
Category Miscellaneous Language Source Code
Updated version of Open INSTALL, a great installation package for software publishers.
File Name File Size Zip Size Zip Type
COMMANDS.DOC 52701 12724 deflated
DEMO.GSF 4268 2041 deflated
FILE1.TXT 1840 323 deflated
FILE2.TXT 1610 321 deflated
GOODSOFT 11391 2786 deflated
GOODSOFT.GSF 4268 2041 deflated
INSTALL.EXE 35664 16431 deflated
README.EXE 20048 8341 deflated
SCRIPT.EXE 41744 18270 deflated
SIMPLE 2749 1012 deflated

Download File INSTALL3.ZIP Here

Contents of the COMMANDS.DOC file

























OPEN INSTALL
by Mr. GoodSoft
****
1630 30th Street, Suite #235
Boulder, Colorado 80301

Script File Documentation
for the Shareware Package
(26 pages)

Please run the README.EXE file
for more information






















------------------
Contents/Index
------------------

About this documentation..........................2
How to create a script file.......................2
The script file format............................3
Script variables..................................3
Action............................................4
AddLine...........................................4
AddPath...........................................4
BackPlane.........................................5
Border............................................5
BottomBar.........................................5
BottomTitle.......................................6
BuildWindow.......................................6
ButtonOffColor....................................7
ButtonOnColor.....................................7
Buttons...........................................7
ClearPlane........................................8
ClearScreen.......................................8
CloseWindow.......................................8
ColdBoot..........................................8
ColumnMargin......................................9
CopyFile..........................................9
Default...........................................10
DestPath..........................................10
DiskLabel.........................................10
Distance..........................................11
DOSVersion........................................11
EndAutoExec.......................................12
EndButtons........................................12
EndConfig.........................................12
EndCopy...........................................12
EndInput..........................................13
EndWindow.........................................13
FindBootDrive.....................................13
FindDisk..........................................14
FindString........................................14
Input.............................................14
Jump..............................................15
Message...........................................15
ModifyAutoExec....................................16
ModifyConfig......................................16
Parameters........................................16
ProductName.......................................17
PopUp.............................................17
RemarkString......................................17
Result............................................18
RowMargin.........................................18
RunProgram........................................18
SaveOriginal......................................19
ShadowColor.......................................19
ShadowType........................................19
SourceDisk........................................20
SourcePath........................................20

StartColumn.......................................20
StartCopy.........................................21
StartRow..........................................21
StatusLineBG......................................22
StatusLineFG......................................22
StatusColumn......................................22
StatusRow.........................................23
Stop..............................................23
Text..............................................23
TopBar............................................24
TopTitle..........................................24
Travel............................................24
Wait..............................................25
WarmBoot..........................................25
Width.............................................25
WindowColor.......................................26



----------------------------
About this documentation
----------------------------

This documentation is meant to be used for evaluation of the Open
INSTALL shareware package. Unfortunately, there isn't much we could
do creatively to spruce up a text file, so our apologies for the sparse
layout! Users who purchase the full Open INSTALL package receive a much
more useful manual and documentation packet.

This documentation briefly describes all the features that are
available to Open INSTALL users. Some commands, however, are supported
only by the complete Open INSTALL package and are marked with XXXX after
the command name.


-------------------------------
How to create a script file
-------------------------------

Script files may be written with your favorite text editor or with
a word processor that can save files in a text (ASCII) format. Included
with the full Open INSTALL package is a set of pre-written script files
that are easy to modify for your product. The script files included
with the full package showcase several different "looks" and styles.

Since you are probably still not sure if Open INSTALL will work for
you, try writing a simple script file or modifying the SIMPLE script
that is included in this archive. Keep in mind that registered users
get our Winster utility, which allows you to "paint" your screens and
let Winster write the script for you.

Once you've written a script file, you need to run it through the
script generator (SCRIPT.EXE). This utility will compress your script
file and put your instructions into the binary format INSTALL
understands. Remember that, for this evaulation package, the script
generator will only output a file called "DEMO.GSF". This version of

INSTALL will read only this file. Once you purchase the full package,
you'll be able to choose the file name you wish to register to your
company.

Script file commands may be capitalized in any way you desire. All
the commands are listed below in alphabetical order. Keep in mind,
however, that any command that has XXXX next to it is not supported
by the version of the script generator in this package. Also, to avoid
confusion, you should keep the files in this package separate from
other (and possibly older) Open INSTALL packages.


--------------------------
The script file format
--------------------------

A quick glance through our GOODSOFT or SIMPLE script files included
in this evaulation package will give you a good idea of the proper
format for a script file. The format is really not as strict as it
looks. When you run your script through the script generator, the
utility will tell you if it doesn't understand something you have
written. The entire process is much like a compiler, but much simpler.




--------------------
Script variables
--------------------

Script variables may be used in a script file in place or in
conjunction with any command that uses a text string. When INSTALL is
running, it will keep the variables updated on current operations such
as the current directory, the user's boot disk, etc. This can be very
useful for adding some "smarts" to your installation. Instead of asking
the user to type in his/her boot drive letter, you could have INSTALL
automatically provide a default response, for example.

$AUTOEXECRESULT - The first line added to AUTOEXEC.BAT as a
result of a ModifyAutoExec section.
$BOOTDRIVE - The user's boot drive and path (i.e. "C:\").
$BUTTONRESULT - The result (as specified with the Result
command) of the button selected by the user.
$CONFIGRESULT - The first line added to CONFIG.SYS as a result
of a ModifyConfig section.
$CURRENTDIR - The current directory name/path.
$CURRENTDRIVE - The current disk drive letter.
$CURRENTPATH - The current disk drive and directory path.
$INPUTRESULT - Result of an input section.
$FINDRESULT - Drive letter of the most recent disk found
with the FindDisk command.






----------
Action
----------
What it does specifies what keys the user may press during data
entry (Input section)
See also Input
Usage Action =, , etc...
Example Action =ESC, F1

Other than the standard insert, delete, and arrow movement commands,
INSTALL needs to know what other keys you want to allow the user to
press.
When you define extra keys with this command, the jump command may
be used to branch to different sections of the script depending on
which key the user presses. This could be useful for providing on-line
help during data entry when the user presses F1, for example.

See our GOODSOFT script for a real example.


-----------
AddLine XXXX
-----------
What it does adds a line to the user's CONFIG.SYS or AUTOEXEC.BAT
file.
See also ModifyConfig, ModifyAutoExec
Usage AddLine =
Example AddLine =echo Have a nice day!

This command will add a line to the CONFIG.SYS file when it is
located in a ModifyConfig script section, or add a line to the
AUTOEXEC.BAT file when placed within a ModifyAutoExec section.

For CONFIG.SYS: The point in the file where the new line is
inserted depends on if you use a FindString command. See the FindString
command for more information.
For AUTOEXEC.BAT: AddLine always adds lines to the end of the file.

o Note that you may use more than one AddLine command to add multiple
lines to the user's file.


-----------
AddPath XXXX
-----------
What it does updates, modifies, or adds to the user's PATH statement
in AUTOEXEC.BAT.
See also ModifyAutoExec
Usage AddPath =
Example AddPath =c:\demo

When you use this command with the ModifyAutoExec and EndAutoExec
commands, INSTALL will search the existing path for a similar or matching
path in AUTOEXEC.BAT. A "similar" path is one where only the drive letter
is different. A matching path is the exact same string as you specified.
If a similar path is found, INSTALL will update the drive letter. If a

matching path is found, INSTALL will not make any modifications. If NO
path or no matching path is found, INSTALL will add a PATH statement or
add your path to the end of the exisiting PATH statement.


-------------
BackPlane
-------------
What it does defines the color and character used for the screen
background.
See also ClearPlane, ClearScreen
Usage BackPlane =
BackPlane on =
Examples BackPlane teal =
BackPlane blue on gray =A

The backplane can be used to create a colorful "workspace" for
your installation program. It is not required - if you desire a
standard black background, see the ClearScreen command.
Custom colors are color combinations we have come up with to save
you some time (and you might not have tried)! ASCII characters 176-178
look especially good as backplane characters.

o Possible custom colors are:
Royal (dark blue)
Teal (greenish blue)
Purple (purple)
Orange (orange)
Mint (pastel green)
Sky (bright light blue)
Steel (dark gray blue)
Slate (gray)


----------
Border
----------
What it does determines a border and border color for a window
See also ShadowColor
Usage Border =
Example Border =Blue

If this command is used, it tells INSTALL to put a border around the
window in the specified color. The default situation for windows is no
border, so if you want a bordered window, use this command. Otherwise,
leave it out of your window section.


-------------
BottomBar
-------------
What it does puts a "status line" on the bottom of the screen
See also TopBar
Usage BottomBar on =
Example BottomBar blue on white =This is a sample line!


A bottom status line may be useful for displaying the names of
files that are being copied, keeping a message such as "Press ESC
to quit" constantly viable, or just to put a border around your
screen.

o The "=" is optional, and if left out, indicates you don't want
any text displayed on the line (i.e. blank status bar).



---------------
BottomTitle
---------------
What it does puts a message on the bottom border of a window
See also TopTitle
Usage BottomTitle =
Example BottomTitle =Press ENTER to continue

The default for a window is no bottom or top titles, so you must
use these commands if you want some messages on the window borders.
Note that the message will be centered on the bottom border. This is
a short-cut to using the Text command for putting some text on the
window border.
The text will be displayed with white characters on the border
color background.



---------------
BuildWindow
---------------
What it does starts the definition of a "window" for display on screen
See also EndWindow
Usage BuildWindow
Example BuildWindow

This command is necessary to start a window definition "section" of
your script. Once you have started to define a window, you can use the
WindowColor, PopUp, Text, TopTitle, BottomTitle, ShadowType, ShadowColor,
and Border window-related commands. A window section would look like
the following...

BuildWindow
.
.
.
EndWindow










------------------
ButtonOffColor XXXX
------------------
What it does Foreground and background color of a button when it
is not highlighted
See also Buttons, ButtonOnColor

Usage ButtonOffColor = on
Example ButtonOffColor =Gray on Blue

This command determines how a button will look when it is not
currently highlighted by the user. When a button is highlighted, the
ButtonOnColor command determines how it will look. Run the DEMO
installation for a real example.


-----------------
ButtonOnColor XXXX
-----------------
What it does Foreground and background color of a button when it
is highlighted
See also Buttons, ButtonOffColor
Usage ButtonOnColor = on
Example ButtonOnColor =White on Blue

This command determines how a button will look when it is currently
highlighted by the user. When a button is highlighted and the user
presses the ENTER key, the user is "choosing" the highlighted button.
Try running the DEMO installation for a real example.



-----------
Buttons XXXX
-----------
What it does starts a button definition section
See also EndButtons, Message, Travel, Distance, Result
Usage Buttons
Example Buttons

Buttons are a means of getting input from the user. Rather than
having the user type in information, you can present him/her with
several choices. The user then just selects a choice. We like to use
buttons to get such information as a disk drive choice from the user
(see our GOODSOFT script).
Defining a button is much like defining a window, as follows...

Buttons
RowMargin =1
ColumnMargin =4
StartRow =window+7
StartCol =window+9
ButtonOnColor =White on Blue
ButtonOffColor =Black on Gray
Travel =Horizontal
Distance =8

Message =A:
Message =B:
Result (1) =A:\
Result (2) =B:\
EndButtons



--------------
ClearPlane
--------------
What it does clears the backplane
See also ClearScreen, BackPlane, TopBar, BottomBar
Usage ClearPlane
Example ClearPlane

ClearPlane will redraw the backplane. This is very useful for
getting rid of windows and text in preparation for the next window.
Note that this command will leave any top or bottom status bars intact.
If you want to erase everything on the screen, use the ClearScreen
command.




---------------
ClearScreen
---------------
What it does clears the entire screen
See also ClearPlane
Usage ClearScreen
Example ClearScreen

ClearScreen creates an entirely black screen. This is very useful
as the first and last commands in your script.


---------------
CloseWindow
---------------
What it does removes a "pop up" window and restores the screen to
its original appearance
See also PopUp
Usage CloseWindow
Example CloseWindow

This command restores the screen to its original display before the
pop up window was put on the screen.



------------
ColdBoot XXXX
------------
What it does initiates a "cold" reboot of the user's computer
See also WarmBoot

Usage ColdBoot
Example ColdBoot

A "cold" reboot is the same as if the user had just turned on
his/her computer. Most computers check the system memory at this point.
For most installations, a warm reboot will be sufficient, however.
It is probably a good idea to allow the user to decide if they want to
reboot the computer.



----------------
ColumnMargin
----------------
What it does leaves X number of columns as space between a window
border and the interior text.
See also RowMargin
Usage ColumnMargin =
Examples ColumnMargin =7

This command is useful for keeping the window text from being
crammed up against the border of a window and helps you create a
balanced look for your windows. A diagram follows...

Col. Col.
Margin Margin
= 7 = 7

: This is some sample window text :




-----------
CopyFile
-----------
What it does specifies a file for INSTALL to copy
See also StartCopy, EndCopy, DestDisk, DestDirectory, SourceDisk
Usage CopyFile
Example CopyFile =FILE.EXE


This command is used to tell INSTALL what files you want copied from
your distribution disk. To copy a bunch of files, just use a CopyFile
command for each one.
Each file name and path should be no longer than 40 characters and
you can only copy up to 40 files with each StartCopy..EndCopy section.
If you need to copy more than 40 files, just use another StartCopy-
EndCopy section.








-----------
Default XXXX
-----------
What it does the default text string for an Input section
See also Input
Usage Default =
Example Default =C:\DEMO

If this command is used, INSTALL will display the specified string
as the initial string in the data entry field. The user may simply
press the ENTER key to accept the default choice. Or, the user may
modify the default string. Use this command for presenting the user
with your preferred choice.
If this command is not used in the Input section, INSTALL will
simply display a blank field.



------------
DestPath
------------
What it does specifies which the disk and directory to copy files to
See also StartCopy, DiskLabel, SourceDisk, SourcePath, CopyFile,
StatusRow, StatusColumn, StatusLineFG, StatusLineBG
Usage DestPath =
Example DestPath =C:\DEMO

This command will tell INSTALL where to copy your files to. If the
destination disk does not have a directory name such as you specify,
INSTALL will create a new directory. You may have only one directory
level specified with the DestDirectory command, but copying files to
a multiple directory structure is easy - just use more StartCopy-EndCopy
sections. (A script example is included with the full Open INSTALL
package).



-------------
DiskLabel
-------------
What it does checks for the expected disk during the file copying
process
See also StartCopy
Usage DiskLabel =
Examples DiskLabel =DEMODISK

DiskLabel is used to make sure that the disk the user has inserted
into the disk drive is the disk that contains the files you are about
to copy. Think of this as "verifying" that the correct distribution
disk has been inserted. This command is especially useful if the user
has multiple distribution disks to choose from.

If INSTALL does not find a match between the disk the user has
inserted and the disk specified by this command, an error message will
be displayed and INSTALL will instruct the user to "try again" or
quit the installation process.


o This command is not required, but is recommended to avoid confusion
for the user.
o A volume ID consists of up to 11 characters.
o You can set the volume ID of your disks using DOS' LABEL command.



------------
Distance XXXX
------------
What it does tells INSTALL how much space to leave between buttons
See also Buttons, Travel
Usage Distance =<# of columns> or <# of rows>
Example Distance =10

This command is interrelated with the Travel command. If you specify
Vertical travel, INSTALL assumes that the Distance you give is in rows.
Conversely, Horizontal travel means that the distance between buttons
will be in columns.
In either case, this is the amount of space INSTALL puts between
buttons when it displays them on-screen.



--------------
DOSVersion
--------------
What it does checks the user's DOS for a minimum acceptable version
See also ProductName
Usage DOSVersion =
Examples DOSVersion =5.0

If your product requires a minimum DOS version to run correctly
(i.e. DOS > 3.2), this allows you to stop the installation process and
warn the user before your software has been installed. This command
would usually be one of the first commands in your script file.
If INSTALL determines that the user's DOS is LOWER than the version
you specifiy, the following message will be displayed and INSTALL
will halt....


Sorry, the minimum DOS version required for this product is
Please contact your service representative or dealer for help.


o Don't use this command unless DOS versions are important to you.
INSTALL doesn't do any checking unless this command is in your script
file.








---------------
EndAutoExec XXXX
---------------
What it does ends a modify AUTOEXEC.BAT section
See also ModifyAutoExec
Usage EndAutoExec
Example EndAutoExec

This command ends a section of your script describing how to modify
the user's AUTOEXEC.BAT file. See the ModifyAutoExec command for the
correct format.


--------------
EndButtons XXXX
--------------
What it does ends a button definition section
See also Buttons
Usage EndButtons
Example EndButtons

This command ends a button definition section of your script. See
the Buttons command for the correct format.



-------------
EndConfig XXXX
-------------
What it does ends a CONFIG.SYS modification section
See also ModifyConfig
Usage EndConfig
Example EndConfig

This command ends a section telling INSTALL how to modify the user's
CONFIG.SYS file. See the ModifyConfig command for more information.



-----------
EndCopy
-----------
What it does ends a "file copy" script command section
See also StartCopy
Usage EndCopy
Example EndCopy

The EndCopy is used to signal to the script compiler the end of
a copy section that was started with the StartCopy command. The
description of the StartCopy command explains the copy process more
completely.






------------
EndInput XXXX
------------
What it does ends an Input definition section
See also Input
Usage EndInput
Example EndInput

This command is used to stop an input definition section.
Please see the Input command for an example of the proper format.




-------------
EndWindow
-------------
What it does ends a window definition section
See also BuildWindow
Usage EndWindow
Example EndWindow

This command is used to stop a window definition section.
Please see the BuildWindow command for an example of the proper format.




-----------------
FindBootDrive XXXX
-----------------
What it does locates the user's boot drive and returns the drive
specification in the script variable, $BOOTDRIVE
See also Script variables
Usage FindBootDrive
Example FindBootDrive

This command will return a string such as "C:\" in the script
variable $BOOTDRIVE. You may then use the result of this command
for setting up the default answer to questions such as...

what directory to install to? C:\DEMO


In the second example above, $BOOTDRIVE is used in place of the
usual text string. Like all script variables, you may use $BOOTDRIVE
anywhere regular text strings are used in a command.










------------
FindDisk
------------
What it does searches all the user's disk drives for a disk with
the specified volume label.
See also Script variables
Usage FindDisk =
Example FindDisk =OPENINSTALL

When this command is used, INSTALL will search all the user's disk
drives until it finds a disk with the same volume label. If a match
is found, INSTALL returns the drive letter in the $FINDRESULT script
variable. Otherwise, $FINDRESULT is blank.
This command is useful when you want to locate one of your old
product software disks for an update or just want to locate the drive
that your distribution disk is in.



--------------
FindString XXXX
--------------
What it does inserts an AddLine line at the point in the CONFIG.SYS
file where the specified string is found.
See also ModifyConfig
Usage FindString =
Example FindString =device

In the example above, FindString will search the user's CONFIG.SYS
file for any lines containing "device". If a match is found, lines
added with the AddLine command will be inserted at the point where
a FindString match was made. This is useful for ensuring that your
product is the first device driver in the file, as our example would
do.
If no match is found, INSTALL will insert all lines at the end
of the file. See our GOODSOFT script for a real example.



---------
Input XXXX
---------
What it does starts a user data entry section
See also EndInput
Usage Input
Example Input

This command starts a section that allows you to get string input
form your user. This is useful for verifying the destination drive
or directory with your user, for example. The format of the input
section follows...
Input
StartRow = window+9
StartColumn =window+30
Action =Enter, Esc



TextColor =White on Blue
Default =$BOOTDRIVEDEMO
Width =15
EndInput



--------
Jump XXXX
--------
What it does skips file execution to the specified procedure name
See also Procedure names
Usage Jump =
or On Jump =
Examples Jump =Quit to DOS
On ESC Jump =Quit to DOS
On ENTER Jump =Start Installation

Jump is used to branch to different sections of the script file
based on something the user has done. For example, if the user presses
ESC to quit, you might want to jump to a procedure explaining what has
been installed so far. Think of Jump as a Goto statement similar to
basic.
If you use the On..Jump format of the command, INSTALL will only
jump to the procedure if the user has pressed the specified key. This
is most useful after a Wait command, so that you can branch somewhere
if the user presses ESC and somewhere else if the user presses ENTER.
Note that the procedure name should be capitalized exactly the same
as you capitalized it for the procedure. We did this to make sure that
procedures were not confused with each other.

o See our example files for more guidance.


-----------
Message XXXX
-----------
What it does defines the message on a button
See also Result, Buttons
Usage Message =
Example Message =Choose me!

The message of a button is what will be shown as a choice for the
user. When the user actually chooses a button, the value specified
with the Result command will be used by INSTALL. We did this to allow
you to use more descriptive text for your buttons, while still getting
the information you need from the user. For example...

Message =Disk Drive A
Result (1) =A:\

Each time you use a Message command in a button section, you are
creating a new button # that needs a corresponding Result command
somewhere.



------------------
ModifyAutoExec XXXX
------------------
What it does starts a modify AUTOEXEC.BAT section
See also EndAutoExec
Usage ModifyAutoExec
Example ModifyAutoExec

This command starts a section telling INSTALL how you want to modify
the user's AUTOEXEC.BAT file. The proper format follows...

ModifyAutoExec
SaveOriginal =autoexec.old
AddLine =echo Have a nice day from Mr. GoodSoft!
EndAutoExec



----------------
ModifyConfig XXXX
----------------
What it does starts a modify CONFIG.SYS section
See also EndConfig
Usage ModifyConfig
Example ModifyConfig

This command begins a section to tell INSTALL how you want to
change the user's CONFIG.SYS file. You can add a line to the file,
REM (comment out) a line, and add a line with CPU-dependant parameters.
The format for this section follows...

ModifyConfig
SaveOriginal =config.old
AddLine =REM device=sample.sys
FindString =device
Parameters
8088 = /PC-XT
80286 = /PC-AT
80386 = /80386
80486 = /80486
EndParameters
EndConfig



--------------
Parameters XXXX
--------------
What it does lets you add product command line switches to any
added CONFIG.SYS lines based on the user's CPU type.
See also ModifyConfig
Usage See below
Example See Below

The format for the Parameters command follows...

Parameters
8088 = /PC-XT
80286 = /PC-AT
80386 = /80386
80486 = /80486
EndParameters

This example tells INSTALL to run a system check and determine
what type of CPU the user's computer has. If the user has an 8088/86
CPU, INSTALL will append "/PC-XT" to any lines added to CONFIG.SYS
with the AddLine command. If the user has a '286 type of CPU, INSTALL
will append "/PC-AT" to any AddLines (and so on).
This feature is primarily useful for device driver products, where
the device driver needs software switches to run at different speeds
or with different features. See the ModifyConfig command for the
"big picture".


---------------
ProductName
---------------
What it does tells INSTALL how to customize error messages
See also
Usage ProductName =
Example ProductName =Cool Demo Software

If INSTALL reports an error message during your user's installation
process, the ProductName command will determine how INSTALL words the
error message. Rather than a generic "This product..." message, INSTALL
could say "Simple Write 1.0..." instead.



---------
PopUp
---------
What it does determines whether a window is a "pop up" window
See also CloseWindow
Usage PopUp =
Example PopUp =Yes

A "pop up" window does not overwrite the screen below it, so that
when you restore a window with the CloseWindow command, your screen
will look unchanged. This is useful for error messages or help windows.
The default type of window is not a pop up, so if you want this
feature, you must use the PopUp command.



----------------
RemarkString XXXX
----------------
What it does "comments out" a line in CONFIG.SYS
See also ModifyConfig
Usage RemarkString =
Example RemarkString =Old product

When used in a ModifyConfig section, this command allows you to
disable lines in the user's CONFIG.SYS that might conflict with your
product without actually removing the lines. Examples might be
REMarking a "Files=10" statement and adding a "Files=20" line, or
disabling a reference to an older version of your product.
See the ModifyConfig command for more information.




----------
Result XXXX
----------
What it does specifies the result of a button
See also Message, Buttons
Usage Result (button #) =
Examples Result (1) =A:\
Result (2) =B:\

This command is used to determine what value will be returned by
INSTALL when the user chooses a button. Every button created with
the Message command needs a Result command.
Note that you may use the result of the user's button choice in
your script. The button result is returned by INSTALL in the
$BUTTONRESULT script variable. You may use this variable anywhere you
would use a normal text string.



-------------
RowMargin
-------------
What it does leaves X number of rows as space between a window
border and the interior text.
See also ColumnMargin
Usage RowMargin =
Example RowMargin =1

This command is useful for keeping the window text from being
crammed up against the border of a window and helps you create a
balanced look for your windows. A diagram follows...

-----------------------------------
Row Margin =1
This is some sample window text
Row Margin =1
-----------------------------------



--------------
RunProgram XXXX
--------------
What it does run a program outside of INSTALL
See also
Usage RunProgram =

Example RunProgram =chkdsk C:

This command causes INSTALL to run a DOS process and execute the
specified command line, just as if it was typed at the DOS prompt.
INSTALL loses control of the screen at this point, so it's important
for you to make sure that the screen looks the way you want.
INSTALL will handle any DOS errors that occur when trying to run
the program (such as "File not found"), but it is up to the external
program to handle errors once it has control.
If the external program is one of your own programs, it is possible
to match the installation look to the external program, so that the
user will see a "seamless" installation.
Note: until we add compression/archiving features to INSTALL, this
allows you to use your favorite (and probably better anyway!) utility.




----------------
SaveOriginal XXXX
----------------
What it does allows you to save a copy of the user's CONFIG.SYS or
AUTOEXEC.BAT file before you make any modifications.
See also ModifyConfig, AutoExec
Usage SaveOriginal =
Example SaveOriginal =CONFIG.OLD

This command tells INSTALL to make a copy of the user's CONFIG.SYS
or AUTOEXEC.BAT file before any changes are made. This can help you
assure the customer that any changes to their setup are not permanent.



---------------
ShadowColor
---------------
What it does determines the color of a window
See also ShadowType, Border
Usage ShadowColor =
Example ShadowColor =Gray

This command can give different looks for windows placed within
other windows. Experiment with different colors to find a unique look.



--------------
ShadowType
--------------
What it does determines the type of shadow to use for a window
See also ShadowColor, Border
Usage ShadowType =
Examples ShadowType =None
ShadowType =Small

The ShadowType command determines the type of shadow to use for the

window. A shadow creates a minor 3-D effect for the window. A Big
shadow uses the backplane characters to create the shadow. This type
looks best for windows displayed directly on the backplane. A Small
shadow type looks best for windows placed within other windows.
The default type for a window is Big.



--------------
SourceDisk
--------------
What it does specifies where to locate files for a copy
See also StartCopy, DiskLabel, DestDisk, DestDirectory, File,
StatusRow, StatusColumn, StatusLineFG, StatusLineBG
Usage SourceDisk =
Examples SourceDisk =A:\
SourceDisk =$BUTTONRESULT

SourceDisk is used to tell INSTALL where to find files that you
want to copy somewhere. Note that instead of directly specifying the
drive letter, you can use a script variable such as $BOOTDRIVE or
$BUTTONRESULT. This is useful for allowing your user to choose the
drive where your software disks are located.



--------------
SourcePath
--------------
What it does specifies where to locate files for a copy
See also StartCopy, DiskLabel, SourceDisk
Usage SourcePath =
Examples SourcePath =DEMO\EXAMPLES
SourcePath =DEMO

SourcePath is used to tell INSTALL where to find files that you
want to copy somewhere. Use this command along with the SourceDisk
command to tell INSTALL where to find files on your distribution disk.




---------------
StartColumn
---------------
What it does specifies the column on which to start the left edge of
the window
See also StartRow
Usage StartColumn = or
or >
Examples StartColumn =5
StartColumn =Center
StartColumn =Window+1

The first example is used when you want to start the window on a
specific column. The second example is a short-cut and tells the script
generator to automatically center the window on the screen. The third

example is useful for placing windows within another window. The
example will start the new window on the previous window's StartColumn
one more column. You can see how this will place the window within the
previous window.

o See our GOODSOFT script for more examples.



-------------
StartCopy
-------------
What it does starts a "copy files" script section
See also EndCopy, DiskLabel, SourceDisk, DestDisk,
DestDirectory, StatusRow, StatusColumn, StatusLineFG,
StatusLineBG, File
Usage StartCopy
Example StartCopy

The StartCopy command is used to begin a file copying section of
script file comands. This command is necessary before you use the
DiskLabel, SourceDisk, DestDisk, DestDirectory, etc. copying commands.
Every StartCopy command must eventually be followed by an EndCopy
command, as in the example below...

StartCopy
DiskLabel =SAMPLE
SourceDisk =$BUTTONRESULT
DestDisk =$BOOTDRIVE
DestDirecoty =DEMO
File =DEMO.EXE
File =DEMO.DAT
EndCopy

Note that there are several tricks to keep in mind when using the
copying script commands. One: each StartCop-EndCopy block of commands
can only copy a maximum of 40 files at one time. If you need to copy
more, just start another copy section. Two: If you have multiple
distribution disks, just prompt the user to insert the next disk and
then start a new copy section for that disk.




------------
StartRow
------------
What it does specifies the row on which to start the top edge of
the window
See also StartColumn
Usage StartRow = or
or >
Examples StartRow =2
StartRow =Center
StartRow =Window+2

The first example is used when you want to start the window on a

specific row. The second example is a short-cut and tells the script
generator to automatically center the window on the screen. The third
example is useful for placing windows within another window. The
example will start the new window on the previous window's StartRow
two more rows.

o See our GOODSOFT script for more examples.



----------------
StatusLineBG
----------------
What it does specifies the background color for a copying status
message.
See also StartCopy, DiskLabel, SourceDisk, DestDisk,
DestDirectory, EndCopy, StatusRow, StatusColumn,
StatusLineFG, File
Usage StatusLineBG =
Example StatusLineBG =Blue

Please see the StatusLineFG command for a more detailed description.


----------------
StatusLineFG
----------------
What it does specifies the foreground color for a copying status
message.
See also StartCopy, DiskLabel, SourceDisk, DestDisk,
DestDirectory, EndCopy, StatusRow, StatusColumn,
StatusLineBG, File
Usage StatusLineFG =
Example StatusLineFG =White

This command will determine the forground color of a copying status
message that INSTALL displays. Specifying the colors of the message
allow you to match any existing windows or text you have on the screen.



----------------
StatusColumn
----------------
What it does column (or X) coordinate for a "now copying file: "
type of status message.
See also StartCopy, DiskLabel, SourceDisk, DestDisk,
DestDirectory, EndCopy, StatusRow, StatusLineFG,
StatusLineBG, File
Usage StatusColumn =
Example StatusRolumn =10

Please see the StatusRow command for a more detailed description
of the copy status message process.



-------------
StatusRow
-------------
What it does row (or Y) coordinate for a "now copying file: " type
of status message.
See also StartCopy, DiskLabel, SourceDisk, DestDisk, EndCopy,
StatusColumn, StatusLineFG, StatusLineBG, File
Usage StatusRow =
Example StatusRow =10

The StatusRow command, when used with the other StatusXXX commands,
allows you to keep your user up to date about which file is currently
being copied. INSTALL needs to know the row and column coordinate, as
well as the colors you wish to use for the message. The message itself
consists of the filename (with extension) in capital letters.
You should plan for a maximum of 40 characters to be displayed if
you use the copy status message feature.



--------
Stop
--------
What it does tells script generator to stop processing the
script file.
See also
Usage Stop
Example Stop

This command is not actually necessary, as the script generator
will automatically stop proceesing a script file when it reaches the
end. This command is useful, however, for making script files easier
to read.



--------
Text
--------
What it does draws text on the screen
See also
Usage Text on =
Example Text white on blue 10,15 =Sample text string!

The Text command allows you to place a text string on the screen
in a specified color. This is useful for updating the text of a window
after the window has already been drawn, for example.
Note that the row and column coordinates are based on the top left
corner of the screen being (1,1) and the lower right corner being
(80,25).

This command may also be used within a window section. If it is used
in this way, the column and row coordinates will be based on the top,
left corner of the window, instead of this screen. This allows you to
move the window around without having to update your text coordinates.



----------
TopBar
----------
What it does puts a "status line" at the top of the screen
See also BottomBar
Usage TopBar on =
Example TopBar white on red =Sample Installation Program

A top status line can be very useful for displaying the name of
your product or the name of the installation program.

o The "=" is optional, and if left out, indicates you don't want
any text displayed on the line (i.e. blank status bar).



------------
TopTitle
------------
What it does puts a text message on the top border of a window
See also BottomTitle
Usage TopTitle =
Example TopTitle =Sample Installation Program

The message will be centered in the window and be displayed with
white characters on the border color background. Also see the
BottomTitle command.



----------
Travel XXXX
----------
What it does tells INSTALL what keys the user may press to move
through the button choices.
See also Buttons, Distance
Usage Travel = OR
Examples Travel =Horizontal
Travel =Vertical

This command is used by the script generator to determine what
keys the user will be allowed to press to highlight the different
button choices. For example, if you specify Vertical travel INSTALL
assumes that the buttons are arranged vertically, and lets the user
press the UP and DOWN arrow keys to choose. Alternatively, Horizontal
travel indicates that the buttons are arranged horizontally and INSTALL
lets the user press the left and right arrow keys. There is no default,
so you must use this command.

Please see our GOODSOFT script if you are still confused.






--------
Wait
--------
What it does waits for the user to press a specified set of keys
See also Jump
Usage Wait =, ,....
Examples Wait = Enter, Esc

The wait command is useful when you want a user to "press ENTER
to continue...". The INSTALL program will wait for the user to press
one of the keys your specify. See the Jump command for branching
to a different section of the script file based on which key the user
presses.

o Possible script file keywords are:
Esc (escape key)
Enter (enter or return key)
Space (space bar)
BackSp (backspace key)
Tab (tab key)
PageUp (PgUp key)
PageDn (PgDn key)
F1 F2 F3 F4 F5 (function keys)
F6 F7 F8 F9 F10 (function keys)




------------
WarmBoot XXXX
------------
What it does initiates a "warm" reboot of the user's computer
See also ColdBoot
Usage WarmBoot
Example WarmBoot

A "warm" reboot is the same as if the user had pressed the
Ctrl+Alt+Del keys. For products such as device drivers, this command
can allow you to install your product automatically without having
to instruct the user to reboot their computer. It is probably a good
idea to allow the user to decide to reboot, however.
If you want to do a memory check during the reboot, see the
ColdBoot command.




---------
Width
---------
What it does specifies the width of data entry for an Input section
See also Input
Usage Width =<# of columns>
Example Width =10

The width of the user's data entry will determine the maximum amount

of characters the user may enter. For example, if you were asking the
user for a filename, you would probably want to keep the width at 8,
the DOS limit for filenames.


---------------
WindowColor
---------------
What it does specifies the color of a window
See also ShadowColor, Border
Usage WindowColor =
Example WindowColor =Gray

This command determines that color of a window. See the Border
command to determine the border color for the window and the
ShadowColor command to specify the shadow color for a window.





 December 31, 2017  Add comments

Leave a Reply