home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / fish / enhancements / general / autocli_424 / autocli.doc < prev    next >
Text File  |  1990-12-30  |  15KB  |  342 lines
  1.  
  2.             AutoCLI V1.88 15th Dec 1990 by Nic Wilson
  3.             -----------------------------------------
  4.  
  5. BUG FIXES & CHANGES SINCE THE VERSION ON MEGADISC 17
  6. ----------------------------------------------------
  7. THE FOLLOWING BUGS AND CHANGES CAN ONLY BE GUARANTEED ON VERSIONS
  8. 1.82 AND HIGHER.
  9.  
  10. SEE NEW -l FUNCTION below
  11.  
  12. BUGS
  13. ----
  14.  
  15. 1.  FUNCTION KEY SCRIPT FILES WOULD OFTEN CAUSE A SYSTEM HANG OR GURU.
  16.     Now Fixed.  Caused by priority inheritance problem.
  17.  
  18. 2.  IF AutoCLI WAS LAUNCHED IN MIXED CASE, REMOVAL WAS NOT POSSIBLE.
  19.     Now Fixed.  Any case mixture is acceptable
  20.  
  21. 3.  MOUSE BLANKING (-b) SOMETIMES GAVE A VERTICAL BAR ON THE SCREEN.
  22.     Now Fixed.  Now manipulates copper list instead of Sprite DMA.
  23.  
  24. 4.  MOUSE BLANKING (-b) SOMETIMES CAUSED CERTAIN PROGRAMS TO HANG.
  25.     Now Fixed. DMA problem. Same bug as above.
  26.  
  27. 5.  CUSTOM CLI WINDOWS DID NOT WORK IF TIME BLANKING OPTION USED.
  28.     Now Fixed.  Programming bug.
  29.  
  30. 6.  (-w) OPTION SOMETIMES DID NOT WORK.
  31.     Now Fixed.  Intuition problem, now using Layers instead. 
  32.  
  33. 7.  SCREEN BLANKING HUNG THE SYSTEM IF DRIVE WAS BEING ACCESSED.
  34.     Now Fixed.  DMA problem, fixed by manipulating copper lists.
  35.  
  36. 8.  ON 68020 OR 68030 AMIGA, FUNCTION KEYS WOULD OFTEN CRASH
  37.     Fixed in 1.83. Needed slight delay before changing priority.
  38.  
  39. 9.  MOUSE BLANKING IMPROVED FURTHER.
  40.     Done in 1.84
  41.  
  42. 10. SOMETIMES IT WOULD TAKE A WHILE TO RETURN COMMAND LINE AT LAUNCH.
  43.     Bug in FindProcess macro, sometimes got confused about a task.
  44.     Fixed in V1.85
  45.  
  46. 11. IF IT WAS LAUNCHED PRECEDED BY COLON (ie. c:autocli) IT COULD BE
  47.     LAUNCHED MORE THAN ONCE AND DID NOT REMOVE CORRECTLY.
  48.     Fixed in V1.85 (same bug as item 10.)
  49.  
  50. 12. WHEN RUNNING UNDER OS2.0 MOUSE BLANKING DID NOT WORK, BECAUSE THE
  51.     GFXBASE COPINIT STRUCTURE CHANGED.  NOW IT CHECKS KICKSTART VERSION
  52.     AND WORKS AGAIN.  Change made in version 1.88 
  53.  
  54. CHANGES
  55. -------
  56. Addition of options window that allows, changes to your options
  57. without having to remove and relaunch.  See main docs below for
  58. instructions on its use.
  59.  
  60. Addition of new Lock Pointer option (-l or -lr).  This function allows
  61. you to freeze either vertical, horizontal or both mouse movements.  This
  62. is great for icon aligning or better control in paint programs.  How many 
  63. times have you carefully placed the mouse and had it move slightly when
  64. the button was clicked.    
  65.  
  66. KNOWN BUGS OR CONFLICTS
  67. -----------------------   
  68. Problems have been encountered with non standard versions of the 'RUN'
  69. command.  This command is called by dos.library's 'execute' command.  If
  70. you have problems with the Amiga crashing when a CLI is popped up then
  71. make sure the 'run' command is standard.  The one I use came from an 
  72. original 1.3.2 workbench and has a filesize of 2568 bytes.  It is also
  73. recommended that ARP Library commands are not used, as they are not
  74. very compatible and can cause various problems.
  75.  
  76. SUGGESTIONS
  77. -----------
  78. If AutoCLI does not have your favourite function, or you can think
  79. of any improvements, then write and tell me.  The best suggestions
  80. will receive a full version of NoVirus free of charge.
  81.             
  82. This program has been placed on the Public Domain for your enjoyment. 
  83. Permission is hereby given to distribute this program in any 
  84. way you see fit, as long as this doc file accompanies it.
  85. Please send any bug reports or ideas (and spare money) to the
  86. address at the bottom of this file.
  87.  
  88.  
  89. Commercial companies may also distribute the program, as long
  90. as the program is free of charge and this file accompanies it.
  91.  
  92. We at Nic Wilson Software not only write commercial programs, but
  93. as you see we write non-commercial too.  If you like this program
  94. and you use it, then help us by sending a donation to the address below.
  95.  
  96. PROGRAM SUMMARY
  97. ---------------
  98. This program was written because of problems with the similar program I
  99. have been using called 'popcli'.  Popcli crashes if used under
  100. WorkBench/KickStart 2.0, and also if used on a PAL Amiga to open a CLI
  101. window with a vertical size greater than 200 lines, it will not open if
  102. your Amiga decides to start in NTSC mode as they sometimes do.  Popcli also
  103. seems to waste CPU time when waiting and doesn't allow you to remove it
  104. from memory without crashing or a reboot. AutoCLI overcomes all of the
  105. above problems and has many added features equivalent to other programs
  106. around, but uses less CPU time. In fact while waiting it uses 0.0% (as seen
  107. in 'Xoper'). 
  108. AutoCLI was written in 100% Assembler using Devpac Amiga V2.14.
  109.  
  110. Hand coded assembler is definately the best way to program.  The code is
  111. small and executes very quickly as compared to coding in 'C' or other
  112. language, as the code generated would be much larger and slower.  This can
  113. be noticed by running a program like 'xoper' that shows a percentage of CPU
  114. time that each task is using.  The only time AutoCLI uses time is if an
  115. event sends it a signal to do something.  A lot of programmers that do not
  116. use assembler, code the event handler in C:, which is against good
  117. programming practise, as stated in the Amiga Rom Kernal Reference Manual,
  118. Libraries and Devices Revised and Updated.    
  119.  
  120. FEATURES
  121. --------
  122.     * Kickstart / Workbench 1.2, 1.3, 2.0 compatible
  123.  
  124.     * Compatible with A500, A1000, A2000, A2500, A3000
  125.  
  126.     * Default or custom CLI / Shell windows
  127.  
  128.     * Default windows open to 1 pixel less than current screen
  129.  
  130.     * Function key scripts option
  131.  
  132.     * Options window allows modification while running
  133.  
  134.     * Active window to front option
  135.  
  136.     * Screen shuffle option
  137.  
  138.     * Window shuffle option
  139.  
  140.     * Screen blanking after time period option
  141.  
  142.     * Mouse blanking on key press or time option
  143.  
  144.     * Mouse acceleration option
  145.  
  146.     * No CPU time wastage
  147.  
  148.     * 100% machine code
  149.  
  150.     * Freely distributable
  151.     
  152. PROGRAM USAGE FOR INSTALLING AutoCLI
  153. ------------------------------------
  154. AutoCLI [<optional switches>] [<optional seconds>] [<optional command>]
  155.  
  156. DO NOT USE RUN or RUNBACK as it will return the command
  157. line and allow the window it was launched from to close, when an
  158. ENDCLI command is given. Yet it still retains the directory it
  159. was launched from and does not lose the current path or stack as
  160. some programs do.  This means that when a CLI is popped up it will
  161. default to the directory that was current, when AutoCLI was launched.
  162. The path and stack that was set, will still be valid. 
  163.  
  164. The program is mainly designed to be used in your startup-sequence
  165. so you will always have a CLI window available very easily.  For best
  166. results, AutoCLI should reside in your C: directory.
  167.  
  168. OPTIONAL SWITCHES
  169. -----------------
  170.     The following switches do not have to be given in any particular order,
  171.     but must all be before the optional seconds and command parameters.
  172.     All options default to OFF and must be enabled with a switch.
  173.  
  174.     Any of these options can be modified after launch, by using the 
  175.     Option Window provided. (see OPTIONS WINDOW below)
  176.  
  177. -f          This switch enables function key trapping.  When your qualifier
  178.             (see below) is held down and a function key pressed, the       
  179.             program will execute a script file in the assigned S:          
  180.             directory with a filename of autocli.f1 to autocli.f10.      
  181.             This file must be a normal script (eg. startup-sequence).
  182.     
  183. -w          This switch enables the window to front option.  To use this
  184.             function, select the window you want at the front by clicking
  185.             the left mouse inside the window and then hold your qualifier
  186.             key (see below) and press the Left ALT key. 
  187.  
  188. -n          This switch enables the screen shuffle option.  To use this
  189.             function, hold down your qualifier key and use the cursor
  190.             up or down keys.  These keys rotate all screens in opposite
  191.             directions to each other.
  192.             This is different to the standard LEFT AMIGA N & M.  These
  193.             standard keys only swap between the front and rear most       
  194.             screens.
  195.  
  196. -m          This switch enables the window shuffle option.  To use this
  197.             function, hold down your qualifier key and use the cursor
  198.             left or right keys.  This will move the front most window to
  199.             the back or the back most window to the front respectively.
  200.             The window shuffle always occurs on the screen that is at
  201.             the front.  This allows you to easily move between windows
  202.             and screens by using the qualifier and all the cursor keys
  203.     
  204.  
  205. -q          This switch enables mouse acceleration, If you find that it
  206.         is too fast, slow it down in preferences.  The amount it
  207.         speeds the mouse up by depends on the speed the mouse is
  208.         being moved.  As it moves quicker the acceleration rate
  209.             increases and as it slows down the acceleration rate also
  210.             decreases.
  211.  
  212. -l or -lr   This switch allows the mouse movements to be frozen in vertical,
  213.         horizontal or both directions.  If the CONTROL key is depressed
  214.         the horizontal movements are frozen.  If the LEFT ALT key is 
  215.         pressed then the vertical movements are frozen.  If both are
  216.         depressed then all movements are frozen.  When either of these
  217.             keys are released then movements continue in that direction.
  218.              If these keys conflict with your chosen qualifier key (see 
  219.         -s -c -a) then use the -lr switch instead, your keys with
  220.         then change to RIGHT SHIFT for horizontal and RIGHT ALT for
  221.         vertical.
  222.  
  223. -b        This switch enables mouse blanking.  When any key is pressed
  224.         the mouse pointer will be immediately blanked, or if no mouse
  225.         movement is detected within 30 seconds the mouse pointer will
  226.         be blanked.  As soon as the mouse is moved at all the pointer
  227.         will be returned immediately.  This overcomes the annoying
  228.         habit of the pointer always being in the way while typing.
  229.  
  230. -s  -c  -a  The default qualifier key is the LEFT AMIGA but this can be 
  231.             changed with a switch.  The -s switch changes the qualifier 
  232.             key to the SHIFT key.  The -c switch changes it to the CONTROL 
  233.             key, and the -a switch changes it to the ALT key.  To use the 
  234.             default key (LEFT AMIGA) then don't use any of these three 
  235.             switches.  Note that this qualifier key is also the same for 
  236.             the autocli function as well.
  237.             
  238. -r          The above qualifier is, by default, the key on the LEFT side   
  239.             of the keyboard.  To change this to the RIGHT side, use thi    
  240.             switch.                  
  241.  
  242. ?           If the switch is a single question mark, then AutoCLI
  243.             will display a USAGE string on the current CLI window.  
  244.             It will not install or remove itself.
  245.  
  246. remove      This switch should be used on its own.  It will signal
  247.             the current version of AutoCLI to shut down and remove 
  248.             itself.  Whenever it attempts this removal, a success
  249.             or failure message will be displayed on the CLI window.
  250.  
  251. OPTIONS WINDOW
  252. --------------
  253. This function is always available, even if function key scripts (-f)
  254. is turned off.  It is accessed by holding the qualifier key and pressing
  255. HELP.  A window will open on the front most screen  with gadgets set with 
  256. your current options.
  257. Click on the gadgets to turn functions on or off.  Screen blanking time 
  258. can be changed by clicking in the gadget and changing it accordingly.
  259. If you turn screen blanking on, but give no time, then a default time
  260. of 300 seconds will be set.
  261. At the bottom of the window are two gadgets, 'OK' and 'REMOVE'.  The 
  262. remove gadget will remove AutoCLI from memory completely.  The ok gadget
  263. will set the new options you have made.
  264.  
  265. OPTIONAL SECONDS
  266. ----------------
  267. This is an optional time (in seconds) to blank the screen when no user
  268. input is detected.  The default is off, so if blanking is not wanted then
  269. do not give a time at all.  When the screen has been blanked, it can be
  270. turned on again by touching any key or moving the mouse.  Because it only
  271. requires a single rawmouse event, we have found that giving your computer
  272. table a nudge is sufficient to turn the display on again.
  273.  
  274. OPTIONAL COMMAND
  275. ----------------
  276. If no optional command is given then AutoCLI will use a default command.
  277. AutoCLI will launch and wait for your qualifier key and ESCAPE to be
  278. pressed.  When this event occurs AutoCLI will open a CLI window 1 pixel
  279. less than the size of the WorkBench Screen at the time it is opened.  So 
  280. if resolution mode is changed AutoCLI will notice the change.  If NEWCON:
  281. is available, a Shell window will open instead of a CLI window.  
  282.  
  283. If an optional command is given, AutoCLI will execute that command
  284. in preference to the default CLI/SHELL window when your qualifier key 
  285. and ESCAPE is pressed (see EXAMPLES).  This allows custom commands or 
  286. custom size CLI/Shell windows to be used.  Note that if AutoCLI is already
  287. in memory it will display an error message on the current CLI
  288. window.
  289.  
  290.  
  291. EXAMPLES
  292. --------  
  293.      AutoCLI -f -w -n -m -l -r -s 600 newshell newcon:0/10/640/150/MyShell
  294.      (opens a Shell window with a title of 'MyShell', enables function 
  295.      keys, selects the RIGHT SHIFT as your qualifier, enables the window 
  296.      to front option ,enables the screen shuffle option, enables the 
  297.      window shuffle, enables pointer lock  and will blank the screen after 
  298.      10 mins of non use). 
  299.  
  300.      AutoCLI -f -w YourProg
  301.      (runs a file called YourProg.  When LEFT AMIGA/ESCAPE is pressed
  302.      enables function keys and window to front and will disable
  303.      the screen blanking ie. no time given).
  304.                    
  305.      AutoCLI remove
  306.      (attempts to remove the currently running version from memory
  307.      and displays a success or failure message).
  308.  
  309.  
  310. REQUIREMENTS
  311. ------------
  312. The following commands MUST be available in the current C: directory :- 
  313.    
  314. run        ; c directory (called by the DOS Execute function)
  315. newcli         ; c directory (called by AutoCLI if NEWCON not available)
  316. newshell    ; c directory (called by AutoCLI if NEWCON is available)
  317. shell-seg     ; l directory (needed if newcon: is mounted)
  318. AutoCLI        ; c directory
  319.  
  320. The following commands, devices, files are optional :-
  321.  
  322. cli-startup    ; s directory (script executed by Newcli)
  323. shell-startup     ; s directory (script executed by NewShell)
  324. NEWCON:        ; (must be mounted to enable Shell instead of CLI)
  325. AutoCLI.F1    ; s directory (script file for qualifier/F1)
  326. AutoCLI.F2    ; s directory (script file for qualifier/F2)
  327. ...etc.
  328.  
  329. NOTE: 'Amiga' is a Trademark of Commodore Amiga Inc.
  330.       The idea for Pointer Lock come from a program 'Tame Pointer' by JOHN ROWE.
  331.  
  332.  
  333. Nic Wilson Software
  334. 138d South Street
  335. TOOWOOMBA Queensland 4350
  336. Australia 
  337. Phone (076) 358539  Home, (076) 358522  Work or Fax
  338.  
  339.       
  340.  
  341.                   
  342.