Help file for GoHome.

@@Contents
HelpOnHelp   : `1Help on Help`0
Overview     : `1GoHome Overview`0
CommandLine  : `1Command line parameters`0
HotKey       : `1Changing the Hot-Key`0
ConfigFile   : `1Using a config file`0
@@SectionHdr :
@@SectionHdr :             `2GoHome Main Menu `0
@@SectionHdr :
MainMenu     : `1Main Menu`0
GoSchedule   : `1GoSchedule`0      Run the GoSched program
Record       : `1Record Script`0   Start recording a script
Playback     : `1Playback Script`0 Playback a script file
RunTask      : `1Run a Task`0      Run a task
DOSShell     : `1DOS Shell`0       Run the DOS shell
BlankScreen  : `1Blank Screen`0    Blank the screen
Suspend      : `1Suspend Tasks`0   Suspend scheduled tasks
@@SectionHdr :
@@SectionHdr :             `2Task Types`0
@@SectionHdr :
Batch        : `1Batch Files`0     Run a DOS batch file (.bat)
Command      : `1Command(s)`0      Run a number of commands
Script       : `1Script`0          Playback a script file
Reminder     : `1Reminder`0        Display a reminder message
@@SectionHdr :
@@SectionHdr :             `2Miscellaneous`0
@@SectionHdr :
MemReq       : `1Memory Usage`0
SchedTasks   : `1Scheduling Tasks`0
TaskDataFile : `1Task Data File`0
PopCntDown   : `1Countdown Window`0
Log          : `1Log file`0
ChgTime      : `1Read this if your change your computers time`0
@@EndContents



@@Help
[HelpOnHelp]
To use help, select the topic you want help on from the topics
list (enter 'T' to get back to the topics list). Use the
cursor and page keys to scroll through the text. The `2 Next`0
and `2 Previous `0 buttons move to the next and previous
topic, respectively.

All of the buttons in `1GoHelp`0 can be executed by simply
pressing the key that is highlighted on the button. You can
also TAB to the button or press it's accelerator key (press
<ALT> + key hightlighted on button label).

To get help on a particular program, run `1GoHelp`0 with the
first argument on the command line set: `1GoHome`0,
`1GoScript`0, `1GoSched`0, or `1GoEd`0. You can also run
`1GoHelp`0 with no arguments, in which case you will be
presented with a menu to select the program you want help on.

þ

[Overview]
`1GoHome`0 is a `1Task Scheduler`0 and a `1Program Automator`0.
It allows you to get more out of your computer by letting you
schedule programs to run unattended. It also helps you to be
more productive with the applications you use everday through
its powerful scripting capabilities. All of `1GoHome`0's 
powerful capabilities are available at the touch of a key and
at anytime.

