home *** CD-ROM | disk | FTP | other *** search
/ Aminet 10 / aminetcdnumber101996.iso / Aminet / util / misc / Reboot_1_2.lha / Reboot / Reboot.doc < prev    next >
Text File  |  1995-11-29  |  7KB  |  189 lines
  1.  
  2. /*
  3. **
  4. **  $VER: Reboot.doc 1.2 (28.11.95)
  5. **  Reboot 1.2
  6. **
  7. **  documentation
  8. **
  9. **  (C) Copyright 1994/1995 by Roland 'Gizzy' Mainz
  10. **          All Rights Reserved
  11. **
  12. */
  13.  
  14. =====================   Reboot 1.2 documentation   ========================
  15. ===========================================================================
  16. A   simple   tool   to  be  used   with  Kickstart 2.x/3.x,  written  by
  17.  Roland 'Gizzy' Mainz,  freeware, all rights reserved.
  18. No guarantee of any kind is made that  the programm described below in this
  19.  document is 100% reliable. You use this material on your own risk.
  20.  
  21.  
  22. =========================== Misc ==========================================
  23. ===========================================================================
  24. While playing with ENVOY 1.6, I need a program which allows to reboot
  25. another AMIGA through the network (by my own "RemoteNetShell") or
  26. after a given time.
  27. First I wrote a little script (using WAIT) and a C program calling
  28. exec.library/ColdReboot() to solve this problem.
  29. Switching to IAM's ENVOY 2.0 I replaced this script by this tool,
  30. adding some features (WB (including multiselect), SHELL ReadArgs(),
  31. locale support and test mode).
  32.  
  33. In the first release (V1.1) were four bugs:
  34. 1. The "Abort reboot" requester couldn't be canceld 1 second before
  35.    the given time.
  36.    Fixed.
  37. 2. I did not read the autodocs exactly:
  38.    The function BuildEasyRequest might return 0 or 1 at low mem time.
  39.    Now Reboot simply fails with ERROR_NO_FREE_STORE for both 0 or 1.
  40.    If 1 was returned, an enforcer hit would occur.
  41.    Never happed, but
  42.    fixed.
  43. 3. AttemptOpenLibrary could return (sometimes) random pointers.
  44.    In fact, this never happened by me, but maybe ...
  45.    Fixed.
  46. 4. While getting Reboot's environment variable, the "Abort reboot"
  47.    requester might be canceled. Now we check this:
  48.    Fixed.
  49.  
  50. Additional, there was some code cleanup which adds support for
  51. DICE INLINE calls.
  52.  
  53. The executable is now PURE and can be made resident.
  54.  
  55. The time between the program checks the "Abort reboot" requester has beed
  56. decrased down to a half second.
  57.  
  58. =========================== Installation ==================================
  59. ===========================================================================
  60. After unpacking this archieve:
  61.  
  62. Workbench:
  63.   - Drop the 'Reboot' icon in your favorite drawer (like
  64.      "SYS:Utilities/").
  65.     See SHELL for copying the catalog files.
  66.  
  67. Shell:
  68.   - Unpack this archieve at "SYS:Utilities/"
  69.     and add the following statements at your "S:user-startup" startup file:
  70.  
  71.     Assign Reboot: SYS:Utilities/Reboot
  72.     path Reboot: ADD
  73.   OR
  74.   - Drop/Copy the 'Reboot' file in your favorite directory
  75.     (like "Sys:Utilities").
  76.     To copy the (german) catalog files, type
  77.     Copy Catalogs/#? TO="LOCALE:Catalogs/" ALL QUIET CLONE
  78.  
  79. =============================== Usage =====================================
  80. ===========================================================================
  81.  
  82.     NAME
  83.         Reboot -- rebooting utility
  84.  
  85.     FORMAT
  86.         Reboot [REBOOTDELAY <seconds>] [QUIET|NOREQ]
  87.  
  88.     TEMPLATE
  89.         REBOOTDELAY/K/N,QUIET=NOREQ/S
  90.  
  91.     TOOLTYPES
  92.         REBOOTDELAY/N
  93.         QUIET/S
  94.         NOREQ/S
  95.  
  96.     PURPOSE
  97.         To reboot the computer.
  98.  
  99.     SPECIFICATION
  100.         Reboot is used to reboot the whole computer like a "cold"
  101.         system start.
  102.  
  103.         Unless you specify otherwise (through REBOOTDELAY option), reboot
  104.         will wait 2 seconds before rebooting the system.
  105.         This is used to let the system (and it's disk drives) settle.
  106.         This delay time can't be less than 1 second, a REBOOTDELAY=0
  107.         will also wait this minimum time.
  108.  
  109.         Whenever the QUIET (or NOREQ) option is set, the verify requesters
  110.         ("Are you sure#?" etc.) will be suppressed.
  111.  
  112.         Test mode / Variable support:
  113.         "Setenv Reboot OFF" or "Set Reboot OFF" will stop Reboot from
  114.         rebooting the system. Instead it will work like when a CTRL_C
  115.         signal or an aborted verify requester occurs.
  116.         This is very useful when testing scripts etc.
  117.         See also in the BUGS section.
  118.  
  119.         Reboot supports workbench multiselect (e.g. project icons) !
  120.  
  121.     BUGS/NOTES
  122.         Setenv Reboot " OFF" (space before/after OFF switch) currently
  123.         won't stop rebooting the system.
  124.         Be sure you don't set some rubbish in this variable. If future
  125.         parsing through dos.libary/ReadArgs() fails, later versions of
  126.         Reboot won't reboot the system.
  127.         Shell variables longer than 255 are currently not supported.
  128.  
  129.         "Set Reboot OFF" is only valid if you start Reboot from this
  130.         shell.
  131.  
  132.  
  133. =============================== TODO ======================================
  134. ===========================================================================
  135.   - ReadArgs() parsing of REBOOT variable
  136.   - AmigaGuide document "Reboot.guide"
  137.  
  138.  
  139. ============================== SOURCE =====================================
  140. ===========================================================================
  141. Reboot source and catalogs may be recompiled/reprocessed
  142. (using DICE-C, SAS-C or GNU-C) by executing Reboot.c.
  143.  
  144. If you would use SAS-C, you must enable the related shell statements (and
  145. the DICE ones must be disabled).
  146. Currenty the SAS-C section isn't tested.
  147.  
  148. GNU-C support will be done in one future version.
  149.  
  150. If you like to include a new language (like Français or Nederlands etc.),
  151. send me a filled "Reboot_blank.ct" file named "Reboot_#?.ct" (#? for your
  152. language). As an example, see "Reboot_deutsch.ct".
  153. Note that I can currently only process "Reboot_#?.ct" files whose language
  154. is supported by AmigaOS 3.1 (e.g. a CBM language driver exists).
  155.  
  156.  
  157. =========================== Author's Request ==============================
  158. ===========================================================================
  159. By  releasing  this program I do  not  place any obligations on you,
  160. feel free to share this program with your  friends (and enemies).
  161.  
  162. If you want to blame me, report any bugs, or wants a new version
  163. send your letter to:
  164.                 Roland Mainz
  165.                 Hohenstaufenstraße 8
  166.                 52388 Nörvenich
  167.                 GERMANY
  168.  
  169. EMAIL is also available:
  170. If you don't find a file "email.changed" in this archieve,
  171. my email address is:
  172.                 mainz@mats.gmd.de
  173.  
  174. Sorry, but I can only look once a month for mails.
  175.  
  176. The  entire  "Reboot"  package  may  be  noncommercially  redistributed,
  177. provided  that  the package  is always  distributed in it's complete  form
  178. (including it's documentation).  A small copy fee  for media costs is okay
  179. but any kind of commercial distribution is strictly forbidden!
  180. Comments  and  suggestions  how  to  improve  this  program  are generally
  181. appreciated!
  182.  
  183. Thanks to Matt Dillon for his DICE, and Olaf 'Olsen' Barthel for his
  184. help, ideas and some text clips from his documentations.
  185.  
  186.  
  187.  
  188.  
  189.