home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / ramon121.exe / RAMON.DOC < prev    next >
Encoding:
Text File  |  1997-05-11  |  21.3 KB  |  507 lines

  1. User Manual
  2.  
  3.  
  4.  
  5.     RemoteAccess Monitor for DOS
  6.  
  7.     Monitoring & control for
  8.     RemoteAccess based BBS's
  9.  
  10.  
  11.     
  12.  
  13.  
  14.  
  15.     Copyright (c) 1997, Envy Technologies.
  16.  
  17.  
  18.  
  19. Contents
  20.  
  21. Part 1  Introduction
  22.     Introduction to RA-Monitor
  23.     Licence agreement
  24.     Revision history
  25.     Requirements
  26.     Setting up RA-Monitor
  27.  
  28. Part 2  Using RA-Monitor
  29.     The environment
  30.     Status window
  31.     Control window
  32.     Node Information window
  33.     BBS Information window
  34.     RAStatus
  35.  
  36. Appendixes
  37.     Frequently asked questions
  38.     Contacting Envy Technologies
  39.     Future enhancements
  40.     Credits & acknowledgements
  41.  
  42.  
  43. Introduction
  44.  
  45. Introduction to RA-Monitor
  46.  
  47. RemoteAccess Monitor (or RA-Monitor), is a monitoring & control program for 
  48. the popular bulletin-board package, RemoteAccess.
  49.  
  50. RA-Monitor allows you to monitor the status of your BBS, see who is logged in, 
  51. and what they are currently doing.  In addition, you can send online messages 
  52. to nodes, log them off or display detailed information about their current 
  53. login.  All of this functionality is provided in a full DOS windowed 
  54. environment allowing you to have multiple windows open with resizing & 
  55. movement while retaining the familiar interface of the RemoteAccess tools such 
  56. as RAMGR or RACONFIG.
  57.  
  58. RA-Monitor is also extremely easy to setup.  It will run straight from the 
  59. package without configuration, reading necessary information such as display 
  60. settings and number of nodes.  The included configuration program can be used 
  61. to fine-tune settings for some features.
  62.  
  63.  
  64. Licence agreement
  65.  
  66. The RA-Monitor package consists of all files contained within the distribution 
  67. archive.  Before running RA-Monitor, you must read and agree to the following 
  68. conditions. If you do not or can not agree to and accept the following 
  69. conditions, you are prohibited from using this package.
  70.  
  71. o       RA-Monitor is copyrighted Damien Guard/Envy Technologies and may only 
  72.     be used in accordance with the conditions set forth in this license 
  73.     agreement.
  74. o       RA-Monitor is distributed as a FREEWARE program for this release.  
  75.     This means that the software may be freely distributed and used but 
  76.     Envy Technologies retains all copyrights on this package.  This 
  77.     licensing agreement does not apply to any future releases which may be
  78.     packaged with an alternative licensing agreement.
  79. o       Permission is granted to any individual or institution to use, copy, 
  80.     or redistribute RA-Monitor free of charge as long as the distribution 
  81.     package is not modified, nor sold for profit.
  82. o       RA-Monitor may be used free of charge in both private and commercial 
  83.     systems.
  84. o       RA-Monitor may not be licenced or sub-licenced to any third party 
  85.     without written permission of Envy Technologies.
  86. o       This licence agreement may not be modified nor supplemented without 
  87.     written permission of Envy Technologies.
  88. o       Neither Damien Guard nor Envy Technologies are obligated to provide 
  89.     new versions or support for existing versions of RA-Monitor.
  90. o       Although care has been taken to write and test a program that does 
  91.     what this document states, the program is provided as is, without 
  92.     warranty or guarantee of any kind, either expressed or implied, as to 
  93.     the quality or performance of this program, except that RA-Monitor 
  94.     will occupy disk space.
  95. o       Neither the author of RA-Monitor, Damien Guard, nor the publisher, 
  96.     Envy Technologies are responsible for any (direct or indirect) damage 
  97.     or costs, including, but not limited to, lost savings, lost profits 
  98.     and loss of data, which may result from the use or the inability to 
  99.     use RA-Monitor.
  100. o       The RA-Monitor package may not be distributed in a modified form with 
  101.     the exception of other archive formats.  This applies to adverts which 
  102.     may not be included as either a file, nor as a modification to an 
  103.     existing .DIZ informational file.
  104. o       Any BBS/distribution adverts of any kind may only be included in the 
  105.     archive banner.
  106. o       RA-Monitor may be included on shareware CD's and floppy disks 
  107.     providing that any charge levied is for the compilation and not 
  108.     expressly for RA-Monitor.
  109. o       If you use this program, you will constitute your agreement to this 
  110.     disclaimer/license.
  111. o       All rights reserved worldwide.
  112.  
  113. In simple terms: It's free, but it is *ours*.
  114.  
  115.  
  116. Revision history
  117.  
  118. v1.00   24/4/96         Minor path bug fixed
  119.             Added DOS generic timeslicing (should work under NT 
  120.             okay)
  121.             Minor cosmetics + documentation changes
  122. v1.10   14/5/96         Minor fix to correct send note and log off problems 
  123.             on some configurations.
  124.             Mixing keyboard and mouse movements syncronised.
  125.             UserDoes.n support included - must be in RA semaphore 
  126.             dir!
  127. v1.20   13/10/96        Incorrect year field on Node Information screen fixed.
  128.             More than 32768 calls negative figure fixed.
  129.             New DateFormat option in RAMSETUP to choose between
  130.             DD/MM/YY and MM/DD/YY formats.
  131.             RAMSETUP now asks you if you wish to save settings.
  132.             RASTATUS tool from the Monitor/RA Windows-95 project
  133.             now included to allow custom status information.
  134.             New installation program.
  135.  
  136. v1.21   11/05/97        Corrected problems with root semaphore directories.
  137.  
  138.  
  139. Requirements
  140.  
  141. To use RA-Monitor you require:
  142.  
  143. o       An IBM-compatible personal computer with a 286, 386, 486 or Pentium 
  144.     processor.
  145. o       A storage device with approximately 200k free.
  146. o       Approximately 300kb of conventional memory.
  147. o       A copy of RemoteAccess 2.01, 2.02 or 2.50 Shareware, Hobby or 
  148.     Professional configured & working.
  149. o       A DOS session (either MS-DOS/PC-DOS or a VDM provided by Windows, 95, 
  150.     NT or IBM OS/2)
  151.  
  152. A mouse with standard DOS support is highly recommended. 
  153.  
  154.  
  155. Setting up RA-Monitor
  156.  
  157. Unpack or copy the RA-Monitor files contained within this package to a 
  158. directory on your system.  There is no need to place these files in your main 
  159. RA directory nor to be part of your path.
  160.  
  161. Once you have copied the files, RA-Monitor can be run by typing RAMON.  This 
  162. will load the RA-Monitor software with it's preset defaults, described in a 
  163. moment.
  164.  
  165. You can change these settings by using the included RAMSETUP program.  The 
  166. settings are:
  167.  
  168. Refresh Interval (Default: 2 seconds)
  169. This setting determines how often RA-Monitor refreshes the screen.  On systems 
  170. with either a large number of nodes or a slow network, you may need to lower 
  171. this setting to 3-4 to ensure that RA-Monitor runs smoothly.  On systems with 
  172. less nodes (typically less than 20) you can change this setting to 1 second 
  173. to make RA-Monitor more responsive with it's status information.
  174.  
  175. Node Template (Default: '\NODE*N')
  176. This determines where RA-Monitor can find node-specific information about your 
  177. BBS.  This template is appended to the main RA directory name.  These 
  178. directories will be the directory you "CD" into in your batch file before 
  179. running RA with the -N<node> parameter.  
  180.  
  181. If you are not running a multi-line system and you CD into the RA directory 
  182. running RA without the -N<node> paramter, then you will need to ensure this 
  183. field is blank.
  184.  
  185. The *N in this field will expand to the node number in plain decimal with no 
  186. padding.  e.g. The default "\NODE^N" parameter if RA was set to "C:\RA" would 
  187. become C:\RA\NODE1 for node 1, C:\RA\NODE255 for node 255.
  188.  
  189. *N does not have to be the last two characters of this field, templates such 
  190. as \*NLINE would give C:\RA\1LINE for node 1 and C:\RA\255LINE for node 255.
  191.  
  192. Exit Error Level (Default: 0)
  193. This setting tells RA-Monitor what your normal error-level is for exiting 
  194. RemoteAccess.  If you use the -E<level> parameter to launch RemoteAccess then 
  195. you should enter that error-level here.  If you do not use the -E parameter 
  196. with RemoteAccess then this field should be left to it's default of 0.
  197.  
  198. Mouse Support (Default: FULL)
  199. It is recommended that you use a mouse with RA-Monitor to allow movement & 
  200. resizing of the windows it supports.  Unless you are having problems with 
  201. RA-Monitor then leave this parameter on "FULL".  "PARTIAL" will make 
  202. mouse-movements fake keystrokes providing only a basic interface with none of 
  203. the windowing control support and "NONE" will prevent any mouse functions from 
  204. being detected or used.
  205.  
  206. UserDoes Support (Default: IGNORE)
  207. If you set this option to "SHOW" then RA-Monitor will display the ASCII 
  208. contents of the file USERDOES.n (n=node) from the RA semaphore directory on 
  209. the node information screen.  UserDoes files are extended "Node status" files 
  210. which are used by a number of utilities.  They can be created like: 
  211.  
  212. echo Playing Red Dragon > C:\RA\SEMA\USERDOES.%1
  213.  
  214. which you may want to put in a batch file when launching doors etc.  If you 
  215. have no need for this support, just select "IGNORE" (the default anyway) and 
  216. RA-Monitor will behave as if they do not exist.
  217.  
  218. Date Format (Default: English)
  219. This will allow you to choose between two common date formats to be used when 
  220. displaying the date in the Node Information Window within RA-Monitor.  The 
  221. choices are English (DD/MM/YY) and American (MM/DD/YY).  We realise that other 
  222. countries use these formats too but have chosen these names for clarity.
  223.  
  224. RA-Monitor also supports special screen handling which is automatically read 
  225. from the RemoteAccess configuration files.  These are:
  226.  
  227.         Screen writes           Direct/BIOS
  228.         Colour mode             Colour/Mono
  229.         Snow checking           On/Off
  230.         Multitasker             Note: Only "AUTO", "Windows", "OS/2" 
  231.                     and "DESQview" settings are utilised 
  232.                     by RA-Monitor.  All other settings 
  233.                     will disable multitasking.
  234.  
  235. If you wish to change these settings then use RACONFIG.  To change for *just* 
  236. RA-Monitor, copy the CONFIG.RA file from RemoteAccess into your RA-Monitor 
  237. directory then "CD" to the RA-Monitor directory and run RACONFIG as you would 
  238. do for individual node settings.
  239.  
  240.  
  241. Using RA-Monitor
  242.  
  243. The environment
  244.  
  245. RA-Monitor uses a full text-windowing environment to allow the screen to be 
  246. positioned and resized to suit your requirements.  These functions require 
  247. full mouse support and are controlled as follows:
  248.  
  249.     To move a window:       Position the cursor to the top bar of a window 
  250.                 and drag it to the required position using the 
  251.                 left mouse button.
  252.     To close a window:      Some windows have a yellow square block at the 
  253.                 top left-hand side of the window.  Clicking 
  254.                 this with the left mouse button will close 
  255.                 that window.
  256.     To resize a window:     Clicking the bottom-right corner of a window 
  257.                 will allow you to resize it to a more 
  258.                 convenient size.  Simply hold down the left 
  259.                 mouse button and the window will resize as 
  260.                 you move the mouse.
  261.     To scroll a window:     If the contents of the window exceed the size 
  262.                 of the frame in which it is contained, arrows 
  263.                 will appear in the windows frame which allow 
  264.                 you to scroll the viewable area over it's 
  265.                 contents.
  266.  
  267. When you load RA-Monitor, it should display a window on the screen displaying 
  268. the current node status of your screens.  
  269.  
  270.  
  271. Status window
  272.  
  273. This will be automatically centered and auto-size to display as many of your 
  274. nodes as possible.  If you have more nodes than RA-Monitor can fit into the 
  275. display, scroll arrows will appear in the left hand side of the windows frame 
  276. allowing you to scroll the area.  The window will have the title "Status" in 
  277. the top-right corner of the frame.
  278.  
  279. An simple example is shown here:
  280.  
  281. RemoteAccess MONITOR 1.21                                             12:29:51
  282.  
  283.   +--------------------------------------------------------------- Status +
  284.   |  Node  User                  BPS    Location            Status        |
  285.   |    1   Damien Guard              0  Black Ice HQ        Browsing      |
  286.   |    2   [Ready]                   0  InterMail           Ready         |
  287.   |    3   --- Offline ---           0                                    |
  288.   +-----------------------------------------------------------------------+
  289.  
  290. The selection highlight can be moved with either the cursor keys, by selecting 
  291. with the mouse or by pressing numbers 1-9 to jump to a specific node (for the 
  292. first nine nodes only).  By pressing either the mouse button or return you can 
  293. bring up the control window, described in a moment, which can perform 
  294. operations on the selected node.
  295.  
  296. As this tools if for use by a sysop, hidden callers are displayed in this 
  297. list.
  298.  
  299. The fields shown on this screen are: 
  300.  
  301.      Node            BBS node or line for which this information pertains to.
  302.      User            Name of the user currently online or may contain status 
  303.              information if nobody is currently logged into this node.
  304.      BPS             User's login speed or BPS.  This is sometimes incorrectly 
  305.              referred to as baud.
  306.      Location        User's location, or may contain the words 'RemoteAccess' 
  307.              if RA is currently waiting without a user.
  308.      Status          Current activity of the user.  May contain standard 
  309.              entries such as Browsing or File transfer, but can also 
  310.              contain custom entries for doors using the *A option.
  311.  
  312.  
  313. Control window
  314.  
  315. The control window will allow you to view & control your RemoteAccess system 
  316. in conjunction with the node information screen.  The options on this menu 
  317. are:
  318.  
  319.       Node info       Displays detailed node information for the current node 
  320.               using the Node Information window described below.
  321.       Send note       Sends an "Online Note" to the user much the same was as
  322.               RemoteAccess's menu type xx.
  323.       Log off         Logs the user off BBS, exiting RemoteAccess at the error 
  324.               level specified in RAMSETUP.
  325.       BBS info        Displays some information about your BBS using the BBS 
  326.               Information window described below.
  327.       About           Displays credits & version number for RA-Monitor.
  328.       Quit            Exit RA-Monitor and return to DOS.
  329.  
  330. The options can be selected by either the mouse, the cursor keys & return or 
  331. by pressing the first letter of the option.  Note: You can press the first 
  332. letter of the option from the Node Information window even if the Control 
  333. window is not visible/open.
  334.  
  335. The Node info & BBS info options toggle whether their relative window is 
  336. displayed allowing you to display & remove the windows from the keyboard.
  337.  
  338.  
  339. Node Information window
  340.  
  341. The Node Information window displays information about the currently selected 
  342. node.  Note, you can display this window and still move through the Status 
  343. window and it will update to reflect the currently selected node in the 
  344. Status window.  The details are as follows:
  345.  
  346.     Node number     Node for which this information pertains to.
  347.     User name       Name of the user currently using this node.
  348.     User handle     Handle of the user currently using this node.
  349.     Location        Location of the user currently using this node.
  350.     BPS             Connect BPS speed of the caller using this node.
  351.             Note: 0 indicates this call is a LOCAL login.
  352.     User call       Number of times this user has logged into your BBS.
  353.     Currently       User's current activity on this node.
  354.     Hidden user     Whether this user is currently hidden to other 
  355.             callers.
  356.     Paged sysop     Whether this user has paged the sysop using this 
  357.             session.
  358.     No disturb      Whether this user has the "do not disturb" flag set 
  359.             to ignore online notes from other users.
  360.     Exit pending    Whether this node has already been sent a "Log off" 
  361.             code from RA-Monitor and is waiting for RemoteAccess 
  362.             to process it.
  363.     Note pending    Whether this node has been sent a "Online Note" either 
  364.             via RA-Monitor or RemoteAccess that has not yet been 
  365.             read.
  366.     Logged in at    Time and date this user logged in.
  367.     Previous call   Time and date of the most recent logoff of this node.
  368.             Do not confuse with the users previous call.
  369.     User does       If you have UserDoes support enabled in RAMSETUP and 
  370.             there is a valid UserDoes status information for this 
  371.             node, the first 80 characters will be displayed here.
  372.  
  373. NOTE:   Both exit & notes pending will normally occur when the user is in a 
  374. door as RemoteAccess is unable to process them until control has returned to 
  375. RemoteAccess itself.   
  376.  
  377.  
  378. BBS Information window
  379.  
  380. The BBS Information window displays some simple information about your BBS.  
  381. This information is:
  382.  
  383.     Total nodes     Number of nodes that RA-Monitor has detected.
  384.     Total calls     Total number of calls your BBS has received in total.
  385.     Calls today     Number of calls your BBS has received today.
  386.     Last caller     Name of the last caller to log off your system.
  387.  
  388.  
  389. RAStatus
  390. RAStatus is an additional DOS based tool included in this package which allows 
  391. you to modify the RemoteAccess status information which is shown both on 
  392. RA-Monitor and the "Who's Online" function in RemoteAccess.
  393.  
  394. The syntax for this tool is:    RASTATUS /N<node> [options]
  395.                 Where <node> is the node number you wish to 
  396.                 modify.
  397.  
  398. The options are:    /U<user name>           Change 'user name' to this text.
  399.             /H<handle>              Change 'user handle' to this text.
  400.             /B<bps>                 Change 'BPS rate' to this speed.
  401.                         (Use 0 for local, no commas!)
  402.             /L<location>            Change 'users location' to this 
  403.                         text.
  404.             /S<status>              Change 'currently doing' to this 
  405.                         text.
  406.                         (RemoteAccess limitation of 10 
  407.                         characters)
  408.             /C<call>                Change 'times-called' to this 
  409.                         value.
  410.             /D<text>                Write this text to this nodes 
  411.                         userdoes.
  412.             /X                      Clear this node's information.
  413.  
  414. Due to the way DOS works, if you require a name/location etc to have a space 
  415. in it, please use the underscore character '_' - RAStatus will convert this 
  416. to spaces as it updates the status information.
  417.  
  418. Please note that changing these options only affects the online status lists 
  419. and does not modify the users record (for example specifying 
  420.         RASTATUS /N1 /LNot_here 
  421. will only adjust the online list - the user's own Location will remain 
  422. whatever it is set to in RemoteAccess' user database).
  423.  
  424.  
  425. Appendixes
  426.  
  427. Frequently asked questions
  428.  
  429. Q:      The settings in RemoteAccess for screen & multitasking settings are 
  430.     correct for my BBS but I use RA-Monitor on a different machine.  How 
  431.     can I change them?
  432. A:      Copy CONFIG.RA from your RA system directory to RA-Monitor's 
  433.     directory.  CD into RA-Monitor's directory and run RACONFIG.  Adjust 
  434.     the settings in this copy of CONFIG.RA.  RA-Monitor will first use the 
  435.     current directory's CONFIG.RA before searching the RA main directory.
  436.  
  437. Q:      RA-Monitor hangs on my system.
  438. A:      Try disabling mouse support in RAMSETUP.  If this fails use the above 
  439.     answer to create a CONFIG.RA in RA-Monitor's directory and try setting 
  440.     the multitasker to AT BIOS.  If neither of these solutions help, fill 
  441.     in PROBLEM.DOC enclosed in this package and send it to Envy 
  442.     Technologies (contact details in the following section).
  443.  
  444. Q:      RA-Monitor has several "--- Offline ---" lines at the end of the 
  445.     status display list.
  446. A:      Delete your USERON.BBS file from RemoteAccess and log-in to the 
  447.     highest node number your BBS has.  This will rebuild the USERON.BBS 
  448.     file to the correct size so that RA-Monitor can calculate how many 
  449.     nodes your system is capable of running.
  450.  
  451.  
  452. Contacting Envy Technologies
  453.  
  454. There are several ways of contacting Envy Technologies.  They are:
  455.  
  456.     FidoNet:                2:255/78 or 2:255/119 (Damien Guard)
  457.     BBS (UK):               (01481) 37156/37256   (33k6)
  458.     BBS (Internat.):        +44-1481-37156/37256  (33k6)
  459.     Internet:               envy@guernsey.net
  460.  
  461. To recieve the latest versions of Envy Technologies releases:
  462.  
  463.     FidoNet:        FREQ from 2:255/89 or 2:255/119
  464.             RAMON for latest version of RA-Monitor
  465.             ENVY  for list of releases to dates + future releases
  466.     BBS:            Log onto our BBS (numbers listed above) as user GUEST.
  467.             Go into the file menu, select group Official 
  468.             Distribution then file area [Distrib] Envy 
  469.             Technologies.
  470.     Internet:       http://www.guernsey.net/~envy
  471.  
  472.  
  473. Future enhancements
  474.  
  475. Other projects are currently taking priority over RA-Monitor and thefore no 
  476. next release has currently been set.
  477.  
  478.  
  479. Credits & acknowledgements
  480.  
  481. Thanks to Gary Smith at FlightPath for his invaluable RA support, Lake View 
  482. Software for supplying the source code to their DOS windowing libraries, 
  483. Steve Streeting (also part of Envy Technologies) for his help in answering 
  484. many a question on 'C', to Steve Lajoie for providing more WWW/FTP space for 
  485. us at GuernseyNet and to Mike Elhert at PC Micro for his information on 
  486. UserDoes support.
  487.  
  488. Original interface style by JoHo - author of FrontDoor.
  489.  
  490. This product was developed using another Envy Technologies product, the 
  491. "RemoteAccess 'C' Developer Toolkit" which contains the RA 2.50 structs in 
  492. 'C' along with Pascal<>C string copy & conversion macros, CRC-32 routines, 
  493. examples and information.  This package can be FREQ'ed from our FidoNet sites 
  494. using the magic name RACDK, or found at our WWW site.
  495.  
  496. Development tools:      Borland C++ v4.52 / v3.10
  497.             RemoteAccess 'C' Developer Toolkit v0.3
  498.             LVS Windowing Classes (custom version)
  499. Software used:          Windows NT v4.0, RemoteAccess 2.02/sw, RemoteAccess 
  500.             2.02/Pro, RemoteAccess 2.50, Windows Write, X00, 
  501.             DoorWay 2.2, 4-DOS v5.5.
  502.  
  503. Thank-you for using RA-Monitor,
  504.  
  505. [)amien
  506. Damien Guard - Envy Technologies - Sunday 5th May, 1997.
  507.