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