home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / NODMSG11.ZIP / NODEMSG.DOC < prev    next >
Text File  |  1995-07-04  |  20KB  |  500 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.   ─════════════════════════════════════════════════════════════════════════─
  7.                               - NodeMsg 1.01 -
  8.              (c)Copyright 1995, Rand Nowell - RaLin Enterprises
  9.                      Another bit of "Cowboy Software!"
  10.   ─═══════════════════════════════════════════════════════════════════════──
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.                            * Table of Contents *
  19.  
  20.                    First Things First..................1
  21.                    System Requirements.................1
  22.                    Installation........................2
  23.                    Registered Only Features............2
  24.                    What's It Do?.......................3
  25.                    Startup Commands....................3
  26.                    Message Editing Window..............4
  27.                    Importing A File....................5
  28.                    Sending The Message.................6
  29.                    Message Format......................6
  30.                    Who's Online Mode...................7
  31.                    Questions/Support...................7
  32.                    Credits.............................8
  33.                    Goodbye.............................8
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.   
  41. Send It!        NodeMsg Version 1.01 - Sysop Manual            Page   1
  42.  
  43.  
  44.  ──═══════════════════════════════════════════════════════════════════════───
  45.                          FIRST THINGS FIRST - LEGAL
  46.  ──═══════════════════════════════════════════════════════════════════════───
  47.  
  48.  
  49.   NODEMSG is released as a functional Shareware program, this is
  50.   the Evlauation version.  The only items that are not available
  51.   in UnRegistered mode are 'NICE TO HAVE FEATURES'.
  52.  
  53.   You are encouraged to distribute this copy of NODEMSG to other
  54.   locations.
  55.  
  56.   You do not have the right to Hack, Corrupt, reverse engineer the
  57.   programs code, nor modify the documentation.
  58.  
  59.   The author is in no way obligated to release further versions, nor
  60.   obligated to implement requested features in any version.
  61.  
  62.   You are freely given the right to USE this version, you are not
  63.   given the ownership of the program.
  64.  
  65.   No warranties are expressed or implied, you use it at your own risk,
  66.   if it in any way damages files or system, you and you alone are
  67.   responsible, and own the whole shootin match.
  68.  
  69.   Your use of NodeMsg implies your consent to the above terms and
  70.   conditions.
  71.  
  72.   That being said, NodeMsg should not cause you any problems.
  73.  
  74.                             * * * * * * * * * *
  75.  
  76.   Version 1.0 was released mainly to preview what would be available
  77.   with the upcomming RASIS 2.02 release package.
  78.  
  79.   I decided to release version 1.01 to the public, in evlauation
  80.   format, you can register it as a seperate program, or receive the
  81.   Registration Code 'FREE' when you register RASIS.
  82.  
  83.   !!!!
  84.   Currently registered RASIS users can obtain the NODEMSG registration code
  85.   either FREE, or at a substanial savings, depending on which RASIS version
  86.   you registered.  See NODREG.INF
  87.  
  88.                             * * * * * * * * * *
  89.  
  90. ──═══════════════════════════════════════════════════════════════════════───
  91.                             SYSTEM REQUIREMENTS
  92. ──═══════════════════════════════════════════════════════════════════════───
  93.  
  94.   NodeMsg requires about 75k of free memory at runtime. More is better.
  95.  
  96.   The RA environment variable must be set, this is used to find the
  97.   location of CONFIG.RA, from which the location of your semaphore
  98.  
  99.                                                     
  100.  
  101.  
  102. Send It!        NodeMsg Version 1.01 - Sysop Manual            Page  2
  103.  
  104.   files is taken.
  105.  
  106.   A color monitor is highly reccomended, but it should work ok on mono.
  107.  
  108.   Multi-Tasking envronments are supported.
  109.  
  110.   NodeMsg has been developed and tested under DOS 6.22, DesQview 7.5,
  111.   RA 2.02 and 2.5/Beta, FD 2.20mL, all multi-tasking under
  112.   Windows 4 WorkGroups 3.11.
  113.  
  114.   A Windows PIF file, and ICON have been provided if you wish to use them.
  115.   You should load and edit the NODEMSG.PIF to suit your system.
  116.  
  117.                             * * * * * * * * * *
  118.  
  119. ──═══════════════════════════════════════════════════════════════════════───
  120.                                 INSTALLATION
  121. ──═══════════════════════════════════════════════════════════════════════───
  122.  
  123.  
  124.   TO USE NODEMSG YOU SHOULD FILL IN THE SEMAPHORE PATH IN CONFIG.RA, EVEN
  125.   IF YOU ARE RUNNING ONE NODE, OR EVEN IF YOU NORMALLY HAVE IT BLANK, TO
  126.   USE THE RA SYSTEM DIRECTORY.
  127.  
  128.   !!!!
  129.   At present NodeMsg does not do any "smart" interpetation of the
  130.   CONFIG.RA semaphore path, please fill it in, or the results may
  131.   be less than satisfying.
  132.  
  133.   NodeMsg should be placed in a PATH directory, so it may be called
  134.   from anywhere.
  135.  
  136.   The import files HINEW and HOLDON must be placed in the same directory
  137.   as NODEMSG.EXE
  138.  
  139.   NodeMsg gives up TimeSlices to OS/2, Windows, DV... so you should
  140.   be able to run in these Multi-Task environments.
  141.  
  142.                             * * * * * * * * * *
  143. ──═══════════════════════════════════════════════════════════════════════───
  144.                           REGISTERED ONLY FEATURES
  145. ──═══════════════════════════════════════════════════════════════════════───
  146.  
  147.   The following features are only available when running in Registered
  148.   Mode:
  149.          1.  Who's Online - <G>oto Node
  150.          2.  Command Line: Send <node> <file> and Send <ALL> <File>
  151.          3.  Editor:  F3: Import Specific File
  152.  
  153.   Once you receive your Registration Code/File, these features will
  154.   be unlocked.
  155.  
  156.  ──═══════════════════════════════════════════════════════════════════════───
  157.                                WHAT'S IT DO ?
  158.  ──═══════════════════════════════════════════════════════════════════════───
  159.  
  160.                                                     
  161.  
  162.  
  163. Send It!        NodeMsg Version 1.01 - Sysop Manual            Page  3
  164.  
  165.  
  166.   NodeMsg will allow you to send an online message to a user on any node.
  167.   An editing window is presented, where you enter the message.  After
  168.   typing you are asked what node to send to.  Messages may also be
  169.   imported into the editor via Function Key Commands, 2 predefined filenames,
  170.   and one for importing any file.
  171.  
  172.   Messages can be sent from the DOS prompt, it can be run from Windows,
  173.   DV, or most any other multi-tasking environment.
  174.   Below is a walk through  of the procedure.
  175.  
  176.   It writes a file to the defined Semaphore Directory in CONFIG.RA,
  177.   these files would be named NODE###.RA where # can be from 1 to 255,
  178.   and is given by you when prompted for the node to send the message to.
  179.  
  180.   A little explanation on Semaphore Files:
  181.   If you're not familiar with this procedure, RA scans the defined
  182.   semaphore directory every few seconds for specific files. When one
  183.   of these is found, RA takes certian action, depending on what file
  184.   is found.  Some are 0 byte files, and RA just checks if they exist,
  185.   if they do it performs an action, or closes down.  In the case of
  186.   the above mentioned files, it reads it for content, then displays
  187.   that content to the user on the specified node.
  188.  
  189.   When RA fires up, any existing NODE*.RA files (for the starting node)
  190.   are erased.  This is why you can use the NODEMSG SEND ALL <filename>
  191.   even if say only 3 nodes out of 6 actually have callers.  NodeMsg
  192.   will create 6 files, but of course only the three active will see them.
  193.   But the next time ANY of the 6 nodes fire up, RA will delete that
  194.   nodes Online Message File.  So you don't have to worry about the
  195.   wrong user(s) getting the old message.
  196.  
  197.  ──═══════════════════════════════════════════════════════════════════════───
  198.                               STARTUP COMMANDS
  199.  ──═══════════════════════════════════════════════════════════════════════───
  200.  
  201.     NODEMSG ?    - Display help screen
  202.  
  203.     NODEMSG      - Alone puts you in the Who's Online screen.
  204.                    You can scroll through the nodes, Send message, Quit.
  205.  
  206.     NODEMSG WHO  - Same as above.
  207.  
  208.  
  209.     NODEMSG TEST - Goes through all the motions of sending a message,
  210.                    but does not actually send it, rather dumps it to the
  211.                    screen. Only the message TEXT is dumped.
  212.  
  213.     NODEMSG SEND - Puts you directly into the message editor.
  214.  
  215.     NODEMSG SEND <node> <filename>  {+}
  216.                    Will post specified file to specified Node.
  217.  
  218.     NODEMSG SEND ALL <filename>     {+}
  219.                    Will post the specified file to ALL avaialble nodes.
  220.  
  221.                                                     
  222.  
  223.  
  224. Send It!        NodeMsg Version 1.01 - Sysop Manual            Page  4
  225.  
  226.  
  227.  
  228.    Command Line Use - Send to one or more Nodes.
  229.  
  230.      With NodeMsg you can send an online message from the DOS prompt,
  231.      or from a batch file, using variations of the SEND command.
  232.      This is a Registered Only function.
  233.  
  234.  
  235.  ──═══════════════════════════════════════════════════════════════════════───
  236.                            MESSAGE EDITING WINDOW
  237.  ──═══════════════════════════════════════════════════════════════════════───
  238.  
  239.      NodeMsg allows up to 3800 characters, or about 25 lines of 70+
  240.      characters to be entered.  You will see in the upper right corner,
  241.      a counter, showing you how many characters are left that you can enter.
  242.  
  243.      When you press ENTER to move down to the next line, it's TWO characters
  244.      stored in the buffer (carriage return + linefeed).
  245.      If your lines are less than 70 chars, you can get more lines in a
  246.      message....
  247.  
  248.      Editing Keys:
  249.       This particular "editor" is rather limited.  There is no Up/Dn cursor
  250.       movement, no Home/End etc.
  251.  
  252.       The BackSpace key is honored <on the current line>, if you make a
  253.       mistake, be sure its corrected before you move to the next line.
  254.       Backspacing will NOT move up to the previous line... (yet)
  255.  
  256.       The TAB key inserts 8 spaces, tabbing to the right.
  257.  
  258.       The ESC key tells NodeMsg you are done editing, and will prompt you
  259.       for the node to send to.  If called from the Who's Online window, the
  260.       default will be the node you were viewing.  Pressing ESC again, or
  261.       entering zero (0), or pressing ENTER on a blank field, will abort
  262.       sending the message.
  263.  
  264.       If no message text has been entered, pressing ESC will immediatly
  265.       return to the Who's Online window.
  266.  
  267.       Word Wrap - A very SIMPLE word wrap is included, if you type a space
  268.       within a certian column number range, the cursor will move down to the
  269.       beginning of the next line.  But you can continue typing right up to
  270.       the windows border, and it will move down, but you will have no
  271.       automatic splitting of words......
  272.  
  273.       Like I said, a very SIMPLE editor.
  274.  
  275.       You can use ANY key on the keyboard, you can also enter in RA text,
  276.       user, etc. codes.....  For instance, to enter in, and have displayed,
  277.       the users first call, you would want the code ^F4, you would enter
  278.       that by pressing Ctl-F then 4.  When RA displays the msg to the user,
  279.       it will expand the code into the date of first call.
  280.  
  281.  
  282.                                                     
  283.  
  284.  
  285. Send It!        NodeMsg Version 1.01 - Sysop Manual            Page  5
  286.  
  287.       Keep in mind that RA code expansion will move message text to the
  288.       right when displayed.  Allow room for the expansion.
  289.  
  290.       You can also enter RA color codes in the message, they are activated
  291.       when RA displays the message.
  292.  
  293.      Help:
  294.        At the moment, no online help is available. Only a couple
  295.        of ways to go, you should have no problem memorizing the keys
  296.        quickly....
  297.  
  298.  
  299.  ──═══════════════════════════════════════════════════════════════════════───
  300.                               IMPORTING A FILE
  301.  ──═══════════════════════════════════════════════════════════════════════───
  302.  
  303.         When the editor fires up, it checks the FIRST key you press,
  304.         if it's an Import Command key, it will proceed as such.
  305.         If not, it goes into Edit mode.
  306.  
  307.         The command keys are displayed at the top of the window, they
  308.         are removed when a key is pressed.
  309.  
  310.         Beacuses of checking for an import key, the first keypress in
  311.         the editor is NOT typed to the screen, or buffer.  So if you
  312.         do NOT want to import a file, pressing the SPACEBAR is
  313.         reccomended.
  314.  
  315.         The Import Command Keys:
  316.         F1: Will import a file named HINEW (no extension) it must be located
  317.             in the same directory as NODEMSG.EXE
  318.  
  319.         F2: Will import a file named HOLDON (no extension) it must be located
  320.             in the same directory as NODEMSG.EXE
  321.  
  322.    {+}  F3: Will prompt for a filename to import, same as previous versions.
  323.  
  324.         You can specify a full path+filename.  Or, if the file to import
  325.         is in the same directory as NODEMSG.EXE, you can simply provide
  326.         the filename itself.
  327.  
  328.         If you create a text file for import, remember, you should have no
  329.         more than 54 lines (of 70 chars, less chars = more lines).
  330.         Each line should be 70 characters or less, and should end with a
  331.         Carriage Return.  See the sample files provided.
  332.  
  333.         No editing of, additions to, the imported file is allowed.
  334.         (not yet anyway)
  335.  
  336.         NOTE: If you have created the import file in an ascii editor, and
  337.               included RA color/info codes, the message may display a
  338.               bit sloppy in the window, but it will display correctly to
  339.               the user, at least tests show that it does.
  340.               Try importing, and sending to a node that does not exist,
  341.               then view the NODE###.RA file in the semaphore directory.
  342.  
  343.                                                     
  344.  
  345.  
  346. Send It!        NodeMsg Version 1.01 - Sysop Manual            Page  6
  347.  
  348.               Other than being out of alignment due to the inserted RA
  349.               codes, it should appear normal.  A better test, is logon
  350.               locally, shell out (ALT-J), run NodeMsg, send message,
  351.               to the local node, exit back to the board, and see what
  352.               it looks like.
  353.  
  354.               For messages that are longer than 20 lines, you should
  355.               include a <Press Enter> prompt or two, else it will scroll
  356.               right past the users screen.  Use the RA Ctl-A "Wait for Enter"
  357.               macro after the prompt.  It is fully supported in these
  358.               OnLine messages....
  359.  
  360.               Remember, NodeMsg adds about 3 lines BEFORE your message,
  361.               and about 2 lines AFTER. "Paginate" your LONG messages
  362.               accordingly.
  363.  
  364.  
  365.  ──═══════════════════════════════════════════════════════════════════════───
  366.                             SENDING THE MESSAGE
  367.  ──═══════════════════════════════════════════════════════════════════════───
  368.  
  369.         Once you have imported a file, you are taken right to the
  370.         "Send to Node:" prompt.
  371.  
  372.         When manually entering a message, press ESC.
  373.  
  374.         You will be prompted for the node to send to.
  375.         Acceptable node numbers are from 1 to 255.
  376.  
  377.      NOTE:  If you have entered the message editor from the Who's Online
  378.             screen, then....
  379.             Part of the Who's On screen remains visible, showing the node
  380.             callers Name and Handle, and the Node Number, that was
  381.             being displayed when you chose Send. Just to help you
  382.             remember who you wanted to send to.... <g>
  383.  
  384.  
  385.         You are also placed at this prompt if while importing a file,
  386.         or typing a message, the message buffer becomes full.
  387.  
  388.                             * * * * * * * * * *
  389.  
  390.  ──═══════════════════════════════════════════════════════════════════════───
  391.                                MESSAGE FORMAT
  392.  ──═══════════════════════════════════════════════════════════════════════───
  393.  
  394.      The message sent to the user follows the below format, by default, the
  395.      text you enter is in Green Color, unless you use a ^K[## RA code to
  396.      change it in the message. The Header and Prompt colors are defined in
  397.      the program, and cannot be changed.
  398.  
  399.      Message To: <UserName> from The Sysop via NodeMessage 1.0
  400.      ──────────────────────────────────────────────────────────────────────
  401.        Your message to user goes in here.....
  402.        And so on.....
  403.  
  404.                                                     
  405.  
  406.  
  407. Send It!        NodeMsg Version 1.01 - Sysop Manual            Page  7
  408.  
  409.        And so on.....
  410.        And so on.....
  411.  
  412.      « Press ENTER »
  413.  
  414.  
  415.  ──═══════════════════════════════════════════════════════════════════════───
  416.                              WHO'S ONLINE MODE
  417.  ──═══════════════════════════════════════════════════════════════════════───
  418.  
  419.  
  420.       When you use the WHO command, or no command, at Startup, you are taken
  421.       to the Who's Online display.  Information for Node 1 caller is
  422.       displayed.
  423.  
  424.       Quite a bit of info is displayed, and as of Version 1.01, support
  425.       is included for USERDOES files.  These files are created by some
  426.       Door programs, giving extended information about the users current
  427.       activity.  If this file, for the currently viewed node, is found,
  428.       its contents are displayed, in Wrapped Format, on the last two lines
  429.       of the Who's Online window.
  430.  
  431.       NodeMsg first checks the defined Semaphore directory, then the
  432.       System directory. If no USERDOES file is found for the node, it
  433.       displays a message to that effect.
  434.  
  435.       If no one is one that node, it will say ** Waiting For Call **
  436.  
  437.       You can move through the nodes, using the HotKeys provided.
  438.  
  439.       <N>ext      - will display the next Node information
  440.       <P>revious  - will display the previous Node
  441.      ** Arrow keys will also move through the nodes. Displayed on screen. **
  442.   {+} <G>oto Node - will prompt for a node to display.
  443.       <S>end      - will put you in the Online Message Editor
  444.       <Q>uit      - will exit the program to Dos.
  445.  
  446.       When you choose <S>end, the current Node Number being displayed is
  447.       stored, and when you are ready to actually send the message from the
  448.       editor, the prompt field will already have that number in it.
  449.       Simply press ENTER to send out to that node.
  450.  
  451.                             * * * * * * * * * *
  452.  
  453.  ──═══════════════════════════════════════════════════════════════════════───
  454.                              QUESTIONS/SUPPORT
  455.  ──═══════════════════════════════════════════════════════════════════════───
  456.  
  457.      I can be reached at FIDO 1:215/70, you will need to POLL for your
  458.      reply. No crash returns.  (unless Registered)
  459.  
  460.      Also you can message me in the RA_UTIL echo, or logon and leave me
  461.      a message.
  462.      BBS: The RaLin Software BBS - 510-226-7731
  463.  
  464.  
  465.                                                     
  466.  
  467.  
  468. Send It!        NodeMsg Version 1.01 - Sysop Manual            Page  8
  469.  
  470.      I can also be reached Voice at 510-651-6177, if Im not in, and you
  471.      request a return call, and you are not registered, it WILL be collect!!
  472.  
  473.  ──═══════════════════════════════════════════════════════════════════════───
  474.                           CREDITS AND SALUTATIONS
  475.  ──═══════════════════════════════════════════════════════════════════════───
  476.  
  477.      I wish to thank Bob DaCastello of LlanoWare, for some great
  478.      suggestions.
  479.  
  480.      Also thanks to Mike Elhert for running ver 1.01 through a few tests.
  481.  
  482.      RemoteAccess : Andrew Milner - Wantree
  483.  
  484.      Programmed under TP/BP 7.0 - Borland
  485.  
  486.      Any other programs mentioned are (c)Copyright by their respective
  487.      authors.
  488.  
  489.      Coding and Documentation by Rand Nowell - RaLin Enterprises
  490.      Home of "Cowboy Software!"
  491.  
  492.  ──═══════════════════════════════════════════════════════════════════════───
  493.                                   GOODBYE!
  494.  ──═══════════════════════════════════════════════════════════════════════───
  495.     Watch for RASIS 2.01 - Stuff you have to see to belive. <G>
  496.  
  497.     Enjoy NodeMsg, been fun here!
  498.                                                                  
  499.  
  500.