home *** CD-ROM | disk | FTP | other *** search
/ Network CD 2 / Network CD - Volume 2.iso / programs / internet / develop / nsplib1_30.lha / NetSupportLibrary / doc / InstallingNSPLib.doc next >
Encoding:
Text File  |  1994-04-21  |  3.8 KB  |  109 lines
  1. How to install the NetSupport.Library
  2. *************************************
  3.  
  4.     The installation of the library is actually very easy: Just copy the
  5. file to your `LIBS:' directory. :-)) However, the library needs its own
  6. configfile which is the topic of this document.
  7.  
  8.     You can place the file at any path you like, you can even chose any name
  9. you want. All you have to do is to set the environment variable NSPCONFIG
  10. according to the path. The library will check, in order of precedence, for a
  11. local and a global variable and use the value as path and name for the
  12. config file. If no NSPCONFIG variable is set, the default path is
  13. `S:NSPConfig'.
  14.  
  15. The config file
  16. ===============
  17.  
  18.     A valid config file may contain one keyword per line. Keywords MUST
  19. begin at the first column. The parameter can be separated from the keyword
  20. using either space(s) or tab(s). Lines starting with a "#" are comment lines
  21. and will be ignored.
  22.  
  23. Here's an example:
  24.  
  25.      #
  26.      # NetSupport.Library config file
  27.      #
  28.      # $VER: NSPConfig 1.23 (22.2.94)
  29.      #
  30.      
  31.      #
  32.      # where the default config file is
  33.      #
  34.      MasterConfig    UULib:Config
  35.      
  36.      #
  37.      # Configuration for MakeLogEntry()
  38.      #
  39.      DefaultLog      UUSpool:Logfile, stdout
  40.  
  41. The above entries have the following meanings:
  42.  
  43.    - MasterConfig
  44.  
  45.      This is important for routines dealing with config files. The caller
  46.      has the possibility to provide a NULL as filename and let the library
  47.      determine the correct file. The library will use the file you specify
  48.      here. This should generally be the main config file of your
  49.      installation, like `UULib:Config' for UUCP or `inet:s/inet.config' for
  50.      the AS225r2 package. This feature makes the programs using the library
  51.      package-independent.
  52.  
  53.    - DefaultLog
  54.  
  55.      You can specify a separate logfile for each program that uses the
  56.      library. However, just in case your forget it, this logfile will be
  57.      used. You can specify several logfiles, separated with commas. The
  58.      libraries parsing routine is still a little bit weak, so please do not
  59.      try special tricks, okay? :-) "stdout" is a magic, standing for the
  60.      program's standard output stream. An entry like
  61.  
  62.           Testname        T:testlog, stdout
  63.  
  64.      will write the logentry to both, the file and the output window. You
  65.      may also specify "CONSOLE:" for the standard error stream of the
  66.      program. This is always a window and will not be affected by
  67.      redirection, unlike "stdout". "PRT:" will naturally send a copy of
  68.      every log entry to the printer, etc...
  69.  
  70.      Like mentioned above, you can specify logfile(s) for each program using
  71.      the library. The program should state the keyword it uses in its
  72.      manual, but usually it's just the name of the program. ListSERV, for
  73.      example, can be configured like this:
  74.  
  75.           ListSERV        ListSERV:logfile, stdout
  76.  
  77. Debugging
  78. =========
  79.  
  80.     NetSupportLibrary's MakeLogEntry() function provides an easy way to
  81. control debugging output. The program author is able to provide debugging
  82. info of lower priority, which is not logged by default but only if you turn
  83. it on manually. Nine degrees between 1 and 9 are supported. You can set the
  84. debugging level from 0 (default) to see none of them up to 9 to see
  85. everything. NetSupport.Library checks the following places in order of
  86. precedence:
  87.  
  88.    - local DOS variable <SYSTEMNAME>_DEBUG
  89.  
  90.      To turn the debugging info for ListSERV on (for example) execute "Set
  91.      ListSERV_debug 9".
  92.  
  93.    - global ENV variable <SYSTEMNAME>_DEBUG
  94.  
  95.    - <SYSTEMNAME>_DEBUG keyword in your netsupport config file
  96.  
  97.    - local DOS variable DEBUG
  98.  
  99.      To turn the debugging info for *all* programs using the library on,
  100.      execute "Set Debug 9".
  101.  
  102.    - global ENV variable DEBUG
  103.  
  104.    - DEBUG keyword in your netsupport config file
  105.  
  106.    - DEBUG keyword in your master config file (specified in the netsupport
  107.      config file)
  108.  
  109.