home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / OSXBBS.ZIP / MANUAL.DOC < prev    next >
Text File  |  1991-06-02  |  11KB  |  285 lines
  1.   OS/X User manual - Copyright Giles Rider   1991
  2.  
  3.  
  4.      OS/X is intended for use as a Remote Control tool.  To
  5.      do that, it encompasses five functions as follows:
  6.  
  7.         a.    Dial-up access    to the
  8.         remote machine's command interpreter, giving you
  9.         the ability to execute any OS/2 command (except
  10.          Presentation Manager commands).
  11.  
  12.          b.  File transfer.  (not in BBS version)
  13.  
  14.          c.  Terminal emulation.   (XTERM)
  15.  
  16.          d.  A programmer's editor, designed for use with the
  17.          terminal emulator, that runs on the remote
  18.          system.  (XEDIT)
  19.  
  20.       This version, the BBS version, is a working copy with certain
  21.       limitations. You are encouraged to distribute it, but patching,
  22.       monitoring or dis-assembly and reverse engineering is prohibited.
  23.  
  24.       If you register with the current license fee of $35, you will receive
  25.       the most recent version, and be treated as a registered user for
  26.       Upgrades.  In addition, the version that you get will include the
  27.       configuration file capabilities, which automate modem control and
  28.       allow speeds to 19.2 KB.
  29.  
  30.       For $100, you get all of the above, plus file transfer.
  31.  
  32.       For $150, you get all of the above, plus the security scripting
  33.       package (BYE4).
  34.  
  35.       Source licenses are available.  Site Licenses are available.
  36.  
  37. ###############################################################################
  38.       DISCLAIMER
  39.  
  40.       I hereby disclaim all waranties relating to this software, whether
  41.       express or implied, including without limitation any implied
  42.       warranties of merchantability or fitness for any purpose.  I will
  43.       not be liable for any damages even if I have been advised of the
  44.       possibility of such damages.  The person using the software bears
  45.       all risks as to the quality and performance of the software.
  46. #############################################################################
  47.  
  48.       The BBS version is set up to run OS/X on COM 1 at 2400,8,N,1 and
  49.       to run XTERM on COM2 with the same settings.  This is so that you
  50.       can try it out by hooking the two ports together on one machine, via
  51.       a "null-modem" cable.
  52.  
  53.       You install OS/X on your system, and use XTERM to call
  54.       the remote system.  The remote system must also have OS/X
  55.       installed, so that when you call, its copy of OS/X will
  56.       answer your call to the modem, and connect to the remote
  57.       system.  You will see the OS/2 command prompt appear on your
  58.       screen when connection is established.
  59.  
  60.       Once you are connected, you can use XEDIT (running on
  61.       the remote machine) to edit files, or to execute other
  62.       OS/2 commands.  When you are done, use either the OS/X BYE
  63.       command or the OS/2 EXIT command to terminate OS/X.  BYE
  64.       uses a password-controlled scripting system that allows
  65.       remote execution of programs, while EXIT kills OS/X.
  66.  
  67.       XTERM can also be used as an ANSI terminal emulator to
  68.       dial into bulletin boards or to hook up to other systems.
  69.  
  70.          2.   Getting Started.
  71.  
  72.               a.        Installing OS/X
  73.  
  74.       The OS/X ZIP file has in it a file named
  75.       INSTALL.CMD.  This file creates an OS/X directory on your C:
  76.       drive and copies the Zipfile contents into this directory.
  77.  
  78.       You need to edit your CONFIG.SYS file before using OS/X
  79.       or XTERM, as follows:
  80.  
  81.                   Add a line to the CONFIG.SYS that says:
  82.  
  83.                         IOPL=YES
  84.  
  85.                   This is to enable port access.
  86.  
  87.       Remember that changes to the CONFIG.SYS file require you
  88.       to reboot the system before they take effect.
  89.  
  90.           Hook up your modem to the COM2
  91.           Set the modem so that it
  92.           does not echo, and turn off flow control.
  93.  
  94.  
  95.       3.  Configuring the remote system.
  96.  
  97.            Add a line to the CONFIG.SYS file that says:
  98.  
  99.            IOPL=YES
  100.  
  101.            This is to enable port access.
  102.  
  103.       Remember that you will have to reboot the system before
  104.       this change  take effect.
  105.  
  106.       Connect the modem to COM1.  Set it to Auto-
  107.       answer, and to No-echo. Turn off flow control.
  108.  
  109.       To have OS/X started automatically at boot time, you need
  110.       to set up the STARTUP.CMD file that OS/2 uses when it boots.
  111.       Add this line to STARTUP.CMD:
  112.  
  113.        START "OS/X" /K C:\OSX\OSXB.EXE
  114.  
  115.       Be sure to tell your users not to kill this session, and
  116.       to stay out of it (they can't get in, anyway).
  117.  
  118.       If you don't need to have unattended access to the
  119.       Remote machine, then don't do anything with the STARTUP.CMD
  120.       file; instead have your user start OS/X when you want to
  121.       access the machine.
  122.  
  123.       If you are using Microsoft OS/2 , you can set
  124.       AUTOFAIL=ON to disable error pop-ups on the remote system.
  125.       Adding a call to DosError in your programs is another way to
  126.       disable error popups.
  127.  
  128.       4.   Using  XTERM  to connect to a remote system
  129.  
  130.       At the command line, change directories to C:\OSX.
  131.       Type in XTERM and hit the enter key.
  132.  
  133.       XTERM will connect you to your modem.  If you need to send
  134.       capital letters to your modem, ALT-A toggles XTERM's shift
  135.       status reporting on and off.  Turn it off to set up the
  136.       modem; XTERM starts up with shift reporting turned on.
  137.  
  138.       Once XTERM connects to your user's machine, you will see
  139.       the OS/2 command line displayed.
  140.  
  141.       When the command line is displayed, you can use any OS/2
  142.       command, except for Presentation Manger commands.  Avoid them
  143.       as they will hang the remote system, and you will have to get
  144.       your user to reboot for you.
  145.  
  146.        OS/X provides additional utilities.  XEDIT, discussed in
  147.       the next section, is a text editor that allows you to inspect
  148.       and alter files on the remote system.
  149.  
  150.       XTERM runs as a VT100 (almost) so you are  able to call
  151.       a BBS with it, too.  Remember to use ALT-A to turn off shift
  152.       status reporting.
  153.  
  154.       5.  XDEDIT  - OS/X Programmer's Editor
  155.  
  156.       XEDIT is a full-screen editor, designed for remote
  157.       operation with OS/X. It uses the standard edit commands that
  158.       everyone is familiar with, like up-arrow and down-arrow. It
  159.       reads files in 50,000 byte segments.
  160.  
  161.        Format:    XEDIT <filename>
  162.  
  163.       The commands are:
  164.  
  165.      <Up-arrow>  =    Move the Cursor up one line.
  166.  
  167.     <Down-Arrow> =    Move the Cursor  down one line.
  168.  
  169.        <Home>    =    Move the Cursor to the top of the file.
  170.  
  171.        <End>     =    Move the Cursor to the End of the file.
  172.                            Hit it twice to go on to next segment.
  173.  
  174.        <Del>     =    Delete the character at the Cursor.
  175.  
  176.        <PgUp>    =    Scroll up one page.
  177.  
  178.        <PgDn>    =    Scroll Down one page.
  179.  
  180.        <F8>      =    Quit; will ask you for a filename if the
  181.                            file has been changed.
  182.  
  183.        <Ins>     =    Toggles insert mode; a blue 'I' is
  184.             displayed on the top line of the screen
  185.             when insert mode is on.
  186.  
  187.       <Ctl-RtArrow>  =    Scroll right 16 spaces
  188.  
  189.      <Ctl-LtArrow>  =  Scroll left 16 spaces
  190.  
  191.       Error Messages:
  192.  
  193.  
  194.        Can't Open...    Can't open your file; try again.
  195.  
  196.        Read Error..     Dos Error reading file.. file's bad.
  197.  
  198.        <Beep>...        invalid command.
  199.  
  200.  
  201.       6.       Known Unsolved problems and bugs    05/07/91
  202.  
  203.       XTERM -
  204.  
  205.           Logging records control chars; use Alt-A.
  206.           Logging has a problem with modem echos.
  207.  
  208.       OSX  -  It can't pass a CONTROL-C on to an application to
  209.                      kill it.
  210.           DOS edits don't work on strings.
  211.           VioWrtNCell causes problems.
  212.  
  213.        7.  Miscellaneous technical notes.
  214.  
  215.       OS/X works by intercepting the VIO calls and sending
  216.       them out to a COM port, via the OSXA2.DLL Dynamic Link
  217.       Library.    OS/X only intercepts VIO calls that write to the
  218.       screen, so programs that directly address the Logical or
  219.       Physical screen buffers will not work properly with OS/X.
  220.  
  221.        Vio calls trapped:        Vio calls ignored by OS/X:
  222.  
  223.        1. VioGetConfig        1. VioAssociate
  224.        2. VioGetCurPos        2. VioCreateLogFont
  225.        3. VioScroll         3. VioCreatePS
  226.        4. VioSetCurPos        4. VioDeleteSetID
  227.        5. VioWrtCellStr        5. VioDestroyPS
  228.        6. VioWrtCharStr        6. VioGetBuf
  229.        7. VioWrtCharStrAtt        7. VioGetCP
  230.        8. VioWrtNAttr        8. VioGetDev
  231.        9. VioWrtNCell        9. VioGetDeviceCellSize
  232.       10. VioWrtNChar           10. VioGetFont
  233.       11. VioWrttty            11. VioGetPhysBuf
  234.       12. VioSetCP               12. VioMode
  235.       13. VioSetCurType           13. VioPopup
  236.                        14. VioRead
  237.  
  238.       Keyboard calls are trapped in the same way, and sent to
  239.       the COM port to go to the remote system.    Keyboard calls
  240.       trapped include KbdStrgIn, KdbCharIn, KbdPeek and
  241.       KbdFlushBuffer. Other keyboard calls are ignored by OS/X.
  242.  
  243.       OS/X uses KbdRegister and VioRegister commands to set
  244.       itself up to do this trapping; if your application calls
  245.       either of these API's, trouble is guaranteed.  Either your
  246.       application will fail, or OS/X will die.
  247.  
  248.       Kinds of programs that should work with OS/X include
  249.       most data entry-type applications.  Graphics applications
  250.       usually don't work, because they access the LVB directly,
  251.       rather than by VIO calls.  The same seems to be true of word
  252.       processing programs, so I haven't yet found one that works
  253.       with OS/X. (that's also one reason why I wrote XEDIT...)
  254.  
  255.       OS/X assumes that it is working with XTERM, and sends
  256.       some rather strange character sequences to control XTERM.
  257.       If you are working with some other terminal emulator, or with
  258.       a dumb terminal, use ALT-A (in XTERM) to turn off shift state
  259.       reporting, and run the program YBR.EXE to turn off the remote
  260.       procedure calls that will show up.  OS/X then will sort of
  261.       work with your setup. Let me know what problems appear...
  262.  
  263.       12.   Dumb Terminals
  264.  
  265.       YBR.EXE tells the DLL to use ANSI cursor control, rather than
  266.       the Remote Procedure Calls used by XTERM.
  267.  
  268.       YBR.EXE is a toggle; invoking it a second time turns off
  269.       dumb terminal mode, and turns XTERM mode back on.
  270.  
  271.       While in XTERM mode, OS/X sends lots of strange-looking
  272.       stuff to XTERM. If you start seeing strange stuff, chances
  273.       are you need to run YBR again.
  274.  
  275.        XEDIT won't work with dumb terminals.
  276.  
  277. ;++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  278.  
  279.        Features of the full-scale version not present in the BBS version.
  280.  
  281.       File transfer - with CRC.
  282.       Scripting.
  283.       Configuration files.
  284.       Port Speeds to 19.2
  285.