home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / NODMSG10.ZIP / NODEMSG.DOC < prev    next >
Text File  |  1995-05-20  |  11KB  |  271 lines
  1.   
  2.                                                               
  3.  
  4.                        NodeMsg 1.0 - FreeWare Version
  5.              (c)Copyright 1995, Rand Nowell - RaLin Enterprises
  6.                      Another bit of "Cowboy Software!"
  7.   ──────────────────────────────────────────────────────────────────────────
  8.  
  9.   First things first:
  10.  
  11.   NODEMSG is released as FreeWare, no registration required. You may
  12.   use and distribute as you wish, EXCEPT, that Nodemsg may not be
  13.   bundled with any other software without the authors permission.
  14.  
  15.   You do not have the right to Hack, Corrupt, reverse engineer the
  16.   programs code, nor modify the documentation.
  17.  
  18.   The author is in no way obligated to release further versions, nor
  19.   obligated to implement requested features in any version.
  20.  
  21.   You are freely given the right to USE this version, you are not
  22.   given the ownership of the program.
  23.  
  24.   No warranties are expressed or implied, you use it at your own risk,
  25.   if it in any way damages files or system, you and you alone are
  26.   responsible, and own the whold shootin match.
  27.  
  28.   That being said, NodeMsg should not cause you any problems.
  29.  
  30.                             * * * * * * * * * *
  31.  
  32.   This version is released to preview similar, much improved, functions
  33.   that will be available in the next release of RASIS (2.02).
  34.  
  35.   It's what I used to develop the functions for RASIS, and I decided
  36.   to release a version of the test program.
  37.  
  38.   As this is a Free version, this document does not quite follow my
  39.   normal DOC format. It's kind of slapped together, hope you can make
  40.   some sense out of it.
  41.  
  42.                             * * * * * * * * * *
  43.  
  44.   System Requirements:
  45.  
  46.   NodeMsg requires about 75k of free memory at runtime. More is better.
  47.  
  48.   The RA environment variable must be set, this is used to find the
  49.   location of CONFIG.RA, from which the location of your semaphore
  50.   files is taken.
  51.  
  52.                             * * * * * * * * * *
  53.  
  54.   Installation:
  55.  
  56.   TO USE NODEMSG YOU SHOULD FILL IN THE SEMAPHORE PATH IN CONFIG.RA, EVEN
  57.   IF YOU ARE RUNNING ONE NODE, OR EVEN IF YOU NORMALLY HAVE IT BLANK, TO
  58.   USE THE RA SYSTEM DIRECTORY.
  59.  
  60.                                                     
  61.  
  62.  
  63.                                                               
  64.  
  65.  
  66.   !!!!
  67.   At present NodeMsg does not do any "smart" interpetation of the
  68.   CONFIG.RA semaphore path, please fill it in, or the results may
  69.   be less than satisfying.
  70.  
  71.   NodeMsg should be placed in a PATH directory, so it may be called
  72.   from anywhere.
  73.  
  74.   NodeMsg gives up TimeSlices to OS/2, Windows, DV... so you should
  75.   be able to run in these Multi-Task environments.
  76.  
  77.                             * * * * * * * * * *
  78.  
  79.   What's It Do?
  80.  
  81.   NodeMsg will allow you to send an online message to a user on any node.
  82.   An editing window is presented, where you enter the message.  After
  83.   typing you are asked what node to send to.
  84.   Messages can be sent from the DOS prompt, it can be run from Windows,
  85.   DV, or most any other multi-tasking environment.
  86.   Below is a walk through  of the procedure.
  87.  
  88.   It writes a file to the defined Semaphore Directory in CONFIG.RA,
  89.   these files would be named NODE###.RA where # can be from 1 to 255,
  90.   and is given by you when prompted for the node to send the message to.
  91.  
  92.   A little explanation on Semaphore Files:
  93.   If you're not familiar with this procedure, RA scans the defined
  94.   semaphore directory every few seconds for specific files. When one
  95.   of these is found, RA takes certian action, depending on what file
  96.   is found.  Some are 0 byte files, and RA just checks if they exist,
  97.   if they do it performs an action, or closes down.  In the case of
  98.   the above mentioned files, it reads it for content, then displays
  99.   that content to the user on the specified node.
  100.   When RA fires up, any existing NODE*.RA files (for the starting node)
  101.   are erased.
  102.  
  103.   Startup:
  104.     NODEMSG ?    - Display help screen
  105.     NODEMSG      - Alone puts you in edit/send mode
  106.     NODEMSG WHO  - Allows view of whose online, while viewing, you can
  107.                    go directly to Sending a message, or quit.
  108.     NODEMSG TEST - Goes through all the motions of sending a message,
  109.                    but does not actually send it, rather dumps it to the
  110.                    screen. Only the message TEXT is dumped.
  111.  
  112.    Editing:
  113.      NodeMsg allows up to 700 characters, or about 9 lines of 70+ characters
  114.      to be entered.  You will see in the upper right corner, a counter,
  115.      showing you how many characters are left that you can enter.
  116.  
  117.      When you press ENTER to move down to the next line, it's TWO characters
  118.      stored in the buffer.
  119.      If your lines are less than 70 chars, you can get more lines in a
  120.  
  121.                                                     
  122.  
  123.  
  124.                                                               
  125.  
  126.      message....
  127.  
  128.      Editing Keys:
  129.       This particular "editor" is rather limited.  There is no Up/Dn cursor
  130.       movement, no Home/End etc.
  131.  
  132.       The BackSpace key is honored <on the current line>, if you make a
  133.       mistake, be sure its corrected before you move to the next line.
  134.       Backspacing will NOT move up to the previous line...
  135.  
  136.       Word Wrap - A very SIMPLE word wrap is included, if you type a space
  137.       within a certian column number range, the cursor will move down to the
  138.       beginning of the next line.  But you can continue typing right up to
  139.       the windows border, and it will move down, but you will have no
  140.       automatic splitting of words......
  141.  
  142.       Like I said, a very SIMPLE editor.
  143.  
  144.       You can use ANY key on the keyboard, you can also enter in RA text,
  145.       user, etc. codes.....  For instance, to enter in, and have displayed,
  146.       the users first call, you would want the code ^F4, you would enter
  147.       that by pressing Ctl-F and 4.  When RA displays the msg to the user,
  148.       it will expand the code into the date of first call.
  149.  
  150.      Help:
  151.        At the moment, no online help is available. Only a couple
  152.        of ways to go, you should have no problem memorizing the keys
  153.        quickly....
  154.  
  155.  
  156.      Importing a File:
  157.         CTL-F1 or ALT-F1 will prompt you for a textfile name to import.
  158.         You can specify a full path+filename.  Or, if the file to import
  159.         is in the same directory as NODEMSG.EXE, you can simply provide
  160.         the filename itself.
  161.  
  162.         If you create a text file for import, remember, you should have no
  163.         more than 9 lines (of 70 chars, less chars = more lines).
  164.         Each line should be 70 characters or less, and should end with a
  165.         Carriage Return.  See the sample files provided.
  166.  
  167.         No editing of, additions to, the imported file is allowed.
  168.         (not yet anyway)
  169.  
  170.         NOTE: IF you have created the import file in an ascii editor, and
  171.               included RA color/info codes, the message may display a
  172.               bit sloppy in the window, but it will display correctly to
  173.               the user, at least tests show that it does.
  174.               Try importing, and sending to a node that does not exist,
  175.               then view the NODE###.RA file in the semaphore directory.
  176.               Other than being out of alignment due to the inserted RA
  177.               codes, it should appear normal.  A better test, is logon
  178.               locally, shell out (ALT-J), run NodeMsg, send message,
  179.               to the local node, exit back to the board, and see what
  180.               it looks like.
  181.  
  182.                                                     
  183.  
  184.  
  185.                                                               
  186.  
  187.  
  188.      Sending The Message:
  189.         Once you have imported a file, you are taken right to the
  190.         "Send to Node:" prompt.
  191.         When manually entering a message, press ESC.
  192.         You will be prompted for the node to send to.
  193.         Acceptable node numbers are from 1 to 255.
  194.  
  195.      NOTE:  If you have entered the message editor from the Who's Online
  196.             screen, then....
  197.             Part of the Who's On screen remains visible, showing the node
  198.             callers Name and Handle, and the Node Number, that was
  199.             being displayed when you chose Send. Just to help you
  200.             remember who you wanted to send to.... <g>
  201.  
  202.  
  203.         You are also placed at this prompt if while importing a file,
  204.         or typing a message, the message buffer becomes full.
  205.  
  206.                             * * * * * * * * * *
  207.  
  208.    Message Format:
  209.  
  210.      The message sent to the user follows the below format, by default, the
  211.      text you enter is in Green Color, unless you use a ^K[## RA code to
  212.      change it in the message. The Header and Prompt colors are defined in
  213.      the program, and cannot be changed.
  214.  
  215.      Message To: <UserName> from The Sysop via NodeMessage 1.0
  216.      ──────────────────────────────────────────────────────────────────────
  217.        Your message to user goes in here.....
  218.        And so on.....
  219.  
  220.      « Press ENTER »
  221.  
  222.  
  223.                             * * * * * * * * * *
  224.  
  225.     Who's Online:
  226.  
  227.       When you use the WHO command at Startup, you are taken to the
  228.       Who's Online display.  Information for Node 1 caller is displayed,
  229.       if no one is one that node, it will say ** Waiting For Call **
  230.  
  231.       You can move through the nodes, using the HotKeys provided.
  232.       <N>ext      - will display the next Node information
  233.       <P>revious  - will display the previous Node
  234.       ** The Up arrow will do same as <P>, the Down Arrow same as <N> **
  235.       <S>end      - will put you in the Online Message Editor
  236.       <Q>uit      - will exit the program to Dos.
  237.  
  238.                             * * * * * * * * * *
  239.  
  240.     If I decide to release future Stand Alone versions of NodeMsg,
  241.     I will try to update the editor a bit, to where true editing is
  242.  
  243.                                                     
  244.  
  245.  
  246.                                                               
  247.  
  248.     supported. There will also be some other options that are not now
  249.     available, but probably will be in the RASIS module for this
  250.     program.
  251.  
  252.     I feel that the given 700 characters is enough for online messages,
  253.     but if you feel it should be more, tell me.
  254.  
  255.     Questions:
  256.      I can be reached at FIDO 1:215/70, you will need to POLL for your
  257.      reply. No crash returns.
  258.  
  259.      Also you can message me in the RA_UTIL echo, or logon and leave me
  260.      a message. You can use our guest account, Name: GUEST - no password
  261.      needed.    BBS: The RaLin Software BBS - 510-226-7731
  262.  
  263.      I can also be reached Voice at 510-651-6177, if Im not in, and you
  264.      request a return call, it WILL be collect!!
  265.  
  266.     Watch for RASIS 2.01 - Stuff you have to see to belive. <G>
  267.  
  268.     Enjoy NodeMsg, been fun here!
  269.                                                                  
  270.  
  271.