Help file for GoHome.

@@Contents
HelpOnHelp   : `1Using Help`0
Overview     : `1GoSched Overview`0
CommandLine  : `1Command line parameters`0
@@SectionHdr :
@@SectionHdr :      `2GoSched Edit Fields`0
@@SectionHdr :
TDescrip     : `1Task Description field`0
TType        : `1Task Type field`0
TFilename    : `1File name/Script name/Note field`0
TStartTime   : `1Start Time field`0
TEndTime     : `1End Time field`0
TRepeat      : `1Min Repeat field`0
TWhen        : `1When field`0
TOptions     : `1Options button`0
TTempDisable : `1Disable check box`0
TaskList     : `1Task List`0
@@SectionHdr :
@@SectionHdr :    `2Option Dialog Box Fields`0
@@SectionHdr :
OptionsDlg   : `1Options Dialog`0
OVidSave     : `1Video Save radio buttons`0
OMemory      : `1Memory Requirements`0
OSwap        : `1Swap to File Only`0
OPrompt      : `1Start Script At Dos Prompt`0
OPause       : `1Pause when done`0
ONoLog       : `1Don't log task`0
ONoCount     : `1No countdown window`0
@@SectionHdr:
@@SectionHdr:                    `2Function Keys`0
@@SectionHdr:
FnHelp       : `1F1`0   Display help for the currently hightlighted field
FnSave       : `1F2`0   Save any changes made to the task file
FnExit       : `1F3`0   Exit the task scheduler
FnRun        : `1F4`0   Run the task highlighted in the Task List
FnList       : `1F5`0   Show only the list of tasks without any edit fields
FnEdit       : `1F6`0   Invoke the notepad or script editor
FnCut        : `1F7`0   Delete the current task and copy it to the clipboard
FnPaste      : `1F8`0   Paste the task in the clipboard into the current task's fields
FnUndo       : `1F9`0   Undo any changes made to the current task
@@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 and enter
as the first argument on the command line one of `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.

The `2Info`0 button, in the table of contents screen, will
display a list of additional topics that are more general in
nature. For instance, there's information on how to register
the shareware version of `1GoHome`0, micellaneous last minute
updates (if any), an overview of what this package contains, 
and more. 

■

[Overview] 
`1GoSched`0 is used to schedule and edit the tasks that
`1GoHome`0 can run. You can enter up to 99 tasks. You use
`1GoSched`0 to set the start and end times and to specify the
days on which a task is to run. `1GoSched`0 also allows you to
"fine-tune" the task by specifying the tasks memory
requirements, video requirements, whether or not to log the
task, whether to start a script task at the DOS prompt, and
whether to display the countdown window before the task is
started.

The fastest way to start `1GoSched`0 is to bring up
`1GoHome`0's main menu and select `2GoSchedule`0. This method
can be used when your in the middle of a program or at the DOS
prompt. Of course, `1GoSched`0 can also be started by typing
`1GOSCHED`0 at the DOS prompt.  

Once a task is scheduled, `1GoSched`0 makes it easy to edit
both batch file and script tasks. To do so, use the up/down
arrow keys to highlight the task in the `2Task List`0, then
press the `4F6`0 key. If the task is a batch file, `1GoEd`0
will be started and the batch file will be be opened for
editing. Similarly, if the task is a script file, `1GoScript`0
will be started with the script file opened for editing.

■

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

  GOSCHED [`1parameters`0] [`1 @configFile`0] 

where

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

  /LIST=[`1Y`0|N]         Show just the task list without any 
                      edit fields
  /SHUSH=[`1Y`0|N]        Run silently (no bells or whistles)
  /CSET=[m|b|`11`0,2,3,4] Select color set
                      (m->mono,b->B&W,other color)
  /PAL=[`10`0|1|2]        Change color palette 
                      (VGA only; 0->no change)

For information on `3config files`0 see `2Using a config file`0 in
`1GoHome`0's help (ie. run 'GOHELP GOHOME').

■


[TDescrip]
The `2Description`0 field is used to describe what a particular
task does. The text entered in this field is displayed in the 
countdown window whenever a task is ready to run. It is also
written out to the `2Log`0 file to describe the task that ran.
You can enter anything in this field to help describe the task.

■

[TType]
`1GoHome`0 has four types of events:
   Batch File    -  any DOS batch file. If you are not familiar
                    with batch files, refer to the DOS manual
                    or one of the many books on using DOS.

   Script File   -  a script file recorded using `1GoHome`0 
                    and/or edited using `1GoScript`0. For
                    information on script files, please see
                    both `2Record Script`0 in `1GoHome`0's
                    help and the help for `1GoScript`0 (run
                    'GOHELP GOSCRIPT').

   Reminder      -  displays a window with the supplied
                    text to alert you of events (ie. birthdays,
                    meetings, appointments, etc.)

   Command Line  -  commands that can be typed in at the DOS
                    prompt. If more than one command is used,
                    they must be seperated by semi-colons (';').
                    For example:
                     `2dir *.exe; mem; type c:\autoexec.bat`0

It is very important that the right task type be selected for
each task.

■

[TFilename]
Depending on the task type selected, this field name will 
change to either `2File name`0, `2Note`0, or `2Command`0.

If the task type is `2Batch File`0, then the field name will be
`2File name`0 and you will be expected to enter the name and
path of a valid batch file.

If the task type is `2Script File`0, then the field name will be
`2File name`0 and you will be expected to enter the name and
path of a valid script file.

If the task type is `2Reminder`0, then the field name will be
`2Note`0 and you will be expected to enter the text that you
want to appear in the Reminder window .


If the task type is `2Command`0, then the field name will be
`2Command`0 and you will be expected to enter one or more
valid DOS prompt commands, seperated by semi-colons (';').

■

[TStartTime]
The `2Start Time`0 field is used to specify when GoHome should
start the task. The time should be entered using the following 
12 hour format:

             HH:MM ?m
 
        where HH represent the number of hours (1 to 12)
              MM represent the number of minutes (0 to 59)
               ? is either 'a' for am or 'p' for pm.

If the `2Start Time`0 field is left blank, the task will not be 
scheduled.

Example:
    The following are some examples of valid start times:

          1:00 am
         12:30p
          5:22 pm
         <blank> field implies that the task should not be 
                 scheduled

■

[TEndTime]
You need to specify an `2End Time`0 only if the task is to be
repeated throughout the day. The format for entering the time
is the same as that used in  `2Start Time`0. Leaving the field
blank implies that the task is not a repeating event.

NOTE: The `2Mins Repeat`0 field MUST be set to a non-zero 
      value inorder for this field to be saved.

see also `4Start Time`0 and  `4Mins Repeat`0


■

[TRepeat]
The `2Mins Repeat`0 field is used to specify the number of
minutes that the task should be executed between the specified
start and end times.

If an `2End Time`0 is not specified, the task will not be 
reapeated.

Example:
   Assume that you need to monitor the network load between
   the hours of 10:00 am and 3:00 pm. Let's say that you'll
   only interested in monitoring the load every ten minutes.
   To schedule this task, you would fill out the 
   `2Description`0, `2Task Type`0, `2Command`0, fields 
   appropriately. For the `2Start Time`0 you'd enter "10:00 am",
   for the `2End Time`0 enter "3:00 pm", and for the 
   `2Mins Repeat`0 field enter "10". Your monitor program will
   now run every 10 minutes between the hours of 10:00 am and
   3:00 pm.


see also `4Start Time`0 and  `4End Time`0

■


[TWhen] 
The `2When`0 field is used to specify on what day(s) the task
should run. `1GoHome`0 allows the days to be specified in one
of three formats: specific date, days of the week, days in a
month.

To change the `2When`0 field, either tab to the `2When`0 field
or press <Alt>W. The `2When`0 field contains a drop-down list.
To view the items in a drop-down list, hit the down arrow
key. This will display a menu containing the three ways of
specifying when the task should run. The following table
describes the three items available in the menu.



     When        Exmaple    Meaning
---------------------------------------------------
  `1Date`0         10/25/94   Used when a task is to be started
                          on a specific day of the year. 
                          For example, to remember meetings 
                            and birthdays.
  `1Week Days`0     M W F     Used to specify the day(s) of the
                          week that a task should run.
                          For example, you may want to do
                          a FULL tape backup every Friday,
                          and an incremental backup every
                          Monday, Tuesday, Wednesday, and
                          Thursday.
  `1Days of Month`0  1 15     Used to specify the day(s) of the
                          month that a task should run.
                          For example, you may need to print
                          you employees checks on the first
                          and fifteen-th day of every month.
        

When `2Date`0 is selected from the drop-down list, the `2When`0
field will allow you to type in a valid date in the form of

             MM/DD/YY

        where MM  is the number of the month (ie 1=January,
                  2=February, ..., 12=December.
              DD  is the day of the month (1 to 31). 
              YY  is the year        


Selecting `2Week Days`0 from the drop-down list will cause a 
window that displays the days of the week to appear. Use the
<TAB> or arrow keys to move through the days. To select a 
particular day, hit the space bar to place (or remove) a 
checkmark. When you've finished selecting the days, hit 
<ENTER>. The `2When`0 field will now show the days you
selected.

Selecting `2Days of Month`0 from the drop-down list will allow
you to type in the days of the month on which to run the task.
Specifying a day as `232`0 will schedule the task to run on the
last day of each month.


■


[TOptions]
The `2Options...`0 button will pop-up up a dialog box so that you
can "tune" the way GoHome will run your task. See the section
titled `4Option Dialog`0 for details on the fields contained in
the dialog box.
■

[TTempDisable]
`2Temp Disable`0 is a check box that can be used to temperarily 
suspend scheduling the task. The `2Temp Disable`0 option 
is a better alternative than clearing the `2Start Time`0 field
for those tasks that you want to schedule at a later time.
■

[TaskList]
`1GoSched`0 displays all the tasks in the `2Task List`0 list
box. The `2Task List`0 shows the task description, task type,
start and end times, number of minutes to repeat, and the
day(s) to run it on. It will also place an asterisk ('*')
next to the task number, for those tasks that are scheduled
to run before midnight.

The following table shows the key assignments for 
moving around in the task list.

        Key(s)        Meaning
 -------------------------------------------------------
  <Shift><up Arrow>   move to the previous task
  <Shift><dwn Arrow>  move to the next task
  <PageUp>            scroll backwards one page
  <PageDown>          scroll forwards one page
  <Ctrl><PageUp>      go to the top of the task list
  <Ctrl><PageDown>    go to the bottom of the task list

If the edit fields are not displayed, the <Shift> key is not
required to move to the previous or next task.

You can toggle between displaying the edit fields and
displaying just the `2Task List`0 by using the `2<F5>`0 
key. There is also a command line parameter (/LIST=[y|n])
that can be placed in the config file to have only the
`2Task List`0 display when `1GoSched`0 is started.

see also `4Command line parameters`0
■


[OptionsDlg]
The `2Options`0 dialog box is used to "fine" tune the way 
`1GoHome`0 runs a task. The `2Options`0 dialog box looks like
 
        ╔══════════════ Options ═════════════════╗
        ║                                        ║
        ║  Video Save :  ()  Auto Determine ▄   ║
        ║                ( )  None           █   ║
        ║                ( )  Min Graphics   █   ║
        ║                ( )  Max Graphics   █   ║
        ║                     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀   ║
        ║  Memory :   KB Required  256 ▄         ║
        ║             KB Desired   512 █         ║
        ║             ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀         ║
        ║    [ ]  Swap to File Only          ▄   ║
        ║    [√]  Start Script At Dos Prompt █   ║
        ║    [ ]  Pause when done            █   ║
        ║    [ ]  Don't log task             █   ║
        ║    [ ]  No countdown window        █   ║
        ║         ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀   ║
        ║                   OK   ▄             ║
        ║                 ▀▀▀▀▀▀▀▀▀▀             ║
        ╚════════════════════════════════════════╝

The following sections cover the details of the individual
items.
■

[OVidSave]
The `2Video Save`0 items are displayed in the `2Options`0
dialog box. The four video items 
        `1Auto Determine`0
        `1None`0
        `1Min Graphics`0
        `1Max Graphics`0

All four items are mutually exclusive (ie. only one can be
selected at a time).
            
The `2Video Save`0 radio buttons determine the amount of 
video display memory that needs to be saved before running the
task. This applies only to the situation where `1GoHome`0 must
swap out a program in order to run a scheduled task. If the
computer is at the DOS prompt, `1GoHome`0 will not save the
screen image.

Generally, you should select `2Auto Determine`0 and have
`1GoHome`0 determine what is necessary. 

If the screen is not restored properly after running a task,
try selecting `2Min Graphics`0 first. If the screen is still
not restored then use `2Max Graphics`0.

Some programs save an image of the screen when they start up
and then restore it when they leave. `1GoEd`0 and `1GoSched`0 are 
examples of these kind of programs. (To see for yourself, at 
the DOS prompt use "dir" to display some text on the screen.
Then start `1GoEd`0 by typing "GOED" at the DOS prompt. Once
`1GoEd`0 starts, hit <F3> to exit. When `1GoEd`0 returns, the
screen will be restored with the directory contents still 
listed). For programs that behave this way, you can save some
time by telling `1GoHome`0 to not save the screen image when
running the program. To have `1GoHome`0 not save the screen,
check the `2None`0 option in the `2Video Save`0 group.

■

[OMemory]
The `2Memory`0 requirement fields are displayed in the
`2Options`0 dialog box. These two fields are used to specify
the minium amount of memory required to run the task and
the amount of memory desired. All values should be entered
in kilobytes (1 kilobyte = 1024 bytes). These values are
only used when it is necessary to swap out the current program
to make more memory available for the task. `1GoHome`0 does
not use the memory requirements when at the DOS prompt.

When a task is about to be run, `1GoHome`0 will check to see
if the computer is at the DOS prompt. If it's not, `1GoHome`0
will try to allocate the `2Desired`0 amount by swapping out
the current program. If it cannot obtain the `2Desired`0 amount,
it will try to obtain at least the `2Requested`0 amount. 
If `1GoHome`0 cannot obtain at least the `2Requested`0 amount,
it will not run the task.

■

[OSwap]
The `2Swap to File Only`0 option in the `2Options`0 dialog box
is used to tell `1GoHome`0 that it should not use EMS or XMS
memory when it must swap out the current program. Typically,
`1GoHome`0 requires about 600K whenever it needs to swap a 
program out. If the task requires a large amount of either EMS
or XMS, then you might not what to have `1GoHome`0 use that
memory when swaping the program out.  Therefore, if the `2Swap
to File Only`0 check box is checked, `1GoHome`0 will not
attempt to swap the program to EMS and XMS, instead it will
swap it to the hard drive.

■

[OPrompt] 
The `2Start Script At Dos Prompt`0 check box is used only if
the task is a script file. If this check box is checked,
`1GoHome`0 will make sure that the script is started at the
DOS prompt. It will also wait for the script to finish and
return to the DOS prompt. Once it does, `1GoHome`0 will
continue with the next task provided that one has been
scheduled.

If necessary, `1GoHome`0 will swap out the current program and
start a copy of the DOS command processor (COMMAND.COM) to
make sure that the script starts at the DOS prompt.

You would want to make sure this option is checked when
scheduling a task for unattended operation. 

For general script use in your everyday activities, you will
probably want to un-check this option (if you don't, `1GoHome`0
will swap out the current program before running the script).

■

[OPause]
The `2Pause when done`0 option in the `2Options`0 dialog box
is used only when `2GoHome`0 must swap out a program so that 
it can run the scheduled program. This option will pause or 
wait upon completion of the task for either a keypress or 
until sixty seconds passes before restoring the swapped out
program.

You would use this option for those tasks that display data
on the screen and quickly exit without you getting the chance
to view the data. An example of this type of task would be
a task that displays a directory listing (ie. "dir").
■

[ONoLog]
`2GoHome`0 writes the start and end times of all tasks, with
the exception of `2Reminder`0 tasks, to a log file (see
`1Gohome's`0 help section titled `1Log file`0). If you run a
task a number of times each day, you may not want to have
`1GoHome`0 log it every time it runs. 