`1GoHome`0 has a very flexible scheduler that allows you to
run tasks whenever it's necessary. Tasks can be scheduled to
run at any time, day or night. You'll often want to schedule
programs late at night (for instance, dial-up a BBS and
download data when the phone charges are cheaper) or when
resources are less busy (print documents when the printer
isn't being used), etc. Tasks can be scheduled to run on
specific weekdays (ie. every Monday, Wednesday, Friday),
specific days of the month (ie. on the 1st and 15th day of
every month), or on a specific date (ie. November 1, 1994).
Tasks can even be scheduled to run at designated intervals
throughtout the day (ie. run every 10 minutes between 11:00 am
and 5:00 pm). 

As well as scheduling programs, `1GoHome`0 can also be
taught to run programs from start to finish. This allows you
to run programs that require keyboard input `1auto-magically`0!
It's even possible to use `1GoHome`0 as a sophiscated "keyboard"
macro program to execute specfic tasks within a program.

`1GoHome`0 goes way beyond what traditional keyboard macro 
programs can do. In addition to memorizing the keystrokes and
the delays between them, `1GoHome`0 can also wait until a
portion of the screen contains a specific pattern of text,
prompt you for additional data, display menus, print to a 
printer or file, enter time and date information, and many,
many more features.

`1GoHome`0 calls a sequence of events a `2script`0. Scripts
may be of varying length up to a max of approximately 32K. The
size of the script or the number of scripts created does not
affect the size of the resident portion of `1GoHome`0.

`1GoHome`0 also comes with a very easy to use task scheduler,
script editor, file editor (for quickly editing batch files 
and other small files), and a complete context sensitive help
system. See `2Help On Help`0 for infomation on how to get
help for these programs or consult the manual. 

þ


[CommandLine]
The syntax for running `1GoHome`0 is:

  gohome [`1parameters`0] [`1configFile`0] 

where

`1parameters`0 can be any number of the following:

/U              Remove `1GoHome`0 from memory
/F=`1tskFile`0      Schedule the tasks in `1tskFile`0. If a path
                is not specified, the current directory is used.
/RUN=`1x`0          Run the `1x`0-th task immediately
/PLAY=`1script`0    Play the specified script file. This option
                    is generally used to run scripts from a 
                    batch file.
/BLNK=`1x`0         Blank screen after `1x`0 minutes
/ALLOC=`1x`0        Allocate room for an extra `1x`0 tasks
/MAX=`1x`0          Allocate room for a maximum of `1x`0 tasks
                `1x`0 must be between 5 and 100.  This option
                is only used when creating a new task data file
/EMS            Don't swap to EMS, even if available
/XMS            Don't swap to XMS, even if available
/SUSPEND=[`1Y`0|N]  Suspend any tasks that are scheduled
/SHUSH=[`1Y`0|N]    Run silently (no bells or whistles)
/CSET=[b|m|`11`0|2|3|4 Select color set `1x`0
/DBG=[`1Y`0|N]      Display script actions during playback
/DUMPDBG        Do not go resident with script debug info
/DPMthd=[`10`0|1]   When at DOS Prompt: 0 -> stuff commands; 
                                      1 -> swap
/NOHI           Program has not been loaded into High Memory
/HK=`1x`0           Change Hot-Key to `1x`0 
                Default hotkey is `1<Ctrl><SPACE>`0
                (See the next section `3Changing the Hot-Key`0 for
                more detail)


For information on `3config files`0 see `2Using a config file`0.
þ

[HotKey]
You can change the hot-key (default hotkey is `1<Ctrl><SPACE>`0) by
using the `1/HK=x`0 command line parameter. Combine the folowing
characters to specify a new hot-key:

        To specify Alt, Ctrl, and Shift keys use:
             A  => Left Alt
             RA => Right Alt
             S  => Left Shift
             RS => Right Shift
             C  => Left Ctrl
             RC => Right Ctrl

         For function keys use:
             F1, F2, ..., F10, F11, F12

         Special keys are specified using:
             \r => Enter 
             \t => Tab  
             \l => Cap Lock 
             \b => Back space 
             \s => space 
             \e => Esc
             \\ => \
             \f => / 
 
         Numeric keypad keys
             \1 => 1 or End
             \2 => 2 or Down arrow
               .. 
             \0 => 0 or Ins
             \. => . or Del

        Use the plus (+) sign to concatenate keys. If there
        are no Ctrl/Shift/Alt flags in your hot-key you must
        preceed the hot-key definition with '+'. 

        Examples:

           /HK=`1x`0       Hot key(s) used to invoke `1GoHome`0
           ------     ---------------------------------------
            CS+A   => <Ctl><Shift>A
            A+F12  => <Left Alt><F12>
            S+F11  => <Left Shift><F11>
            +F12   => <F12>
            C+\B   => <Ctrl><Backspace>
            A+\t   => <Alt><TAB>
            C+\.   => <Ctrl><Numeric keypad's <Del> key>
            A+\5   => <Alt><Numeric keypad's <5> key>
þ


[ConfigFile] 
A config file is used by all the programs to avoid having to
enter command line parameters every time you run the program. 
A config file is an ordinary text file that contains any
number of command line parameters that you want to have set
each time you run the program. 

The config file to use is indicated on the command line
preceded with an '@' charcter (ie. gohome @goho.cfg).  If a
config file is not specifed on the command line, `1GoHome`0
looks for the file `1gohome.cfg`0 in the same directory as
gohome.exe. If a config file is specified or `1gohome.cfg`0
exists, all parameters in that file will be processed
`1before`0 processing any of the command line parameters. This
allows you to store a common configuration in a config file
but still be able to override it on the command line. 

The following is a list of default config files used by the
`1GoHome`0 programs:

        Program      Default config file
       ---------    ---------------------
      `1GoHome`0           GOHOME.CFG
      `1GoSched`0          GOSCHED.CFG
      `1GoScript`0         GOSCRIPT.CFG
      `1GoEd`0             GOED.CFG
      `1GoHelp`0           GOHELP.CFG

þ


   ******* GoHome menu items ********

[MainMenu]
To activate `1GoHome`0's main menu, press the defined hot-key.
The default hot-key for `1GoHome`0 is `2<Ctrl-SPACE>`0 (hold down 
the <Ctrl> key and tap the space bar). 

The hot-key used to pop-up `1GoHome`0 may be redefined to 
another key sequence that you prefer or to one that doesn't
interfere with any applications you may run. You define a
hot-key by using the `1/HK=xxx`0 option on the command line or
in `1GoHome.cfg`0. See the help section under `2Command line`0
`2parameters`0 for information on how to specify the hot-key and
for samples.

When chosing a hot-key, you should consider using a key 
sequence that won't interfere with any of the programs you may
run. Generally, you should stay away from using the `2<ALT>`0 key
since many programs use that key to highlight an item in the
menubar. If you'll be running `1GoHome`0 in a DOS box under MS
Windows, avoid any Window defined hot-keys such as
`2<Ctrl><Esc>`0. 

See also `4Command line parameters`0
þ

[GoSchedule]
Select `2GoSchedule`0 from `1GoHome`0's main menu to envoke
the program scheduler, `1GoSched`0. `1GoSched`0 can also be
run from the DOS command line, however, using the main menu is
simpler and it allows you to pop-up the scheduler even if
you're in the middle of another program.

If you want to run a task and you don't recall its task
number, bring up `1GoSched`0 which will display a list of
tasks from which you can then execute.

See also `4Run a Task`0 and `4Main Menu`0
þ

[Record] 
Selecting `2Record Script`0 will enter `1GoHome`0's record
mode. Record mode allows you to "teach" `1GoHome`0 how to run
a program. In this mode, `1GoHome`0 changes the main menu to a
recording menu that lists a subset of the script items that
can be entered into the script being recorded. 

The record menu contains the script commands that are
frequently used and most of which are "interactive". By
interactive we mean that they require some form of input for
the user. For example, selecting `2Start Key Recording`0 from
the menu tells `1GoHome`0 to record all the keystrokes that
you enter and the time interval between keypresses. If you
select `2WaitAtPos`0 or `2WaitRelCrs`0 you'll be
prompted to select the region on the screen that is to be
watched (examined) for a given text pattern.  

As stated previously, the script commands in the record menu
are a subset of the available script commands. Once the
interactive or general format of a script has been recorded,
you may want to add additional script commands by using the
script editor, `1GoScript.exe`0. For information on
`2GoScript`0 see the on-line help (at the DOS command line
enter 'gohelp goscript') or the manual.

The following is a brief overview of the script commands 
available from the record menu:

    Keys                   - Record all keystrokes and the 
                             time interval between them.
    WaitKeyBuff            - Wait until all the keys in the
                             keyboard buffer have been read in
                             by the program currently running.
                             (Note: the program currently 
                             running may be the DOS command 
                             prompt).
    Delay                  - Pause playing back the script for
                             a specified number of seconds.
    WaitAtPos              - Wait until the specified text 
                             appears in a defined section of
                             the display. A timeout value may
                             be specified when the script 
                             editor (`2GoScript.exe`0) is used. 
    WaitRelCrs             - Wait until the specified text
                             appears relative to the current
                             cursor position. A timeout value
                             may be specified when the script 
                             editor (`2GoScript.exe`0) is used. 
    Comment                - Enter a comment. A comment is 
                             used to describe what the script
                             is doing. This description can
                             be anything that you feel is 
                             important to remember - it is
                             not used by `1GoHome`0. It may 
                             also be useful to make notes of
                             script commands that you want to
                             add using `1GoScript`0.
    Beeper                 - Make a beeping noise. The type of
                             beep that is made can be changed
                             by modifying it in `1GoScript`0.
    Save Macro             - Stop recording the script and
                             save it to file.



See also `4Playback Script`0 and the on-line help for `4GoScript`0
þ

[Playback]
Selecting `2Playback Script`0 from the main menu will bring
up a dialog box for entering the script file to play. This
is an easy way for playing scripts that perform "tasks"
within a program. 

If the script that you want to play back is meant to be run
from the DOS command line, you'll need to make sure that
it's started there. 

An alternative to running scripts that must start at the DOS
command line is to schedule them using `1GoSched.exe`0 (use
`1GoHome`0's main menu and select `2GoSchedule`0). Once in
`1GoSched`0, bring up the Advanced dialog box and make sure
that the `2Start Script at the DOS Prompt`0 check box is
checked. Now that the task is scheduled you can run it using
the `2Run a Task`0 item from the main menu. If you are not at
the DOS command line, `1GoHome`0 will swap out the current
application and start a new copy of the DOS command processor
(COMMAND.COM) before starting the script. If you are already at
the DOS command line, then `1GoHome`0 won't start up another
DOS command processor, it'll type in the commands just as you
would.

See also `4Run a Task`0  `4Record Script`0  `4GoSched Help`0
þ

[RunTask]
Selecting the `2Run a Task`0 item from `1GoHome`0's main menu
will pop-up a dialog box requesting the number of the task to 
run. Use `2Run a Task`0 to execute a task that has been 
assigned using `1GoSched`0. 

The number of the task is the number of the task in the
`1GoSched`0's Task List. You can move tasks while in `1GoSched`0
by first pressing `2F7`0 to delete the task and then moving to the 
task number that you want to place it at and entering `2F8`0 to
paste the task.

Since numbers are hard to remember, `1GoHome`0 also accepts
single characters in place of a task number. The characters 
are mapped directly to a number by assigning the letter 'A' to
1, 'B' to 2, ..., and 'Z' to 26. Note that this only works for
the first 26 tasks. Lowercase is treated the same as uppercase
letters. 

As an example, you could assign a task that does your backup
to task 2 (or 'B') for backup; or assign task 5 (or 'e') to
bring up you text editor with a default file loaded.

As an alternative to using the `2Run a Task`0 command, you can simply
bring up `1GoSched`0 (from main menu select `2Run a Task`0),
position the highlight line in the Task List to the task to
run, and press `2F4`0 to run the task. `1GoSched`0 will quit
and the task will run. You may want to add the option `2/LIST`0
to `1GoSched`0's config file to display only the Task List.

See also `4GoSched`0 help file
þ


[DOSShell]
Selecting `2DOS Shell`0 from the main menu will swap out the
current application and start up a new copy of the DOS command
processor. At this point you can do whatever you want to. When
you're done, type "EXIT" at the DOS prompt to return right
where you left off in your application.

IMPORTANT: In order to determine the DOS command processor
you're using, `1GoHome`0 will look for 'COMSPEC=xxx' in your
environment table. It's important for this variable to be set
to a valid command processor. Check your AUTOEXEC.BAT file
for a statment similar to 'SET COMSPEC=xxx' where 'xxx' is
the location and name of your DOS command processor. Typically,
COMSPEC will be set to C:\COMMAND.COM or C:\DOS\COMMAND.COM.
If you're using NDOS then C:\NORTON\NDOS.COM or if 4DOS then
C:\4DOS\4DOS.COM.

þ

[BlankScreen]
Selecting `2Blank Screen`0 from the main menu will immediately
blank the screen. `1GoHome`0 can be configured to blank the
screen after a certain period of time has elapsed since a key
was pressed.  This screen timeout period can be specified with
the `1/BLNK='xxx'`0 command line option where 'xxx' is the
number of minutes to wait after a key was pressed before
blanking the screen. The default timeout interval in 5
minutes. 

The screen is immediately un-blanked when any key is pressed.

The timeout interval can also be set through the 
`2Blank Screen`0 command in `1GoScript`0.


See also: `4GoScript`0 help file.
þ

[Suspend]
Selecting the `2Suspend Tasks`0 menu item from `1GoHome`0's main 
menu will temporarily suspend all scheduled tasks. Once tasks
are suspended, the `2Suspend Tasks`0 menu item changes to
`2Resume Tasks`0 and all the other menu items, except `2Blank Screen`0,
are disabled. Selecting `2Resume Tasks`0 will re-enable all
scheduled tasks.

You will want to suspend tasks when you are in the middle of
something that you don't want to be interrupted. It is also
very IMPORTANT that you suspend all tasks when running a
program that may modify your hard disk or requiers that it not
be interrupted. Examples of this type of program are disk
compression utilities.

Note that tasks may also be suspend by running `1GoHome`0 again
but with the `2\suspend`0 parameter. Running `1GoHome`0 with
this parameter will notify the resident version to suspend
tasks. 

To avoid having `1GoHome`0 interfere with these types of programs
you can make sure that these programs are only run by having
`1GoHome`0 run them for you (ie. enter a task in `1GoSched`0
that will run the application at a specified time or manually
by using the `2Run a Task`0 option). Another option would be to
create a batch file that suspends the tasks, runs the program, and
then resumes the tasks. For example,

        gohome /suspend=y
        REM run disk commpression/defrager
        diskfrag.exe
        gohome /suspend=n
þ


     ******* Task Types ********

[Batch]
This type of task is used to run a batch file. It's important 
that the batch file is either in your PATH or that you specify 
the full path of the batch file so that `1GoHome`0 can find it
no matter what the current directory may be. 

þ

[Command]
For a command task, you specify one or more commands just as
you would if they were typed in at the DOS command line. For
multiple commands, use a semi-colon (';') to seperate them.
For example, the following would list the contents of the
current directory and then list the amount of memory you
have available:
   
       DIR; MEM /C
þ

[Script]
To have `1GoHome`0 play back a script file, pop-up GoHome's menu
with the hotkey (default is <Ctrl-SPACE>) and press the letter
<P>. You will be prompted for the script file to play. If a
directory isn't specified, GoHome will use its home directory
to find the file. 
þ

[Reminder]
A reminder will pop-up a window at the specified time. You may
display a message of up to 128 characters. Use reminders to
notify you of appointments or things to do.

IMPORTANT: If `1GoHome`0 is in the middle of running a task,
all `2Reminders`0 are post-poned until that task finishes.
If the task is a long one then the reminder may not appear
at its scheduled time. 

When the scheduled time arrives and assumming that a task isn't
already running, `1GoHome`0 pops-up a window, displays your
text, and waits for you to hit the <Enter> key. If the <Enter>
key is not hit after one minute, `1GoHome`0 will bring down
the window. It does this in case you have a program currently
running or a task is scheduled after it. If it didn't remove
the Reminder window, any program that happend to be running
would be suppended until you removed the Reminder and all tasks
that were scheduled wouldn't be able to run until <Enter> was
pressed.

`1GoHome`0 keeps a list of all the Reminders that you missed
and will display them the first time you hit any key. If 
`1GoHome`0 is in the middle of running a task, then the Reminders
aren't shown until after the task completes.
þ


  ***** Misc ******

[MemReq]
`1GoHome`0 is a TSR that requires appoximately 40K of
conventional memory. Each task requires only 10 bytes of
memory. When a task is due, `1GoHome`0 will read the task
data file to get the rest of the information necessary to run
the task. Script files may be of any size up to approximately
32K. `1GoHome`0 uses a fixed internal buffer that pages
portions of the script file into memory. This enables it to
run script files of varying length without requiring
additional conentional memory be used.

When it comes time to run an task, `1GoHome`0 first checks to
see if the computer is at the DOS prompt. If it is not,
`1Gohome`0 will swap the program out of memory to make more
memory availble to the task about to run. When the task
completes, the swapped out program is returned to its original
running condition. If there is no program currently running
and the computer is at the DOS prompt, `1GoHome`0 will not
have to swap out any programs to make room for the task.

If it is necessary for `1GoHome`0 to swap out the program
currently running, it has three options of where to store the
progam's "image":  XMS, EMS, or the hard drive. Where it swaps
to will affect system performance. Both XMS and EMS are fast
while saving to the hard drive can be somewhat slow. 

When it has to swap, `1GoHome`0 will first check to see if XMS
memory is avaible and that the required amount of XMS memory
is availble. If so, it will use XMS. If XMS is not availble,
it will next check to see of EMS memory is availble. If not,
it lastly tries to swap the program to the hard drive
specified by the environment variable, `3TEMP`0. If
insufficient disk space is available, the task will not be
run. 

You can tell `1GoHome`0 to not use either XMS or EMS by
specifying on the command line the following parameters,
`3/XMS`0 and `3/EMS`0, respectively. There is also an option
in `1GoSched`0 in the `2Options`0 dialog box to specify that
when swapping this particular task, swap it to the hard drive.
This may be necessary if the program uses XMS or EMS memory
and there may not be enough availble to the program if
`1GoHome`0 XMS or EMS also.

þ

[SchedTasks]
Tasks are scheduled using `1GoSched`0 (see help or manual for
details on using `1GoSched`0). An easy way to run `1GoSched`0
is to select it in `1GoHome`0's main menu. `1GoSched`0
communicates with `1GoHome`0 and updates `1GoHome`0 with any
scheduling changes that were made.

When it's time to run a task, `1GoHome`0 will pop-up a countdown
window. If you do not cancel the task or respond within fifteen
seconds `1GoHome`0 will proceed to run the task (see also 
`4Countdown Window`0).


See also `4Countdown Window`0 and `4Run a Task`0
þ

[TaskDataFile]
`1GoHome`0 stores all the task information in a task data file
(usually this will have a  '.dat' extension). If a task data
file was not specified on the command line (/f=filename),
`1GoHome`0 will assume that the task file is `1tasks.dat`0. If
the task data file does not exist, `1GoHome`0 will create one
that contains room for twenty tasks. To allocate additional
tasks, at any time, use the command line parameters
`3/ALLOC=x`0 and `3/MAX`0 

see also `4Command line parameters`0

þ

[PopCntDown]
A Countdown dialog box is displayed whenever a task is ready
to run. The task will run in 15 seconds unless it is canceled
or delayed. A task can be canceled (won't execure) if the 'C' or ESC
key is pressed. Press 'R' or ENTER to run the task
immediately, or press 'S' to snooze which will delay the task
for 5 minutes. 

A number key can also be pressed to delay running the task for
that number of minutes. For instance, if '2' is pressed, the
task is delayed for 2 minutes. However, '0' is the exeception;
it will delay the task for just 15 seconds. The should give
you enough time to save any work that you are working on
before the task is started. 
þ

[Log]
A log file is updated each time a task is run. If you don't
want a task to be logged each time its run, you can bring 
up GoSched and select 'Don't Log task' in the `2Advanced dialog`0
box.

The log file contains the date and time that the task was 
started and when it completed. It also shows a result code and
the task description. The result is the errorlevel returned
by the last application to run for the task or it is a
negative number indicating that GoHome was unable to run the
task. The following are some of the possible error codes and
their causes:

    >= 0   Errorlevel returned by the last application in the
           task to run.

   -2      Script file was not found.
   -100    An error occured when trying to save/restore the
           screen image.
   -101    Insufficient disk space.
   -102    Unable to swap the current program to make room for
           the task.
   -103    Unable to swap out the requested amount memory. 
           If the task can run in less memory, reduce the
           minumum memory required in GoSched's Advanced 
           dialog box.
   -104    Swap file could not be created.
   -105    Task data file not found, invalid, or corrupt.
   -106    Unable to restore the program that was interrupted
           so that a task could run. `1GoHome`0 will not be
           able to restore the program if its swap file
           has been deleted. It is therefor `4VERY`0 important
           that you don't delete its swap file.
   -107    Unable to swap out current application to run task
           because in an MS Windows DOS box or an OS/2 DOS 
           box.

The log file's name if made up of the current month and year.
It has the following format:  `1GO_mm-yy.log`0 where 'mm' is 
the current month and 'yy' is the last two digits of current
year. The log file is created in the same directory that the
current task data file is in.
þ


[ChgTime]
It you change your computers time (ie. use DOS's time command)
while GoHome is loaded, you'll need to unload GoHome and then
run GoHome again. This will allow GoHome to schedule the
tasks according to the new time. 
þ

[last]
text for last
`11`22`33`44`55`66`77`88`99`00

@@EndHelp
