home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / s1 / systemvar / !SystemVar / Docs / Manual next >
Text File  |  1996-05-03  |  5KB  |  122 lines
  1.  
  2.  ABOUT THIS PROGRAM
  3.  ---------------------------------------------------------------------------
  4.  Name    : SystemVar
  5.  Version : 1.01 (03 May 1996)
  6.  Purpose : Read/Set/Delete system variables
  7.  Author  : © Andrew Berry, 1996
  8.  Licence : Freeware. Please see conditions at the end of this file.
  9.  
  10.  SystemVar supports Interactive Help.
  11.  
  12.  
  13.  PURPOSE
  14.  ---------------------------------------------------------------------------
  15.  SystemVar is designed to read, set or delete system variables. This could
  16.  be useful to, for example, find the current value of Obey$Dir, or read or
  17.  set the RunType of a file.
  18.  
  19.  Some applications set a variable xxx$Loaded to 'Yes' when they start up, so
  20.  that two copies of the application aren't loaded at the same time. This is
  21.  OK unless the application crashes, leaving xxx$Loaded set to 'Yes', and
  22.  leaving you unable to reload the application. Unsetting (deleting) the
  23.  variable xxx$Loaded will enable the application to be reloaded.
  24.  
  25.  
  26.  READING A VARIABLE
  27.  ---------------------------------------------------------------------------
  28.  To read the value of a variable, enter the variable name (for instance
  29.  Obey$Dir) into the top writeable icon and click on 'Read Variable'. The
  30.  value of the variable will be entered into the second icon, and the
  31.  variable type will be entered into the display field in the top right.
  32.  If the variable does not exist then a message to inform you of this will
  33.  be entered in the value box.
  34.  
  35.  
  36.  SETTING A VARIABLE
  37.  ---------------------------------------------------------------------------
  38.  To set a variable, enter the variable name into the top icon and press
  39.  Return. Select the required variable type by clicking SELECT over the menu
  40.  icon (top right) and select a type. The types available are described
  41.  below. Finally, enter the required value of the variable into the 'Value'
  42.  writeable icon and click 'Set variable'. 
  43.  
  44.  
  45.  UPDATING A VARIABLE
  46.  ---------------------------------------------------------------------------
  47.  To update a variable read it's current value, make any alterations which
  48.  are necessary, and then click on 'Set Variable'.
  49.  
  50.  
  51.  DELETING A VARIABLE
  52.  ---------------------------------------------------------------------------
  53.  To delete a variable enter the variable name in the top writeable icon and
  54.  click on 'Delete Variable'. The message 'Deleted' will be entered into the
  55.  'Value' box.
  56.  
  57.  
  58.  VARIABLE TYPES
  59.  ---------------------------------------------------------------------------
  60.  These are described briefly in the PRM, page 1-312.
  61.  
  62.  String   - The value will be OS_GSTrans'd immediately
  63.  Number   - The value is a 4 byte (signed) integer
  64.  Macro    - The value will be OS_GSTrans'd each time it is used
  65.  Expanded - The value will be evaluated as expression using OS_Evaluate-
  66.             Expression and is automatically assigned to a number or string
  67.             variable, depending in the expression type. For example, if you
  68.             give a variable the value "Obey$Dir" and make it a string value
  69.             then it will have the value "Obey$Dir", exactly as entered.
  70.             However, if you give it the same value but make it an expanded
  71.             variable, then it will take the value held by Obey$Dir, ie a
  72.             pathname.
  73.  
  74.  
  75.  HISTORY
  76.  ---------------------------------------------------------------------------
  77.  1.00 (13 Feb 1996) : • The first version - Read, set delete variables.
  78.  ---------------------------------------------------------------------------
  79.  1.01 (03 May 1996) : • Small changes to program and documentation.
  80.  
  81.  
  82.  DISTRIBUTION NOTES
  83.  ---------------------------------------------------------------------------
  84.  This program is Freeware, NOT public domain. This means that I retain the
  85.  copyright but give everyone the right to distribute it by any means, as
  86.  long as all files are supplied and I am fully credited.
  87.  
  88.  If you would like to include this program on a magazine cover disc then
  89.  please contact me first to obtain the latest version. If you run a PD
  90.  library and did not obtain this program from me, then you may like to write
  91.  and I'll send you the latest versions of all my programs followed by
  92.  regular updates as they become available.
  93.  
  94.  
  95.  PLEASE NOTE
  96.  ---------------------------------------------------------------------------
  97.  Although this program has been fully tested, I (the author) cannot be held
  98.  responsible for any loss or damage caused by the use or misuse of this
  99.  program. It is used entirely at your own risk.
  100.  
  101.  
  102.  CONTACT
  103.  ---------------------------------------------------------------------------
  104.  Please write to me at the address below. I would be interested to hear if
  105.  you have ideas for improving the program or have found any bugs.
  106.  
  107.  New versions of all my programs are always sent first to APDL and
  108.  The Datafile or can be obtained by writing to the below address, enclosing
  109.  either a cheque for £1.00 or a disc and return postage.
  110.  
  111.  The file SystemVar.Docs.Others contains details of my other programs. 
  112.  
  113.  Please write to:
  114.  
  115.     Andrew Berry
  116.     39 Lancaster Avenue
  117.     Sandiacre
  118.     Nottingham
  119.     NG10 5GW
  120.     
  121.  ---------------------------------------------------------------------------
  122.