If the `1Don't log task`0 option in the `2Options`0 dialog box
is checked, the task will not be written to the log file.  

■

[ONoCount]
Each time a task in `1GoSched`0's task list is run, `1GoHome`0
displays a countdown dialog box that displays the description
of the task. To run the task, you can either hit <ENTER> or
wait until the countdown reaches zero (fifteen secounds).

For tasks that are run "interactively", you may not want to
have this countdown box come up everytime. The `2No countdown`0
`2window`0 in the `2Options`0 dialog box gives you the ablilty
to turn the countdown window off when a task is run.  
■


 **************** Functon Keys *******************

[FnHelp]
You can get help for the current edit field by pressing the
<F1> key. This will bring up the help system so you can
also browse other topics of interest.
■


[FnSave]
The <F2> key will save any changes to the task data file. When
`1GoSched`0 saves the tasks, it will also schedule any tasks
whose times or dates have changed. If a task is scheduled to
run before midnight, an asterisk ('*') will be placed next to
the task number in the `2Task List`0.  ■

[FnExit]
Use <F3> to exit `1GoSched`0. If any task was modified
and the changes weren't saved, `1GoSched`0 will ask if
you want to save the changes before terminating.
■

[FnRun] 
`1GoSched`0 can be used as a sort of super "Task Menu".
A task can be started from `1GoSched`0 by first higlighting
the task in the `2Task List`0 and then hitting the <F4> key.
`1GoSched`0 will terminate and the task will be executed.  

