home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / comm / fido / spot / rexx / spotcli.doc < prev    next >
Text File  |  1994-07-18  |  5KB  |  134 lines
  1.  
  2.                                __  ___
  3.                                |_)( |_)
  4.                                |  _)| \
  5.                            S O F T W A R E
  6. ______________________________________________________________________
  7.  
  8.    Presents: SpotCLI
  9. Description: An Arexx CLI for Spot.
  10. Requirement: Registered copy of Spot
  11.     Version: 1.0
  12.        Date: 14/06/94
  13.  
  14.       Status: Freeware.   
  15. Contribution: n/a
  16.  
  17.  Acknowledge: Spot, Nico Francois; Arexx, William S. Hawes
  18. ______________________________________________________________________
  19.  
  20.                      "SpotCLI to rise and shine."
  21.  
  22. Brief ________________________________________________________________
  23.  
  24.  A simple CLI  for the easy execution  of Arexx  commands.  It's  best
  25.  suited to people who prefer the quick and dirty command line approach
  26.  to Intuition.
  27.  
  28.  SpotCLI  also contains  adaptions of many of the  Spot Arexx commands
  29.  to make life even easier, for example, you can select a new area when
  30.  reading messages without returning to the arealist.
  31.  
  32. Usage ________________________________________________________________
  33.  
  34.  INSTALLING SPOTCLI
  35.  ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  36.  The script  can be copied to where  you keep all of your Spot scripts
  37.  (usually  'REXX:' or 'REXX:Spot' etc.).  The script  can be  run from
  38.  the option 'Execute Script'  from the 'Arexx' menu or else,  and this 
  39.  is a better  option, it can be  installed directly to the Arexx menu.
  40.  To do this, see the Spot documentation.
  41.  
  42.  SpotCLI is a  good script to install  under one of the  Arexx options
  43.  which has a  keyboard shortcut as you find you may need to call it up
  44.  from time to time.
  45.  
  46.  SETTING UP SPOTCLI
  47.  ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  48.  The only  line in  the script  which may be altered is  the  one which
  49.  determines the nature of the con: window.  This line is clearly marked
  50.  with comment lines.  The way you set up the con: window will depend on
  51.  both the screenmode in which you run, and also your own taste.
  52.  
  53.  USING SPOTCLI
  54.  ¯¯¯¯¯¯¯¯¯¯¯¯¯
  55.  Upon calling  the script, a window  will (or at  least 'should')  open
  56.  and this is where the commands can be entered from.
  57.    
  58.  As well as the standard  Spot commands which are covered in Spot's own
  59.  documentation, SpotCLI offers the following:
  60.  
  61.    · AREA: entering 'area'  alone will bring up and  area list allowing
  62.      you to  select the area to  move to.  This command  is useful from
  63.      the message window and message list.  Following the command with a
  64.      name of an area will move to the specified area.  Area names which
  65.      contain a space should be entered in quotes. ie area "fred bloggs"
  66.  
  67.    · CLS: clears the SpotCLI window.
  68.  
  69.    · D(OWN), U(P): both  the area  and message lists  can be  traversed
  70.      using the 'up'  and 'down' commands, which  can be  abbreviated to
  71.      just 'u' and 'd'.  Entering  them alone will move up and  down the
  72.      list  respectively  a single item.  Following  the comamnd  with a
  73.      number will move by the specified amount. ie 'u 3' moves up three.
  74.  
  75.    · FREQ: same function as Spot's command 'filerequest'.
  76.  
  77.    · HIDE: this will make the  SpotCLI window disapppear until you move
  78.      out of the message window.  SpotCLI may take a second to appear.
  79.  
  80.    · LOCKGUI: replaces Spot's  command of  same name.  This can be used
  81.      alone where it will have exactly the same function as the real
  82.      command, or it can be followed by a password which must be used to
  83.      unlock. ie 'lockgui fred'.  In the locked state, SpotCLI can still
  84.      be used  except the GUI  cannot be  relocked (safety feature).  As
  85.      the  GUI is  locked, the SpotCLI window is  cleared  so  that  the
  86.      password cannot be seen.   
  87.  
  88.    · UNLOCKGUI: replaces Spot's command of same name.  This will
  89.      unlock the GUI after being locked with LOCKGUI (above).  If a
  90.      password was used, the same password must be used again to unlock
  91.      the GUI.
  92.  
  93.    · U(P) see down.
  94.  
  95. This Version's Improvements___________________________________________
  96.  
  97.  o N/A: first version
  98.  
  99. Future Enhancements __________________________________________________
  100.  
  101.  o Script recording and playback.
  102.  
  103. Disclaimer ___________________________________________________________
  104.  
  105.  o I am not responsible for any damage caused through the use or misuse
  106.  of this product and so it must only be used at your own risk.  All
  107.  efforts have been made to ensure the stability of the program but
  108.  this does not mean it is 100% safe.  Please backup any important data
  109.  that could be damaged through the use of this software until you are
  110.  sure that it is stable...Amen.
  111.  
  112. Donations/Comments ___________________________________________________
  113.  
  114.  Any comments or donations can be sent to:
  115.  
  116.   Physical Mail_________
  117. o PSR Software
  118.   Paul Ruane
  119.   26 Birdwood Close,
  120.   Selsdon, Surrey.
  121.   CR2 8QG.
  122.  
  123.  I may also be contacted at the following addresses as Paul Ruane:
  124.  
  125. o E-Mail________________
  126.   paul.ruane@portofc.org
  127.  
  128. o Fidonet_______________
  129.   2:254/149.3
  130.  
  131. o Amiganet______________
  132.   39:135/14.3
  133. _________________________________________________________________NULL_
  134.