home *** CD-ROM | disk | FTP | other *** search
/ Megahits 4 / MegaHits_Vol.4.iso / mui / util / misc / timeguardian_1.0.lha / TimeGuardian / doc / english / TimeGuardian.asc next >
Encoding:
Text File  |  1994-07-04  |  67.8 KB  |  1,745 lines

  1.  
  2.                     Documentation for TimeGuardian
  3.                           Version 1.0, 4.7.94
  4.                        written by Markus Matern
  5.  
  6.              translated by Markus Matern and Gerri Körner
  7.  
  8.                       Programpackage TimeGuardian
  9.                          (C)1994 Gerri Körner
  10.  
  11. This is the documentation for the package `TimeGuardian'
  12. Version 1.0, 4.7.94.
  13.  
  14.    The descriptions refers to the following programs:
  15.    * `TGCron' Version 1.42, 4.7.1994
  16.  
  17.    * `TimeGuardian' Version 1.40, 4.7.94.
  18.  
  19.  
  20. Introduction
  21. *************
  22.  
  23. Welcome to the documentation of the program package
  24. `TimeGuardian'.
  25.  
  26.    This package may be freely distributed, as long as no charges more
  27. than reasonable copying and handling fees are collected.  For any other
  28. type of distribution, you must have the written permission of the
  29. author.  This package is shareware, when you want to use the programs
  30. of this package permanently, you have to register, see How can I register 
  31. for `TimeGuardian'? for further information.
  32.  
  33.    This program may be included in software collections, providing that
  34. the previous conditions are respected.
  35.  
  36.    This program package is provided without warranty of any kind. In no
  37. event will the author be liable for direct, indirect, or incidental
  38. damages resulting from any defect of the program or in its
  39. documentation. The users are hereby warned of the possibility of such
  40. damage occurences.
  41.  
  42.  
  43. What is `TimeGuardian'?
  44. ========================
  45.  
  46.    `TimeGuardian' is a program package with which you can
  47. easily start events, that have to be done at certain times or dates on
  48. your computer. You also can write log files to disk, where you can see
  49. when your computer was switched on.
  50.  
  51.  
  52. The features of `TimeGuardian'
  53. ===============================
  54.  
  55.    * easy to configure
  56.  
  57.    * Alarm
  58.  
  59.    * daily actions
  60.  
  61.    * yearly actions
  62.  
  63.    * events in time intervals
  64.  
  65.    * localized gui
  66.  
  67.    * `Installer'
  68.  
  69.    * `MUI'-GUI
  70.  
  71.    * AREXX
  72.  
  73.    * online help
  74.  
  75.  
  76. What can I do with `TimeGuardian'?
  77. ===================================
  78.  
  79. The package has two main functions, you can use seperately from each
  80. other.
  81.  
  82.    The first function it provides, is a function to save on disk every
  83. time your computer was turned on and off. You get a complete log file
  84. when anyone turned on your computer. When you want, you are able to log
  85. different projects. That means, that you see in the log files, when you
  86. wirked on a certain project, e.g. private work and business work. You
  87. can analyse these log files easily with the graphical user interface,
  88. so you get a quick overview when you spend time at your computer or at
  89. certain projects.
  90.  
  91.    The second function, that is provided by this package is a function
  92. to start actions (commands or scripts) that you want to be executed
  93. regularly or at specified dates or hours. Moreover you can start
  94. programs or scripts once a day or once a year.
  95.  
  96.  
  97. What do I need, to be able to use `TimeGuardian'?
  98. ==================================================
  99.  
  100.    When you want to use all features of the package
  101. `TimeGuardian', you need some other public domain or shareware
  102. packages, which can't be included in this package, because of different
  103. reasons.
  104.  
  105.    * OS version >= 2.0
  106.      You need a Workbench or Kickstart version greater or equal to 2.0
  107.      *by all means*. When you have not installed this two versions you
  108.      can't install this package. When you want to know, which versions
  109.      you have installed, enter in a `Shell': `version'. The result
  110.      should be like follows:
  111.      `Kickstart version 37.175, Workbench version 37.XX' or greater
  112.      numbers! You need a Workbench versioon >= 2.1 when you want to use
  113.      the localized graphical user interface!
  114.  
  115.    * `MUI' >= 2.0
  116.      You need the program package `MUI' to be able to use the graphical
  117.      user interface of the program `TimeGuardian'. You can use an
  118.      unregistered version of `MUI' when you are testing the program
  119.      package. When you want to use `TimeGuardian' regularely,
  120.      then please register for both packages `MUI' and
  121.      `TimeGuardian'. For further information on how to do this, see How
  122.      can I rgister for `TimeGuardian'? and Where can I obtain MUI?.
  123.  
  124.    * `Installer'
  125.      You need this program to install the package easily.  Many other
  126.      program packages distribute this program.  Where you can obtain
  127.      the program `Installer', see Where can I obtain `Installer'?.
  128.  
  129.    * `Amiga-Guide'
  130.      You need this program, that you can use a feature of the graphical
  131.      user interface of `TimeGuardian', the online help. When you
  132.      want to get information, on how to obtain this package, see Where
  133.      can I obtain `AmigaGuide'?.
  134.  
  135.  
  136. How can I register for `TimeGuardian'?
  137. =======================================
  138.  
  139.    That you are able to use the background program `TGCron' as
  140. long as you want, on a certain day, you need a certain file, you only
  141. get, when you register. This file containd your name and is generated
  142. for you personally. When this file is missing, you can use the program
  143. only for about one and a half hour a day.
  144.  
  145.    To obtain your personal key file, please send 20.- DM or 15.- US-$
  146. in notes and the registration form to one of the below adresses (please
  147. note, that only assigments from german users to a german bank are
  148. accepted, because the fees for assignments from foreign banks are as
  149. high as the registration fee). When you send the money, be sure that
  150. you can't see the notes inside! Put the notes inside the registration
  151. form.
  152.                              Gerri Körner
  153.                              Kulturenweg 6
  154.                             D-87642 Buching
  155.  
  156.                              Markus Matern
  157.                          Max-Wieland-Straße 13
  158.                            D-89134 Blaustein
  159.  
  160. You get your personal key file and the newest version of the program
  161. package on disk.
  162.  
  163.    You pay for the actual version of the program package
  164. `TimeGuardian' and have neither the pretension to get newer, nor to get
  165. enhanced program versions. You *don't* have to register again for
  166. possible new versions of this package. The personal key files will stay
  167. valid with new versions. Possible enhancements of the package will
  168. depend on the number of registrations.
  169.  
  170.    We both can't be reached via telephone the next time, so when you
  171. have questions, please send an *international reply coupon* to one of
  172. the above adresses.  The better way is to send an E-Mail to (other
  173. forms of questions unfortunately can't be answered.):
  174.  
  175.                  `Gerri.Koerner@student.uni-ulm.de' or
  176.                   `Markus.Matern@student.uni-ulm.de'.
  177.  
  178. The programs of the package `TimeGuardian'
  179. ******************************************
  180.  
  181.    The package `TimeGuardian' consists in general of two
  182. programs, you need both to run properly. They will be described later
  183. on. You need the preferences program `TimeGuardian' only, when you
  184. want to change the configuration of the "cron" (1), which is running in
  185. the background. Or you have to start the first program, when you want
  186. to analyze the files, the package writes on your disk. The second
  187. program is the cron `TGCron'. You should start it every time your
  188. computer is booting, when you want to use the package in a sensible
  189. way. See How can I install `timeGuardian'?, for further information.
  190.  
  191.    ---------- Footnotes ----------
  192.  
  193.    (1)  A cron is a programm, that starts user-specified programs or
  194. scripts at certain user-specified moments.
  195.  
  196.  
  197. The program `TimeGuardian'
  198. ===========================
  199.  
  200.    The preferences program `TimeGuardian' is designed, to help the
  201. user to modify the configuration of the background program easily. You
  202. have a graphical user interface to do this. When you want to change the
  203. configuration, just start `TimeGuardian'.
  204.  
  205.    * From Workbench: Doubleclick on the corresponding icon. When you
  206.      followed the proposals of the installation, you find the icon in
  207.      your drawer `Prefs' of your bootpartition.
  208.  
  209.    * From CLI: Just enter `<path>/TimeGuardian'. Instead of
  210.      `<path>' you have to enter the name of the drawer in which you
  211.      have installed the package `TimeGuardian'. When you
  212.      followed the proposals of the installation this is `Sys:Tools'.
  213.  
  214.    Now follows a description of the different elements of the graphical
  215. user interface and their functions. "Gadgets" are elements, that start
  216. an action immediately. They can be activated by clicking on them with
  217. the mouse or by pressing the underlined character of their name. You
  218. always have to press a single key, even when a capital letter is
  219. underlined. "Pages" are gadgets that activate more and other gadgets.
  220. Depending on the preferences of `MUI' you can see all the page-gadgets
  221. together or one after the other by activating the visible page-gadget.
  222.  
  223.  
  224. The menus of the program `TimeGuardian'
  225. ----------------------------------------
  226.  
  227.    Some program-functions can be activated with gadgets and menus. The
  228. menus are shown further on in this documentation. The functions, that
  229. are available via gadget and menu will be described at the corresponding
  230. gadgets. The menu structure of the preferences program looks like
  231. follows:
  232.  
  233.    * Project     
  234.               
  235.  
  236.         - Open     
  237.  
  238.         - Save as     
  239.  
  240.         - --------------     
  241.  
  242.         - User
  243.  
  244.         - Remove Cron
  245.  
  246.         - Iconify
  247.  
  248.         - --------------
  249.  
  250.         - Quit     
  251.  
  252.    * Edit     
  253.         - Reset to Defaults     
  254.  
  255.         - Last Saved     
  256.  
  257.         - Restore     
  258.  
  259.    * Settings     
  260.               
  261.  
  262.         - Create Icons?     
  263.  
  264.    * Pages     
  265.         - About
  266.  
  267.         - Path Setup
  268.  
  269.         - Cron Setup
  270.  
  271.         - Global Statistics
  272.  
  273.         - Daily Statistics     
  274.  
  275.  
  276. The menu `Project=>Open'
  277. .........................
  278.  
  279.    This menu opens a file-requester, with which you can select a
  280. configuration file for loading.  You can choose a file saved before,
  281. with any name.  If you don't select a `TimeGuardian'-
  282. config-file an errormessage will appear. Is the file loaded
  283. succesfully, the gadgets and string gadgets will show the new
  284. configuration. Now you are able to modify, save, use, these new
  285. settings in the custom manner.
  286.  
  287.  
  288. The menu `Project=>Save as'
  289. ............................
  290.  
  291.    When you activate this menu you have the possibility to save your
  292. current settings under any name you choose. The configuration will not
  293. be saved in a way, that it is used immediataly. You have to select the
  294. gadget `Save' or `Use' when you want to do this. This menu is provided 
  295. to be able to change quickly between often used configuratons (e.g. one
  296. configuration for private work and one for business work). Each
  297. configuration has its own name, which easily can be associated with the
  298. corresponding project it is desired for. When you have activated the
  299. menu `Settings=>Create Icons?' there will be generated an icon for
  300. every configuration you save. When you want to use one of your saved
  301. configurations you have to doubleclick on the corresponding icon. This
  302. configuration is only used as long as you don't boot. When you want to
  303. use this configuration permanently, when you doubleclick the icon, then
  304. you have to change the `Tool Types:' of the icon to `ACTION=SAVE'. To
  305. do this, activate the icon (don't doubleclick it!) and select the menu
  306. `Icons=>Information..' on the Workbench. Then change the line
  307. `ACTION=USE' to `ACTION=SAVE' and press `Save'.
  308.  
  309.  
  310. The menu `Project=>User'
  311. .........................
  312.  
  313. When you activate this menu you are shown an information window, in
  314. which you can read the message
  315.  
  316.                   This TimeGuardian is registered to:
  317.  
  318.                          *Firstname Lastname*
  319.                                 Street
  320.                            Postcode Location
  321.                                 Country
  322.  
  323. when you are a registered user, or the message
  324.  
  325.                   This is a *unregistered* version of
  326.  
  327.                              TimeGuardian
  328.  
  329.                       you have to register after
  330.                     an evaluation time of 14 days!!
  331.  
  332. when you haven't registered yet. When you want to know how to register
  333. for `TimeGuardian', see How can I register for `TimeGuardian'?.
  334.  
  335.  
  336. The menu `Project=>Iconify'
  337. ............................
  338.  
  339.    When you activate this menu, the program closes the window of the
  340. graphical user interface and appears as an icon on the Workbench. When
  341. you want to reactivate the window, you have to doubleclick the icon.
  342. This menu has the similar effect like the third gadget from the right,
  343. on the top window border.
  344.  
  345.  
  346. The menu `Edit=>Last Saved'
  347. ............................
  348.  
  349.    When you activate this menu, the configuration file that you saved
  350. with the gadget `Save' will be loaded. When the file is loaded
  351. succesfully you can edit, use, save it in the common manner.
  352.  
  353.  
  354. The menu `Settings=>Create Icons?'
  355. ...................................
  356.  
  357.    When this menu has a checkmark, each time you save a configuration
  358. with the menu
  359. `Project=>Save As', an icon for the configuration will be created.
  360.  
  361.  
  362. The page `About'
  363. -----------------
  364.  
  365.    This page shows the copyrights, the shareware reference and the
  366. reference to `MUI'. It is shown when you start `TimeGuardian' and
  367. when you make one of the folowing actions on the graphical user
  368. interface:
  369.    * Activate the gadget `About'
  370.  
  371.    * Select the menu `Pages=>About'
  372.  
  373.    * Press the keys `Amiga 1'
  374.  
  375.    * Press the keys `rAlt Space', when you are on the page `Daily
  376.      Statistics'
  377.  
  378.    * Press the keys `lAlt Space', when you are on the page `Path Setup'
  379.  
  380.  
  381. The page `Path Setup'
  382. ----------------------
  383.  
  384. This page is shown, when you make one of the folowing actions on the
  385. graphical user interface:
  386.    * Activate the gadget `Path Setup'
  387.  
  388.    * Select the menu `Pages=>Path Setup'
  389.  
  390.    * Press the keys `Amiga 2'
  391.  
  392.    * Press the keys `rAlt Space', when you are on the page `About'
  393.  
  394.    * Press the keys `lAlt Space', when you are on the page `Cron Setup'
  395.  
  396.    On this page you can select all the files and paths `TGCron'
  397. accesses. You see eight different string gadgets, in which you can
  398. enter the values on different ways:
  399.    * Click with the mouse inside the frame of the desired string gadget.
  400.  
  401.    * Press the underlined character of the desired string gadgt on the
  402.      keyboard.
  403.  
  404.    * The string gadgets are concated, press the key that you selected in
  405.      the `MUI' preferences program for concatenation (`TAB', when you
  406.      didn't change this option). Press this key so many times, that the
  407.      cursor appears in the desired string gadget. Enter the desired
  408. Command or Path on your keyboard now. In the first and the last four
  409. string gadgets the entered values will be checked. When they don't
  410. exist they will be rejected.
  411.  
  412.    * Press the gadget in the right of the string gadget. You then will
  413.      be able to select the path or command/ script with a file
  414.      requester.
  415.  
  416.    When you start `TimeGuardian' the first time, you will find some
  417. values filled in, in some string gadgets. Otherwise you will see the
  418. last saved configuration.
  419.  
  420.    Besides you see four gadgets, with which you can make different
  421. changes to the configuration.  For further information see The Gadgets
  422. Save- Use and The gadgets Default- Restore.
  423.  
  424.  
  425. The string gadget `Log Path'
  426. .............................
  427.  
  428.    In this string gadget you have to enter the drawer or partition,
  429. where the cron program shall save, when the computer has booted and how
  430. long and when it was switched on. The names of these three files you
  431. can enter in the following string gadgets.
  432.  
  433.    When you want to change the path, activate the string gadget, like
  434. described above, and enter the desired path. The path must already
  435. exist, otherwise it is rejected. When you activate the string gadget
  436. with the gadget in the right of it, a file requester pops up, where you
  437. easily can select the path.
  438.  
  439. When you press the gadget `Default' the path `Sys:Tools/' appears.
  440.  
  441.  
  442. The string gadget `Starts'
  443. ...........................
  444.  
  445.    Here you have to enter the name of the file, in which `TGCron'
  446. shall save the time, when the computer has had a reset. The file will be
  447. created in the drawer described above, when it doesn't exists. The
  448. suffix is automatically created by the program and is a period,
  449. followed by the year (in the year 1994: `.94').
  450.  
  451. When you select the gadget `Default' the file name `Logfile' appears.
  452.  
  453.    The values in the file will only show your real boot times, when you
  454. start the program `TGCron' every time your computer is booting. How
  455. you can reach this, see How can I install `TimeGuardian'?.
  456.  
  457.    When you start `TGCron' manually, you can each time you work on
  458. a certain project, start the program. You then have a protocol for this
  459. specific project. You can reach this in a second way. You start the
  460. program `TGCron' always and change the configuration for different
  461. projects. You define a configuration for a certain project and save it
  462. with the menu `Project=>Save As'. When you start working on the project
  463. you use the menu `Project=>Open' to load it. For further information,
  464. see The menu Project=>Open and The menu
  465. Project=>Save as.
  466.  
  467.    The file is saved in ASCII format and can be loaded with any editor
  468. or text viewer. A sample file named `Logfile.94', could look like this:
  469.      Wed   04-May-94 15:26
  470.      Thu   05-May-94  8:24
  471.      Thu   05-May-94 14:26
  472.      Thu   05-May-94 15:22
  473.      Thu   05-May-94 16:01
  474.  
  475. The date format can be changed, see The gadget Date format for furher
  476. information.
  477.  
  478.  
  479. The string gadget `Runtime'
  480. ............................
  481.  
  482.    Here you have to enter the file, in which `TGCron' shall save
  483. how long the computer was switched on at which dates. When the file
  484. doesn't exist, it will be created in the drawer or partition, you
  485. selected in the first string gadget on this page. The suffix is
  486. automatically created by the program and is a period, followed by the
  487. year (in the year 1994: `.94').
  488.  
  489. When you select the gadget `Default' the file name `Uptime' appears.
  490.  
  491.    The entry for a day will be written the following day, you switch
  492. your computer on. That means, when you look at this file the actual day
  493. isn't shown.
  494.  
  495.    The file is saved in ASCII format and can be loaded with every
  496. editor or text viewer. A sample file named `UpTime.94', could look like
  497. this:
  498.      Wed   04-May-94 Runtime:  2 h  47 min.
  499.      Thu   05-May-94 Runtime:  2 h  43 min.
  500.      Mon   09-May-94 Runtime:  3 h  11 min.
  501.  
  502. The date format can be changed, see The gadget Date format for furher
  503. information.
  504.  
  505.  
  506. The string gadget `OnOff'
  507. ..........................
  508.  
  509.    Here you have to enter the file, in which `TGCron' shall save
  510. the times when the computer was switched on and off. When the file
  511. doesn't exist, it will be created in the drawer or partition, you
  512. selected in the first string gadget on this page. The suffix is
  513. automatically created by the program and is a period, followed by the
  514. year (in the year 1994: `.94').
  515.  
  516. When you select the gadget `Default' the file name `OnOff' appears.
  517.  
  518.    The entry for the current "switch on" will be written to the file,
  519. the next time, the computer is switched on.  When you look at the file,
  520. the last time you switched the computer on, may be saved like follows:
  521. `System switched on:  Th 05-May-94 14:26'.
  522.  
  523.    The file is saved in ASCII format and can be loaded with any editor
  524. or text viewer. A sample file named `UpTime.94', could look like this:
  525.      System switched on:   Wed   04-May-94 17:38
  526.      Resets:  0
  527.      System switched off:  Wed   04-May-94 19:26
  528.      
  529.      System switched on:   Thu   05-May-94  8:24
  530.      Resets:  0
  531.      System switched off:  Thu   05-May-94  9:25
  532.      
  533.      System switched on:   Thu   05-May-94 14:26
  534.      Resets:  2
  535.      System switched off:  Thu   05-May-94 16:11
  536.  
  537. The date format can be changed, see The gadget Date format for furher
  538. information.
  539.  
  540.    The decision, whether the computer is switched on or had a reset, is
  541. made depending on the settings of the slider `Startuptime', see The
  542. slider Startup time, for further information.
  543.  
  544.  
  545. The string gadget `Once a day'
  546. ...............................
  547.  
  548.    Here you can select a file that is executed once a day. The file is
  549. executed only once a day independent of the time, the computer is
  550. switched on. When the computer works at midnight, it will be executed
  551. short after midnight. This entry is not fit for polling at your mailbox
  552. once a day, because the time when this happens is not determined. It is
  553. intended for commands which you don't want to execute from your
  554. `Startup-Sequence' every time your computer is booting. You can make a
  555. backup once a day of important files or update your database for a fast
  556. file search.
  557.  
  558.    When you press the gadget in the right of the string gadget, a file
  559. requester pops up, where you easily can select the desired file. You
  560. can choose an executable or a script in ASCII format. When you want a
  561. script to be executed, the `S-flag' has to be set. For example the
  562. script `Once_a_day' in the drawer `S:'. Enter `protect S:Once_a_day s
  563. add' in a CLI to set this flag. You have to start commands inside
  564. scripts with their full path! You don't need the path, when you use
  565. intern commands or commands in the `C:'-directory.
  566.  
  567. A sample script may look like this:
  568.      ;Skript once a day
  569.      dir all sys: > T:.directorytree ;for fast file search
  570.      copy T:.directorytree sys:
  571.      delete T:.directorytree
  572.  
  573. The comands will be automatically started in the background. You don't
  574. have to enter anything like `run < nil: > nil: Command'. Bevor adding a
  575. command line to a script, you want to execute, try the command in a
  576. `Shell' so that you can be sure it works the intended way. When this is
  577. not successfull you can start the command from the script and redirect
  578. the output to a file: `Command > Sys:.logfile'. You can read the file
  579. `Sys:.logfile' with a text viewer or an editor to look what went wrong
  580. (you can look at this file with `type Sys:.logfile' in a `Shell', too).
  581.  
  582.  
  583. The string gadget `Once a year'
  584. ................................
  585.  
  586.    Here you can select a file, that is executed once a year. The file is
  587. executed only once a year, independent of the time, when the computer is
  588. switched on the first time in a year. When the computer works at the
  589. turn of the year, it will be executed short after midnight. You could
  590. use this entry to copy the files, the cron program produced, to another
  591. directory. In the drawer, you selected in the string gadget `Log Path',
  592. you will only find the actual files.
  593.  
  594.    When you press the gadget in the right of the string gadget a file
  595. requester pops up, where you easily can select the desired file. You
  596. can choose an executable or a script in ASCII format. When you want a
  597. script to be executed, the `S-flag' has to be set. For example the
  598. script `Once_a_year' in the drawer `S:'. Enter `protect S:Once_a_year s
  599. add' in a CLI to set this flag. You have to start commands inside
  600. scripts with their full path! You don't need the path, when you use
  601. intern commands or commands in the `C:'-directory.
  602.  
  603. An example script, that copies the files from the drawer `Sys:Tools' to
  604. a new drawer
  605. `Sys:Tools/Store' could look like this (the drawer `Store' will be
  606. created, when the drawer `Sys:Tools' already exists):
  607.      ;Script once a year
  608.      copy Sys:Tools/LogFile.?? Sys:Tools/Store quiet
  609.      delete Sys:Tools/LogFile.?? quiet
  610.      copy Sys:Tools/UpTime.?? Sys:Tools/Store quiet
  611.      delete Sys:Tools/UpTime.?? quiet
  612.      copy Sys:Tools/OnOff.?? Sys:Tools/Store quiet
  613.      delete Sys:Tools/OnOff.?? quiet
  614.  
  615. The used names and paths, are the ones, that you get, when you press the
  616. gadget `Default'. When you have chosen other names and want to use this
  617. script, then you have to modifiy the script to suit your needs.
  618.  
  619.  
  620. The string gadget `Timer fixed'
  621. ................................
  622.  
  623.    Here you can select a "CronTab"(1) file in which is saved which
  624. programs have to be started at certain moments. This file has to be an
  625. ASCII file with a certain format, that will be described below. It is
  626. possible to use samples in this file or certain days, months, etc.
  627.  
  628.    When you press the gadget in the right of the string gadget, a file
  629. requester pops up, where you easily can select the desired file. You can
  630. only access this string gadget, when you have selected `fixed' or
  631. `fixed & interval' at the gadget `Type' on the page `Cron Setup'.
  632. Otherwise the string gadget is ghosted.
  633.  
  634. An example file could look like follows:
  635.      ; TimeGuardian CronTable
  636.      ;
  637.      ;55 23 * * * RequestChoice TimerRequest "It is  23:55 " "What else ?!"
  638.      ;
  639.      59 19 * * 1-5 s:News
  640.      ;
  641.      0,15,30,45 * * * * "newshell con:82/175/550/90/UpTime from batch:saytime"
  642.      ;
  643.  
  644. When the 1st character of a line is `;', the line will be ignored
  645. completely.  You can use this to add comments to the file or to stop
  646. executing a program for some time.  This was done in the third line. 
  647. The command `RequestChoice' won't be executed.
  648.  
  649.    Shall a file be executed at a certain moment, the line in the file
  650. must look like the folowing sample: `<Minute> <Hour> <Day> <Month>
  651. <Day_of_week> <Path/<Command|Script>>'.
  652.  
  653. The decision, whether a command is executed or not, is made by a *AND*-
  654. combination of the five time parameters. That means, that the command
  655. is only executed, when all five parameters are true.
  656.  
  657. Now follows an exact description for the different samples, set in acute
  658. parenthesis.  Some characters have a certain meaning:
  659.    - `<>':
  660.      The parameter in acute parenthesis has to  be specified.
  661.  
  662.    - `|':
  663.      The vertical bar seperates alternative parameters, which can be
  664.      used either or.
  665.  
  666.    - `[]':
  667.      The parameter in angular parenthesis can be used when you want.
  668.  
  669.    - `...':
  670.      Three periods mean, that the parameter before can be used multiple
  671.      times.
  672.    * `<Minute>'
  673.      The complete sample looks like this:
  674.      `<*|Min[[,Min]|[,Min-Min]...]|Min-Min[[,Min]|[,Min-Min]...]>'
  675.      The value for `Min' has to be choosen in the range from 0 to 59.
  676.      It follows a description of all possibilities:
  677.        1. `*':
  678.           When you use an asterisk for this parameter, th command is
  679.           executed every minute.
  680.  
  681.        2. `Min':
  682.           You can choose a moment, at which the command is executed.
  683.  
  684.        3. `Min-Min':
  685.           You can specify a range, whilst which the command is
  686.           executed. The first value for `Min' has to be smaller or
  687.           equal than the second value for `Min'.
  688.  
  689.        4. `<Min>,<Min-Min>,...,<Min>':
  690.           You can specify multiple moments and ranges seperated by
  691.           colons. The command is executed at every specified moment and
  692.           whilst the ranges.
  693.  
  694.      Example: `0,5,10,15-20,30,45-50 * * * * Command'
  695.      That would start the command every full hour, five, ten and 30
  696.      minutes after the full hour and in the range from 15 to 20 and
  697.      from 45 to 50 minutes every minute after the full hour. The
  698.      command is executed every day.
  699.  
  700.    * `<Hour>'
  701.      The complete sample looks like this:
  702.     
  703.     
  704.     
  705.      `<*|Hour[[,Hour]|[,Hour-Hour]...]|Hour-Hour[[,Hour]|[,Hour-Hour]...]>'
  706.      The value for `Hour' has to be choosen in the range from 0 to 23.
  707.      For a more precise description of the parameter `Hour' look at the
  708.      parameter `Minute' above. Both parameters have the same sample.
  709.      Example: `* 0,3,6,9,12,15,18,21 * * * Command'
  710.      That would execute the command every three hours. As an asterisk
  711.      is used for the minutes, the command is executed every minute of
  712.      these hours.
  713.  
  714.    * `<Day>'
  715.      The complete sample looks like this:
  716.      `<*|Day[[,Day]|[,Day-Day]...]|Day-Day[[,Day]|[,Day-Day]...]>'
  717.      The value for `Day' has to be choosen in the range from 1 to 31.
  718.      For a more precise description of the parameter `Day' look at the
  719.      parameter `Minute' above. Both parameters have the same sample.
  720.      Example: `* * 5-10,20-25 * * Command'
  721.      That would start the command at the fifth to 10. of a month and at
  722.      the 20. to 25. of a month. As asterisks are used for the other
  723.      parameters, the command will be executed every minute at these
  724.      days!
  725.  
  726.    * `<Month>'
  727.      The complete sample looks like this:
  728.      `<*|Mon[[,Mon]|[,Mon-Mon]...]|Mon-Mon[[,Mon]|[,Mon-Mon]...]>'
  729.      The value for `Mon' has to be choosen in the range from 1 to 12.
  730.      For a more precise description of the parameter `month' look at
  731.      the parameter `Minute' above. Both parameters have the same sample.
  732.      Example: `* * * 1,5-7 * Command'
  733.      This would start the command in the months from January to May and
  734.      in July. It will be executed every minute in these months!
  735.  
  736.    * `<Day_of_week>'
  737.      The complete sample looks like this:
  738.      `<*|DoW[[,DoW]|[,DoW-DoW]...]|DoW-DoW[[,DoW]|[,DoW-DoW]...]>'
  739.      The value for `DoW' has to be choosen in the range from 1 to 7.  1
  740.      corresponds to Monday, 7 corresponds to Sunday. For a more precise
  741.      description of the parameter `Day_of_Week' look at the parameter
  742.      `Minute' above. Both parameters have the same sample.
  743.      Example: `* * * * 1-5 Command'
  744.      This would start the command from Monday to Friday every minute,
  745.      your computer is turned on.
  746.  
  747.    * `<Path/<Command|Script>>'
  748.      Here you have to enter the command or script that shall be
  749.      executed. You always have to use the complete path. In the above
  750.      example in line seven the command `newshell' needs no path,
  751.      because this is an *internal* command, which is not loaded from a
  752.      data media. System commands, which are located in the `C:' drawer
  753.      likewise don't need a path. All other commands do.
  754.  
  755.    * examples:
  756.        1. `* * * * * "dir >> t:test sys:tools"'
  757.           This command is executed every minute.
  758.  
  759.        2. `0,30 8-16 * * 1-5 s:Gong'
  760.           This script is executed Mondays to Fridays from eight a.m. to
  761.           four o'clock p.m. every full hour and every half hour.
  762.  
  763.        3. `0 15 24 12 * execute "s:12. 24."'
  764.           This script is execute at three o'clock p.m. the 24.th of
  765.           December.
  766.  
  767.        4. `0 20 15,16 4 7 s:Example'
  768.           This script is executed the 15.th and 16.th of April at eight
  769.           o'clock p.m. (when this date is a Sunday). Of course two
  770.           successive days both can't be Sundays, but this example shall
  771.           illustrate the *AND*- combination.
  772.  
  773. When you want to start scripts, the `S- flag' of the files has to be
  774. set (to do this with the script `News', which is in the directory `S:',
  775. type the following in a `CLI': `protect s:News s add'). The second way
  776. to start a script is to use the command `execute' like in the third
  777. example (you don't have to set the `S- flag' here). You have to start
  778. commands inside scripts with their full path! You don't need the path,
  779. when you use intern commands or commands in the `C:'-directory. When
  780. you have problems with commands, not doing what you want them to do,
  781. check the commands for spaces. Try quoting the part of the command
  782. including spaces. Test the command you wish to use in a `Shell', before
  783. you use it in a script.
  784.  
  785.    ---------- Footnotes ----------
  786.  
  787.    (1)  The format is the Un*x format
  788.  
  789.  
  790. The string gadget `Timer interval'
  791. ...................................
  792.  
  793.    Here you can select a file that is executed in regular time
  794. intervals. This entry therefore can be used to save the project you are
  795. working on at the moment every ten minutes. The moments when this
  796. happens are always relative to the boot time, i.e. (boot time + n *
  797. interval). To change the interval see The sliders hours-
  798. minutes.
  799.  
  800.    When you press the gadget in the right of the string gadget, a file
  801. requester pops up, with which you can select the desired file. You only
  802. can change the entry in this string gadget, when you have selected
  803. `interval' or `fixed & interval' at the gadget `Type' on the page `Cron
  804. Setup'. Otherwise the gadget will be ghosted. You can select an
  805. executeable or a script in ASCII format. When you want to use a script
  806. the `S- flag' has to be set. To set this flag for the script `Example'
  807. in the directory `s:' type in a `CLI' window: `protect s:Example s add'.
  808. You have to start commands inside scripts with their full path! You
  809. don't need the path, when you use intern commands or commands in the
  810. `C:'-directory.
  811.  
  812.  
  813. The page `Cron Setup'
  814. ----------------------
  815.  
  816. This page is shown, when you make one of the following actions on the
  817. graphical user interface:
  818.    * Activate the gadget `Cron Setup'
  819.  
  820.    * Select the menu `Pages=>Cron Setup'
  821.  
  822.    * Press the keys `Amiga 3'
  823.  
  824.    * Press the keys `rAlt Space', when you are on the page `Path Setup'
  825.  
  826.    * Press the keys `lAlt Space', when you are on the page `Global
  827.      Statistics'
  828.  
  829.    On this page you can modify the time values, that `TGCron'
  830. accesses.  Furthermore you can select the date format, the language, and
  831. which type of alarm you want to use. You see three different gadgets
  832. and four sliders. You can change the shown values in different ways:
  833.    * Slider
  834.         - Click with the mouse on a slider and move the mouse, pressing
  835.           the mouse button, to the left or to the right, the knob
  836.           follows the mouse. When you reached the desired value,
  837.           release the mouse button.
  838.  
  839.         - Press the underlined character on your keyboard: The knob
  840.           moves to the right.
  841.  
  842.         - Press the underlined character on your keyboard together with
  843.           a Shift- key: The knob moves to the left.
  844.  
  845.    * Gadgets
  846.         - Activate the gadget with a mouseclick and hold the mouse
  847.           button pressed: Select the desired entry (activation in the
  848.           text field).
  849.  
  850.         - Activate the gadget with a mouseclick: the next entry is
  851.           selected (activation in the image field or in the text field)
  852.  
  853.         - Press the underlined character on your keyboard: The next
  854.           entry is selected.
  855.  
  856.         - Press the underlined character together with a Shift- key:
  857.           The previous entry is selected.
  858.  
  859. When you start `TimeGuardian' the first time, you see the default
  860. values. Otherwise you see the last saved configuration.
  861.  
  862.  
  863. The slider `Startuptime'
  864. .........................
  865.  
  866.    With this slider you have to enter the time in minutes, your
  867. computer needs to boot, rounded to the next full minute. When your
  868. system needs for example two minutes and 30 seconds to start, you would
  869. have to enter three here. This is necessary, so that the background
  870. program can decide whether the computer is switched on or had a reset.
  871. The program decides, that the computer was switched on, when the
  872. difference between the last saved value and the actual time is greater
  873. than the value that you entered with the slider. Otherwise a reset is
  874. supposed.
  875.  
  876.  
  877. The slider `Increment'
  878. .......................
  879.  
  880.    This value is the time in minutes, when the background program
  881. saves, that the computer was still working. The smaller you make this
  882. value, the more accurate are the values in the three saved files which
  883. you can select on the page `Path Setup'. When you enter two, for
  884. example, every two minutes is saved, that the computer still is
  885. working. The greatest error which may occur at this value is then two.
  886. The greater the entered value, the inaccurate is the supposed switch
  887. off moment, as the last saved value for a running system is taken.
  888.  
  889.  
  890. The gadget `Date Format'
  891. .........................
  892.  
  893.    With this gadget you can enter nine different formats for the date,
  894. that is used, when saving the time in the different files. The format,
  895. that is used is the one, that is shown. The following formats can be
  896. selected:
  897.      `tt-mm-jj', `tt.mm.jj', `tt/mm/jj',
  898.  
  899.      `mm-tt-jj', `mm.tt.jj', `mm/tt/jj',
  900.  
  901.      `jj-mm-tt', `jj-mm-tt', `jj-mm-tt'.
  902.    Here stands `tt' for the day of the month, `mm' for the short form of
  903. the month and `jj' stands for the last two digits of the year. The
  904. short form of the month is saved in the selected language.
  905.  
  906.  
  907. The gadet `Locale'
  908. ...................
  909.  
  910.    With this gadget you can select a language for the background program
  911. `TGCron'.  The config program is *always* localized in the
  912. language that you selected in the language preferences program
  913. (certainly you need an approriate file `TimeGuardian.catalog'
  914. installed in your drawer `Locale:Catalogs/language').  The program runs
  915. in the default language english, when this file is missing, or when you
  916. use a workbench version < 2.1.  In this distribution only the default
  917. language english and german are supported.
  918.  
  919.    You can select six different settings:
  920.    * localized:
  921.      Use this when you have a localized workench and you want the files
  922.      for the time functions to be written in this language. You need
  923.      the appropriate file for your language!
  924.  
  925.    * english:
  926.      With this and the following selections, the text that is written
  927.      in the files, appears in the selected language.
  928.  
  929.    * german, french, italian, spanish:
  930.      time functions: selected language
  931.  
  932. When you are intrested, in translating the text for the graphical user
  933. interface into one of the above languages or into another, please
  934. contact one of the adresses at which you can register for the package,
  935. see How can I register for `TimeGuardian'?. When you do this (you
  936. translate the complete graphical user interface, the error messages and
  937. the text for the time functions) you will get a registered version of
  938. the package `TimeGuardian'. Please contact one of us *under
  939. any circumstances*, befor you start to translate!
  940.  
  941.  
  942. The gadget `Type'
  943. ..................
  944.  
  945.    With this gadget you can select, which type of background actions
  946. shall be executed. The program `TGCron' executes the commands/
  947. scripts `Once a year' and `Once a day' and writes the protocol files
  948. always when its necessary. This happens not depending on the following
  949. selectons. You have several possibilitys to choose:
  950.    * none:
  951.      That means, that neither the script in the string gadget `Timer
  952.      fixed' nor the command/ script in the string gadget `Timer
  953.      interval' is executed.
  954.  
  955.    * fixed:
  956.      That means, that only the script in the string gadget `Timer
  957.      fixed' is executed. You can use as many moments and commands in
  958.      this script as you want. See The string gadget Timer fixed, for the
  959.      contents of such a script.
  960.  
  961.    * interval:
  962.      Only the command/ script in the string gadget `Timer interval'
  963.      will be executed in the selected interval as long as the computer
  964.      is working.
  965.  
  966.    * fixed & interrval:
  967.      The two above described commands/ scripts will be executed
  968.  
  969.  
  970. The sliders `Hours'/ `Minutes'
  971. ...............................
  972.  
  973.    Here you can set the interval, in which the command/ script `Timer
  974. interval' will be executed regularly.  You have to set the minutes and
  975. hours seperately.  When you set the slider `hours' to 0 and the slider
  976. `Minutes' to 15, the command/ script will be executed every quarter of
  977. an hour. You can change these two values only, when you selected `timer
  978. & interval' or `interval' at the gadget `Type', otherwise the two
  979. sliders will be ghosted (see The gadget Type).
  980.  
  981.  
  982. The gadgets `Save'/ `Use'
  983. --------------------------
  984.  
  985.    When you press the gadget `Save' or the corresponding key on the
  986. keyboard, the program saves the current preferences in a way so that
  987. they are used immediately and after booting (The preferences are saved
  988. in the directory `ENVARC:' and `ENV:' under the name
  989. `TimeGuardian.config').
  990.  
  991.    When you press the gadget `Use' or its corresponding key- shortcut,
  992. the preferences are saved in the drawer `ENV:' under the same name like
  993. above. The configuration will be used immediately, but is only active
  994. as long as the computer has no reset. When the computer boots, the
  995. configuration is used, that you saved with the gadget `Save'. In
  996. contrast to the standard preferences programs `TimeGuardian' is not
  997. quit, when you press one of these two gadgets. When you want to leave
  998. the program press the `Quit'- gadget.
  999.  
  1000.  
  1001. The gadgets `Default'/ `Restore'
  1002. ---------------------------------
  1003.  
  1004.    When you press the gadget `Default', some default values will appear.
  1005. This are the settings, you see when you start the program the first time
  1006. after the installation.
  1007.  
  1008.    With the gadget `Restore' you can cancel the changes, that you have
  1009. made before. This works as long as you did not use one of the two
  1010. gadgets `Save' or `Use'. You will get the settings back, that you have
  1011. activated with the gadget `Use' the last time.
  1012.  
  1013.  
  1014. The page `Global Statistics'
  1015. -----------------------------
  1016.  
  1017. This page is shown, when you make one of the folowing actions on the
  1018. graphical user interface:
  1019.    * Activate the gadget `Global Satistics'
  1020.  
  1021.    * Select the menu `Pages=>Global Statistics'
  1022.  
  1023.    * Press the keys `Amiga 4'
  1024.  
  1025.    * Press the keys `rAlt Space', when you are on the page `Cron Setup'
  1026.  
  1027.    * Press the keys `lAlt Space', when you are on the page `Daily
  1028.      Statistics'
  1029.  
  1030.    On this page you find a table on which you can see at which days of
  1031. the actual year the computer was working how long. When you control
  1032. different projects with different configurations the times and dates
  1033. shown correspond to the selected configuration. In the lower field you
  1034. see the total amout of hours and days for the year. In the upper field
  1035. you see single days with the times for this day. You can move around in
  1036. the upper field of the page like follows:
  1037.    * Press the Tab key and use the keys Cursor up or Cursor down: Each
  1038.      time you press one of the keys the bar moves up or down a day.
  1039.  
  1040.    * Click with the mouse on the desired day.
  1041.  
  1042.    * Move the proportional gadget on the right side of the field and
  1043.      then click with the mouse on the desired day.
  1044.  
  1045.    * Click with the mouse on the gadgets next to the proportional gadget
  1046.      and click with the mouse on the dsired day.
  1047.  
  1048.    When you have highlighted the day, about which you want more
  1049. information, with one of the above methods, you can activate the page
  1050. `Daily Statistics' in different ways:
  1051.  
  1052.    * Enter the key Return (the highlighted day is shown)
  1053.  
  1054.    * Doubleclick with the mouse on the desired day (this works with a
  1055.      day, that isn't selected yet, too)
  1056.  
  1057.  
  1058. The page `Daily Statistics'
  1059. ----------------------------
  1060.  
  1061. This page is shown, when you make one of the folowing actions on the
  1062. graphical user interface:
  1063.    * Activate the gadget `Daily Satistics'
  1064.  
  1065.    * Select the menu `Pages=>Daily Statistics'
  1066.  
  1067.    * Press the keys `Amiga 5'
  1068.  
  1069.    * Press the keys `rAlt Space', when you are on the page `Global
  1070.      Statistics'
  1071.  
  1072.    * Press the keys `lAlt Space', when you are on the page `About'
  1073.  
  1074.    This page is devided into three areas. In the uppermost you can
  1075. select with a gadget, what you want to see from the selcted day in the
  1076. middle of the page:
  1077.    - OnOff:
  1078.      This shows, when the computer was switched on, how many resets it
  1079.      had and when it was switched off.  The accuracy of the switch off
  1080.      time depends on the settings of the slider `Increment', see The
  1081.      slider Increment, for further information.
  1082.  
  1083.    - Starts:
  1084.      Here you can see the times, when your computer had a reset.
  1085.  
  1086.    In the lowest area you see a summary of the selected day.
  1087.  
  1088. When you cannot see all entrys together, you can move the proportional
  1089. gadget the same way like on the page `Global Statistics'. To change
  1090. between the two views `OnOff' an `Starts' you can press the Space key.
  1091.  
  1092.  
  1093. The gadget `Remove Cron'
  1094. -------------------------
  1095.  
  1096.    With this gadget you can stop the background program `TGCron'.
  1097. You have to answer a requester, whether you want the program to quit or
  1098. not. When you select `Yes' `TGCron' is stopped within the next
  1099. minute. When you select `No' nothing happens, the program continues.
  1100.  
  1101.  
  1102. The gadget `Quit'
  1103. ------------------
  1104.  
  1105.    You can leave the program with this gadget. When you have changed the
  1106. preferences, but didn't save them a requester pops up. When you select
  1107. `Yes' the program is left without saving. When you select `No' or press
  1108. the Return key you're back in the program. You can save the preferences
  1109. manually and leave the program afterwards.
  1110.  
  1111.  
  1112. The online help
  1113. ----------------
  1114.  
  1115.    The online help is a feature to get easily and fast help when you
  1116. use the graphical user interface. To use this feature the
  1117. `amigaguide.library' has to be installed correctly on your system
  1118. (located in the drawer `Libs:'). When this is not true you can't use
  1119. this feature. Where you can obtain the library, see Where can I obtain
  1120. Amiga-Guide.
  1121.  
  1122.    When the above described file is installed on your computer, you can
  1123. get help about an element of the graphical user interface by moving the
  1124. mouse pointer over the corresponding element (do not click it) and
  1125. pressing the Help key afterwards. The corresponding text for the
  1126. element from this documentation will appear.
  1127.  
  1128.  
  1129. The AREXX-Port
  1130. ---------------
  1131.  
  1132. At the present version the program only supports the standard `MUI'
  1133. commands:
  1134.    * QUIT
  1135.  
  1136.    * HIDE
  1137.  
  1138.    * SHOW
  1139.  
  1140.    * INFO
  1141.  
  1142.    * HELP
  1143.  
  1144. For more information see `MUI.guide' from the distribution of `MUI'.
  1145.  
  1146.  
  1147. What do the errormessages mean ?
  1148. ---------------------------------
  1149.  
  1150.    * `Cannot quit now, still
  1151.      some asl popups opened.'
  1152.      This message appears, when you have to close a file requester,
  1153.      which was opened before, before you can leave the program
  1154.  
  1155.    * `You changed the configuration without saving
  1156.      Do you really want to quit?'
  1157.      That remembers you, that you haven't pressed the gadget `Save'
  1158.      yet. Do this before you leave the program.
  1159.  
  1160.    * `TGCron is not running!'
  1161.      The background program `TGCron' is not running yet, therefore
  1162.      the change of the configuration will have no effect! When you want
  1163.      to use the new configuration, you have to start `TGCron'.
  1164.  
  1165.    * `File already exists!
  1166.      Do you want to replace it?'
  1167.      A file you want to save, is already saved with this name. When you
  1168.      select `Yes' the old file is overwritten. When you select `No' you
  1169.      can save the file again and change the name.
  1170.  
  1171.    * `Do you want to remove TimeGuardianCron?'
  1172.      When you want to stop the background program `TGCron' select
  1173.      `Yes', otherwise `No'.
  1174.  
  1175.    * `You have to define a Log File,
  1176.      an empty string is not allowed!'
  1177.      You have not entered anything in  a string gadget, this is not
  1178.      allowed her. You have to enter a name for the file.
  1179.  
  1180.    * `Invalid config-file: *'
  1181.      The file * is not a valid config file, please select an other file.
  1182.  
  1183.    * `Could not load config-file: *
  1184.      I will use defaults instead!'
  1185.      The file * could not be opened correctly, while starting
  1186.      `TimeGuardian'. The program will use the values, you get, when you
  1187.      press the gadget `Default'. Change the configuration to suit your
  1188.      needs and press `Save' to correct the error.
  1189.  
  1190.  
  1191. Das Programm `TGCron'
  1192. ======================
  1193.  
  1194.    After setting up your preferences with `TimeGuardian', you may
  1195. start `TGCron'. According to your setup the program executes the
  1196. appropriate programs and scripts and stores the runtime information of
  1197. your computer. Its CPU usage is very low. While waiting for the next
  1198. event it uses *no* CPU power, only when beeing started and each minute
  1199. during a short moment and when it looks for an event or writes some
  1200. information to disk.
  1201.  
  1202.  
  1203. What does `TGCron' do?
  1204. -----------------------
  1205.  
  1206.    `TGCron' is designed to stay in memory all the time and run as
  1207. a background task.  It executes user defined events at predefined
  1208. moments. This means on the one hand that script files are executed, on
  1209. the other it stores by predefined precission information about the
  1210. runtime and when your computer has been booted.  It is very important
  1211. to configure `TGCron' for your personal environment, therewith it
  1212. is able to accomplish your events.  How you can do that, see The
  1213. program TimeGuardian.
  1214.  
  1215. For further information on the files, refer to Die Seite Pfad
  1216. Einstellung and Die Seite Zeit Einstellung.
  1217.  
  1218. `TGCron' searches for the following files during startup:
  1219.    * These files at every boot:
  1220.         - `*ENV:TimeGuardian.config*'
  1221.           `TimeGuardian' saves the current preferences to this
  1222.           file, `TGCron' reads them from it.
  1223.  
  1224.         - `*s:TimeGuardian.key*'
  1225.           This is your personal keyfile. You will get it when you
  1226.           become a registered user. If this file does not exist or has
  1227.           been modified, you will only be able to use `TGCron'
  1228.           about 1½h a day. How to get your key, please refer to Wie
  1229.           kann ich mich registrieren lassen?.
  1230.  
  1231.         - `[Log path]*TG_private/LastBoot*'
  1232.           The time of your last boot is stored here. Don't change
  1233.           anything here, when you want, that the values are correct in
  1234.           `[OnOff]' and `[UpTime]'!
  1235.  
  1236.         - `[Log path]*TG_private/UpTime*'
  1237.           Here is stored the time in minutes, how long your computer
  1238.           has been running on the current day. Don't change anything
  1239.           here, when you want, that the values are correct in
  1240.           `[UpTime]'!
  1241.  
  1242.         - `[Log path]*TG_private/UpDate*'
  1243.           This file contains the point of time, when your computer was
  1244.           turned off for the last time. Don't change anything here,
  1245.           when you want, that the values are correct in `[UpTime]' and
  1246.           `[OnOff]'!
  1247.  
  1248.         - `[Log path]*TG_private/Resets*'
  1249.           Here is the number of resets stored since your last startup.
  1250.           Don't change anything here, when you want, that the values
  1251.           are correct in `[OnOff]'!
  1252.  
  1253.         - `[Log path][LogFile].<yy>'
  1254.           At every startup or reset the curent time is appended to this
  1255.           file.
  1256.  
  1257.    * These files only at the first boot of a day or at midnight:
  1258.         - `[Once a day]'
  1259.           This file will be executed.
  1260.  
  1261.         - `[Log path][UpTime].<yy>'
  1262.           Once a day the full runtime of the previous day is stored
  1263.           here.
  1264.  
  1265.    * This file at a cold boot (not at a reset):
  1266.      `[Log path][OnOff].<yy>'
  1267.      The information when the computer has been turned on and how long
  1268.      is stored here during startup.
  1269.  
  1270.    * This file only at the first boot of the year:
  1271.      `[Once a year]'
  1272.      This file will be executed.
  1273.  
  1274.    * These files only if selected:
  1275.         - `[Timer fixed]'
  1276.           If you selected this at the page `Cron Setup', this file will
  1277.           be read during startup and stored internally. Then it will be
  1278.           checked every minute for a user event.
  1279.  
  1280.         - `[Timer interval]'
  1281.           If you selected this at the page `Cron Setup', this file will
  1282.           be executed at fixed intervals relative to the boottime.
  1283.  
  1284. Neither change any files in the `.../TG_private' directory nor with a
  1285. `.key' or `.config' suffix.
  1286.  
  1287.    The marks have the following meaning:
  1288.    - If a filename is marked like *this*, the filename or parts of the
  1289.      filename cannot be influenced by the user.
  1290.  
  1291.    - A filename marked like `[this]', shows that the user is able to
  1292.      configure the path/filename or path and filename at the `Path
  1293.      Setup' page. The string gadget in the configuartion program has
  1294.      the same name.
  1295.  
  1296.    - A mark like this `<yy>' means, that a suffix is appended
  1297.      automatically by program, generated from the last two digits of
  1298.      the current year.
  1299.  
  1300.  
  1301. How can I get information about `TGCron'
  1302. -----------------------------------------
  1303.  
  1304.    If you want to get further information about `TGCron', please
  1305. enter the following from the CLI (replace `<path>' by the directory
  1306. where you have installed the package to): `<Pfad>/TGCron'
  1307. There are two different possible messages, according to the fact you
  1308. have `TGCron' already started or not.
  1309.   1. `TGCron' has already been started:
  1310.      `TGCron v1.42 (4.7.1994) by G.Körner/J.Matern
  1311.      use -r option to remove...'
  1312.  
  1313.   2. `TGCron' is not running:
  1314.      `TGCron v1.42 (4.7.1994) by G.Körner/J.Matern
  1315.      use -i option to install...'
  1316.  
  1317. You can also get information about the revision and the compilation
  1318. date by using the `version'-command. Enter the following commandline:
  1319. `version full <path>/TGCron'
  1320. You should get this result: `TGCron v1.42 (4.7.1994)'.
  1321. If you don't get that, you are definitely reading the wrong
  1322. documentation.
  1323.  
  1324.  
  1325. How can I start `TGCron'?
  1326. --------------------------
  1327.  
  1328. If you didn't choose the automtic startup option during installation,
  1329. you have two different options to start `TGCron' by hand:
  1330.   1. Start from CLI
  1331.      To start it from CLI please enter the following:
  1332.      `<path>/TGCron -i'
  1333.      As `TGCron' does not detach from your CLI, you have to use
  1334.      the `run' command to get your shell back after startup as follows:
  1335.      `run < nil: > nil: <path>/TGCron -i'.
  1336.      Replace <path> by the directory you have the
  1337.      `TimeGuardian' package installed to.
  1338.  
  1339.   2. Workbench startup
  1340.      If you want to start `TGCron' from your Workbench, just
  1341.      doubleclick its icon.
  1342.  
  1343. When you try to start the program, but it is already running, you will
  1344. get the following results:
  1345.    - At the CLI:
  1346.      You will get the message: `TGCron is already running'
  1347.      This shows that `TGCron' is already running and you cannot
  1348.      restart it again.
  1349.  
  1350.    - At the workbench
  1351.      You will get a requester asking you: `Do you want to remove
  1352.      TimeGuardianCron?'
  1353.      If you want to remove it, click on `*Yes*' or press Return.
  1354.      Choosing `No' or pressing Escape does not affect `TGCron' and
  1355.      it keeps on running. Regardless, what you choose, it won't be
  1356.      started again!
  1357.  
  1358.  
  1359. How can I stop `TGCron'?
  1360. -------------------------
  1361.  
  1362. If `TGCron' is already running, you have three options to remove
  1363. it:
  1364.   1. From CLI:
  1365.      Please enter the following command: `<path>/TGCron -r'
  1366.      Replace <path> by the directory you have the
  1367.      `TimeGuardian' package installed to. Then you will get the
  1368.      message: `TGCron will be removed after next time interval'.
  1369.      The end of the time interval is normally the next full minute.
  1370.  
  1371.   2. At the Workbench:
  1372.      Just doubleclick its icon. You will get a requester asking you:
  1373.      `Do you want to remove TimeGuardianCron?'
  1374.      If you want to remove it, click on `*Yes*' or press Return.
  1375.      Choosing `No' or pressing Escape does not affect `TGCron' and
  1376.      it keeps on running. You won't get any further messages, but as
  1377.      similar as removing it from CLI it will quit after the next full
  1378.      minute.
  1379.  
  1380.   3. Start `TimeGuardian' and press the `Remove Cron' button,
  1381.      refer to Der Knopf Cron entfernen for detailed information.
  1382.  
  1383.  
  1384. What do the error messages mean?
  1385. ---------------------------------
  1386.  
  1387. You can get the following error messages from `TGCron':
  1388.    * `Invalid .config file. Use TimeGuardian to create a new one!'
  1389.      `TGCron' reads data from the file `env:TimeGuardian.config',
  1390.      but it was changed or corrupted and is not valid any more. Start
  1391.      `TimeGuardian', enter a new configuration and store it with
  1392.      the `Save' button.
  1393.  
  1394.    * `Could not open env:TimeGuardian.config!
  1395.      Use TimeGuardian to create it'
  1396.      Start `TimeGuardian', enter your configuration and store it
  1397.      with the `Save' button.
  1398.  
  1399.    * `Could not open locale, please check configuration!
  1400.      Using english instead'
  1401.      You selected `localised' at the `localisation' switch, but the
  1402.      program is not able to find the corresponding files in
  1403.      `Locale:languages/your_country/TimeGuardian.catalog' (replace
  1404.      `your_country' by the name of the locale your computer is running
  1405.      with), therefore it will use english as a default. To get rid of
  1406.      this message, install the needed .catalog file or select one of
  1407.      the hard coded languages, `english' for example.
  1408.  
  1409.    * `Your evaluation time has expired for today,
  1410.      Please consider registering !!'
  1411.      You have reached the end of your evaluation time for `TGCron'
  1412.      as an unregistered user. You cannot restart it again on this day.
  1413.      If you want to use the package unlimited, please become a
  1414.      registered user, look at How can I register for `TimeGuardian'?
  1415.      for detailed information.
  1416.  
  1417.    * `CronParser ERROR:
  1418.      Wrong number of Arguments in CronTable line:
  1419.      CronTab_line
  1420.      Please correct it!'
  1421.      The displayed `CronTab_line' from the file that you have choosen
  1422.      at the string gadget `Timer fixed', contains too much or not
  1423.      enough entries. Correct the line to get rid of this requester,
  1424.      because it will be shown again and again. For detailed information
  1425.      on the CronTab, refer to Das Eingabefeld Zeituhr fest.
  1426.  
  1427.    * `CronParser ERROR:
  1428.      Bad entry '*' in CronTable line:
  1429.      CronTab_line
  1430.      Please correct it!'
  1431.      The entry '*' in the `CronTab_line' is not valid. Correct the line
  1432.      to get rid of this requester, because it will be shown again and
  1433.      again. For detailed information on the CronTab, refer to Das
  1434.      Eingabefeld Zeituhr fest.
  1435.  
  1436.    * `CronParser ERROR:
  1437.      Value * out of range (*...*)
  1438.      Please search for commandline and fix it !'
  1439.      The number after `Value' is not in the range, that is shown in
  1440.      paranthesis. For detailed information on the CronTab, refer to Das
  1441.      Eingabefeld Zeituhr fest.
  1442.  
  1443.    * `CronParser ERROR:
  1444.      Range *-* out of range (*...*)
  1445.      Please search for commandline and fix it !'
  1446.      The range after `Range' has to be in the range that is shown in
  1447.      parenthesis. For detailed information on the CronTab, refer to Das
  1448.      Eingabefeld Zeituhr fest.
  1449.  
  1450.  
  1451. Where do I get the support programs?
  1452. *************************************
  1453.  
  1454.  
  1455. Where can I obtain `MUI'?
  1456. ==========================
  1457.  
  1458.    You can get `MUI' directly from the author, where you get a
  1459. registered version, and can use all the features of the `MUI' graphical
  1460. user interface (see Where can I register for MUI?). Or you
  1461. obtain the `Fish-Disks 967/968' from your local public domain dealer or
  1462. the `Aminet'.
  1463.  
  1464.    When you think, it is not worth to install `MUI', because of one
  1465. single program, this may be correct. But the background program
  1466. `TGCron' doesn't use `MUI' at all. Only the preferences program uses it
  1467. for its graphical user interface. So `MUI' is not started all the time 
  1468. but only when you want to change the configuration. So you can install
  1469. this package even on computers with little menmory, because you don't
  1470. need `MUI' all the time.
  1471.  
  1472.    When you have not installed `MUI' yet, you have to do this before the
  1473. installation of `TimeGuardian' by all means, as the
  1474. installation will be aborted otherwise. See How can I 
  1475. install `TimeGuardian'?, for further information.
  1476.  
  1477.  
  1478. Where can I obtain `Installer'?
  1479. ================================
  1480.  
  1481.    For the easy installation of the program package, you need the
  1482. program Installer from C*mm*d*re. When you have this program not
  1483. installed on your computer, you can obtain it on different ways.
  1484.  
  1485.    * With the Workbench 2.0/2.1/3.0
  1486.  
  1487.    * On the `Fish-Disk 870'
  1488.  
  1489.    * On the distribution of `MUI'.
  1490.  
  1491.    * On most distributions of commercial software
  1492.  
  1493.  
  1494. Where can I obtain `Amiga-Guide'?
  1495. ==================================
  1496.  
  1497.    When you want to use the "online help", you need the
  1498. `amigaguide.library' in your `LIBS:'-drawer (see The online help). You
  1499. don't need it to run the package `TimeGuardian', but won't be
  1500. able to use the online help feature.
  1501.  
  1502. The `amigaguide.library' is on the `Fish-Disk 870' and is distributed
  1503. with Workbench version 3.0.
  1504.  
  1505.  
  1506. How can I install `TimeGuardian'?
  1507. **********************************
  1508.  
  1509.    This chapter describes the installation of the package
  1510. `TimeGuardian'. When you want to install other packages, not included
  1511. in this distribution, look in the corresponding distributions for 
  1512. installing them.
  1513.  
  1514. You have two possibilities to install the package
  1515. `TimeGuardian'. You should use the first one:
  1516.  
  1517.  
  1518. The installation with `Installer'
  1519. ==================================
  1520.  
  1521. You have two choices to start the installation script:
  1522.   1. Doubleclick with the mouse the icon `TG.install.deutsch':
  1523.      The installation starts. The text appears german. When you want to
  1524.      use the geramn text please read the german documentation.
  1525.  
  1526.   2. Doubleclick with the mouse the icon `TG.install.english':
  1527.      The installation starts. The text appears in english.
  1528.  
  1529. Now follows a step by step description of the installation:
  1530.    * At the beginning you have the possibility to choose the user level
  1531.      for the installation. When you select `Novice' you won't be able
  1532.      to select anything more. You cannot control, where the package is
  1533.      installed.  All files which are necessary to work corretly will be
  1534.      copied, and the preferences program will be started.  At the end
  1535.      you get a summary about what was saved to which location.  To quit
  1536.      the installation you have to leave the preferences program.
  1537.  
  1538.      When you want to install the package press `Proceed With Install'.
  1539.      With `Help...' you get some information.
  1540.  
  1541.    * When you select the user level `EXPERT' you can choose whether you
  1542.      want to install the package (`Install for Real') or whether you
  1543.      just want to test the installation script (`Pretend to Install').
  1544.  
  1545.      Furthermore you can choose, whether all actions are logged or not.
  1546.      You can write the file
  1547.      `Sys:TGInstall.e.log' to disk (`Log File'), you can print the
  1548.      results (`Printer') or you can suppress a log file (`None').
  1549.  
  1550.      The installation is continued with `Proceed'.
  1551.  
  1552.    * The installation checks, whether `MUI' is installed with the
  1553.      correct version. When this is not true it is aborted.
  1554.  
  1555.    * Now you can choose what you want to install.
  1556.      The first gadget means, that only the necessary programs and
  1557.      config files are copied.
  1558.      The second gadget means the documentation. Here are three files at
  1559.      the moment:
  1560.         - The file `TimeGuardian.dvi', that you can print or
  1561.           view, when you have installed TeX.
  1562.  
  1563.         - The file `TimeGuardian.guide', that you can read with
  1564.           `AmigaGuide'. This file contains the information for the
  1565.           online help. This file is always copied, when the file
  1566.           `Libs:amigaguide.library' is installed on your system.
  1567.  
  1568.         - The file `TimeGuardian.asc', you can read with any
  1569.           text viewer or editor, or that you can print.
  1570.  
  1571.    * When you have activated the first gadget:
  1572.         - You are asked, if the background program `TGCron' should
  1573.           be started every time the computer is booting.
  1574.  
  1575.         - When you answered the last question with `Yes', the program
  1576.           checks whether this is possible on your system.
  1577.  
  1578.         - When multiple possibilities exist, to start the background
  1579.           program, you can select which of them you prefer. When you
  1580.           select `From CLI (user-startup)' the file `S:user-startup'
  1581.           will be changed in an appropriate way. When you select `From
  1582.           WB (WBStartup)' the icon of the progam `TGCron' is
  1583.           copied to the drawer `Sys:WBStartup'. Users, that work mainly
  1584.           on the workbench should use the second possibility.
  1585.  
  1586.         - Now you can choose, where the programs shall be copied to. The
  1587.           installation makes a proposal. When you want a new drawer for
  1588.           the package created, select `Make New Drawer...', otherwise
  1589.           choose an existing one.
  1590.  
  1591.         - You can continue with the button `Proceed'.
  1592.  
  1593.         - Even if you did not select the documents to be installed the
  1594.           file
  1595.           `TimeGuardian.guide' will be copied, when the file
  1596.           `Libs:amigaguide.library' is installed. When this is not true
  1597.           a message appears, that you won't be able to use the online
  1598.           help.
  1599.  
  1600.    * When you have selected the second gadget:
  1601.         - You now have to choose a drawer where the documents shall be
  1602.           copied to. The program suggests a subdirectory, in the
  1603.           drawer, where you copied the programs to.
  1604.  
  1605.         - The file `TimeGuardian.guide' is only copied, when
  1606.           the file `Libs:amigaguide.library' is installed on your
  1607.           system. When this is not true a message appears, that you
  1608.           won't be able to use the online help.
  1609.  
  1610.    * When you have installed the programs you now can decide, whether
  1611.      you wish to start the preferences program `TimeGuardian'.
  1612.      Start the program with selecting `Yes'. Change the configuration
  1613.      to suit your needs and press the gadget `Save' before you leave
  1614.      the program with the gadget `Quit'. When you don't start the
  1615.      program, you have to answer a message, that you will have to start
  1616.      the preferences program later on. Select `Proceed' here to leave
  1617.      the installation correctly.
  1618.  
  1619.    * When you have left the preferences program or you answered the
  1620.      message, the installation is complete and the last message appears.
  1621.  
  1622.  
  1623. The installation without `Installer'
  1624. =====================================
  1625.  
  1626. To install the package without the `Installer' please follow these
  1627. steps:
  1628.   1. Open a `Shell' window (doubleclick the icon `Shell' in the drawer
  1629.      `System' of your boot partition).
  1630.  
  1631.   2. Please enter `version libs:muimaster.library'. You should get this
  1632.      result:
  1633.      `libs:muimaster.library 7.973'. When you get a smaller number or
  1634.      `object not found', you have to install `MUI' version 2.0 or
  1635.      greater before you can continue.
  1636.  
  1637.   3. When you want to install the package in a drawer, that already
  1638.      exists, please enter `cd drawer' (instead of drawer please use the
  1639.      name of the directory). When you want to copy the files to a new
  1640.      drawer, then you have to create it with the command `makedir
  1641.      drawer', then change to this drawer with `cd drawer' (please use
  1642.      the name of the new directory instead of drawer in the two command
  1643.      lines, e.g. TimeGuardian).
  1644.  
  1645.   4. Now put the disk with the package into any drive (when you have
  1646.      copied the files already to your hard disk then enter: `assign
  1647. {No Value For "     DISKNAME"}: sourcedrawer', where
  1648.      sourcedrawer is the drawer, where the files are on your hard disk).
  1649.  
  1650.   5. To copy the programs enter: `copy TimeGuardian:bin/#? ""'.
  1651.      Some messages appear, which files have been copied already.
  1652.  
  1653.   6. When you want to copy the locale files (only german available at
  1654.      the moment) please enter:  `copy
  1655.      TimeGuardian:Catalogs/deutsch/#? Locale:Catalogs/deutsch'. You
  1656.      should get a message about a copied file.
  1657.  
  1658.   7. When you want to copy the english documentation files please enter
  1659.      `copy TimeGuardian:doc/english/#?  Help:english'.
  1660.  
  1661.   8. Please enter `copy TimeGuardian:env/#?  envarc:' and `copy
  1662. {No Value For "     DISKNAME"}:env/#?  env:' now.
  1663.  
  1664.   9. Please enter `copy TimeGuardian:s/#? s:'.
  1665.  
  1666.  10. When the background program shall be started, while booting, please
  1667.      enter:
  1668.         - start from Workbench:
  1669.           `copy TimeGuardian:bin/TGCron.info Sys:WBStartup'
  1670.           Open the drawer `WBStartup' on the Workbench and click at the
  1671.           icon `TGCron'. Activate the menu `Icons=>Information...'
  1672.           or press the keys Amiga i. A window should pop up. Now enter
  1673.           in the string gadget `Default Tool:': `path/TGCron' (you
  1674.           have to replace path with the full path, where you copied the
  1675.           programs to). Leave the window with the gadget `Save'.
  1676.           or:
  1677.  
  1678.         - start from user-startup:
  1679.           Add the following lines to the file `s:startup-sequence' or
  1680.           `s:user-startup': `run < nil: >nil: path/TGCron' (you
  1681.           have to replace path with the full path, where you copied the
  1682.           programs to). You can do this with the help of an  editor.
  1683.  
  1684.  11. When you want to start the preferences program from the same
  1685.      drawer as the standard preferences programs then enter:  `copy
  1686. {No Value For "     DISKNAME"}:bin/TimeGuardian.info
  1687.      Sys:Prefs'. You have to change the `Default Tool:' like described
  1688.      above at step 10 (from Workbench). Enter the name
  1689.      `path/TimeGuardian' instead of `path/TGCron'!
  1690.  
  1691.  12. To use your personal configuration start the program
  1692.      `TimeGuardian' and leave it with the gadget `Save'.
  1693.  
  1694.    It may be, that you run into problems with this above described
  1695. installation. This can be, when the assign `Help' and the drawer
  1696. `Help:english' don't exist. You can copy the documentation files to any
  1697. other drawer you want. You have to change the file
  1698. `Envarc:AmigaGuide/path' and `Env:AmigaGuide/path' so, that the drawer,
  1699. where you copied the file `TimeGuardian.guide' to, is
  1700. searched. E.g. add the line `dh0:docs' when you copied the above file
  1701. to the drawer `dh0:docs'.
  1702.  
  1703.  
  1704. What is `MUI'?
  1705. ***************
  1706.  
  1707.    `MUI' is program package for users and developpers, that makes a
  1708. graphical user interface available to the programmer and user, with many
  1709. features. `TimeGuardian' ist not able to run without  `MUI'.
  1710. More precise, the preferences program `TimeGuardian'! Therefore
  1711. you have installed `MUI' already or you have to do it before the
  1712. installation of `TimeGuardian'. Where you can obtain `MUI',
  1713. see Where can I obtain MUI?.
  1714.  
  1715.  
  1716. Where can I register for `MUI'?
  1717. ================================
  1718.  
  1719.                          This application uses
  1720.                        MUI - MagicUserInterface
  1721.                   (C) Copyright 1993 by Stefan Stuntz
  1722.  
  1723.      `MUI' is a system to generate and maintain graphical user
  1724.      interfaces. With the  aid  of  a  preferences program, the user of
  1725.      an application has the ability to customize the outfit according
  1726.      to his personal taste.
  1727.  
  1728.      `MUI' is distributed as shareware. To obtain a complete package
  1729.      containing lots of examples and more information about
  1730.      registration please look for a  file  called  `muiXXusr.lha'  (XX
  1731.      means the latest version number) on your local bulletin boards or
  1732.      on public domain disks.
  1733.  
  1734.           If you want to register directly, feel free to send
  1735.  
  1736.                         DM 20.-  or  US-$ 15.-
  1737.  
  1738.                                   to
  1739.  
  1740.                              Stefan Stuntz
  1741.                        Eduard-Spranger-Straße 7
  1742.                              80935 München
  1743.                                 GERMANY
  1744.  
  1745.