■

[FnList]
The <F5> key is used to toggle between displaying the edit
fields and a few tasks in the `2Task List`0, and displaying
just the `2Task List`0.

■

[FnEditor]
The <F6> key is used to start up either the file editor
(`1GoEd`0) or the script editor (`1GoScript`0). 

If the highlighted task is a `2Script File`0, `1GoScript`0
will be started with the specified script file already
loaded.

If the highlighted task is not a `2Script File`0, then `1GoEd`0
will be started. If the task is a `2Batch File`0 then the specified
batch file will be loaded; otherwise, you'll be prompted to 
enter the name of the file to edit.

Use the <Ctrl><F6> key to startup the script editor regardless
of the task type of the higlighted task.

Use the <Shift><F6> key to startup the file editor regardless
of the task type of the higlighted task.

■

[FnCut]
The <F7> key will copy the hightlighted task to the `2clipboard`0
and then delete it from the task list. 

The `2clipboard`0 is a temporary "holding" place that contains
the last task that was `2Cut`0.

To copy the task in the `2clipboard`0 to the highlighted task,
use <F8> to `2Paste`0 the task.
■
 
[FnPaste]
The <F8> key will copy the contents of the `2clipboard`0 into
the task fields of the highlighted task. This will replace any
data that may be in the highlighted task.

The `2clipboard`0 is a temporary "holding" place that contains
the last task `2Cut`0.

■

[FnUndo] 
Use the <F9> key to undo ALL the changes made to the
highlighted task. Note that this will undo all changes made
including any changes in the current field and ALL other
fields for that task. Once you move off of a task, you will
not be able to undo any changes that were made.  Of course, no
changes are written out to disk until you save them. So, if
you make some changes that you later decide you don't want to
make, as long as you haven't saved the changes, you can exit
`1GoSched`0 and select NO when asked to save it.

■

@@EndHelp
