home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / modem / atplus11.zip / ATPLUS.DOC < prev    next >
Text File  |  1993-10-03  |  20KB  |  462 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.               ┌───────────────────────────────────┐
  25.               │  ╒═════════════════════════════╕  │▒▒
  26.               │  │         ATPlus.Exe          │  │▒▒
  27.               │  │        Version  1.1         │  │▒▒
  28.               │  │  ─────────────────────────  │  │▒▒
  29.               │  │   (c) 1993 Alien Archives!  │  │▒▒
  30.               │  │     All Rights Reserved     │  │▒▒
  31.               │  ╘═════════════════════════════╛  │▒▒
  32.               └───────────────────────────────────┘▒▒
  33.             ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
  34.  
  35.                  October 03, 1993
  36.  
  37.  
  38.  
  39.     ╒════════════════════════════════════════════════════════════════════════╕
  40.     │▒▒▒ Introduction ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  41.     ╘════════════════════════════════════════════════════════════════════════╛
  42.  
  43.       The purpose of ATPlus is to send commands directly to a modem from the
  44.       DOS command line. The program will send AT "Plus whatever you tell it"
  45.       to your modem.
  46.  
  47.       The program will read the necessary information from its configuration
  48.       file, or directly via command line switches.  (You can always override
  49.       the configuration file via the command line if you wish.)
  50.  
  51.       This can be handy if you've got a single command to send to your modem
  52.       often and do not want to be bothered loading up your favorite terminal
  53.       program to do it. Works great in batch files too!
  54.  
  55.  
  56.  
  57.     ╒════════════════════════════════════════════════════════════════════════╕
  58.     │▒▒▒ What it does ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  59.     ╘════════════════════════════════════════════════════════════════════════╛
  60.  
  61.       ATPlus will send any command you like to a Hayes compatible modem. You
  62.       can use a configuration file to store default values, (which is useful
  63.       if you are sending the same command most of the time),  or you can use
  64.       the command line to enter values. You can always override the defaults
  65.       you set in the configuration file via the command line.
  66.  
  67.       The program will execute simple commands (such as taking the line "off
  68.       hook") and simply return the "OK" returned from the modem, or in cases
  69.       where you want to enter a more specialized command (such as having the
  70.       modem display NVRAM settings) you can instruct the program to give you
  71.       a verbose listing of the modem results that are returned.
  72.  
  73.       The program can be operated with, or without a FOSSIL driver loaded.
  74.  
  75.       ATPlus returns ERRORLEVELS as follows:
  76.  
  77.       255 = unspecified error (error code will be displayed)
  78.       255 = invalid screen mode (will be specified)
  79.       255 = no timer available (will be specified)
  80.       121 = FOSSIL initialization failure - FOSSIL not loaded
  81.       120 = FOSSIL initialization failure - wrong baud rate specified
  82.       119-110 = invalid value specified (error will be specified)
  83.       109 = configuration file not found (and no command was specified)
  84.       102 = program terminated - modem returned "ERROR"
  85.       101 = program terminated - key pressed to abort
  86.      80-1 = operating error (error will be specified)
  87.         0 = normal program termination
  88.  
  89.       If an error occurs ATPlus will display the specific error to you so it
  90.       can be easily identified and corrected.
  91.  
  92.  
  93.  
  94.     ╒════════════════════════════════════════════════════════════════════════╕
  95.     │▒▒▒ What it needs ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  96.     ╘════════════════════════════════════════════════════════════════════════╛
  97.  
  98.       The program will operate on an IBM (or compatible) PC with an 80286 or
  99.       higher CPU; DOS 3.0 (or above); and approximately 64,000 bytes of free
  100.       RAM. This is a text mode application, so graphics capabilities are not
  101.       required.  Note: If you run this on less than an AT (ie 80286) it WILL
  102.       hang your system.
  103.  
  104.  
  105.  
  106.     ╒════════════════════════════════════════════════════════════════════════╕
  107.     │▒▒▒ Command line options ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  108.     ╘════════════════════════════════════════════════════════════════════════╛
  109.  
  110.       There are a number of command line options. The program will first try
  111.       to open its configuration file (which must be named ATPLUS.CFG) in the
  112.       current directory, and if it is not found there, your DOS PATH will be
  113.       searched for the file.  If the configuration file is found, the values
  114.       in the file will be loaded (replacing the internal default values). If
  115.       a conflicting command is entered on the command line, it will be taken
  116.       over the configuration file. Hint: By placing both the program and its
  117.       configuration file in a directory that is in your PATH statement,  you
  118.       will be able to execute the program from any directory on your system.
  119.  
  120.       The command line options available are as follows:
  121.  
  122.  
  123.     (a) -P[Port]  --  default value = 1
  124.  
  125.         This is the base address of the port your modem is connected to.
  126.         If you are operating in FOSSIL mode, and you have *NOT* remapped
  127.         the ports, then ATPlus will compensate for the port address. (ie
  128.         if the modem is on COM1 and you are using a FOSSIL then you have
  129.         probably told the FOSSIL to use Port 0.  In this case, you would
  130.         tell ATPlus to use Port 1, and the necessary adjustments will be
  131.         made for you.
  132.  
  133.         Valid values for -P are 1-4.
  134.  
  135.  
  136.     (b) -I[IRQ]  --  default value = 0 (standard IRQ for Ports 1-4)
  137.  
  138.         This specifies which interrupt to use for the port selected. For
  139.         COM1 & COM3 the default interrupt that will be used is IRQ4, and
  140.         for COM2 & COM4 the default that will be used is IRQ3. If you're
  141.         using a port with a non-standard IRQ, use this option to specify
  142.         which IRQ is to be used. Note: You should be very careful before
  143.         you override the default values here,  as you may cause problems
  144.         with other devices in your system.
  145.  
  146.             The following lists the default interrupts used:
  147.  
  148.               COM        Base Address        IRQ (Default)
  149.  
  150.                1           3F8  hex              4
  151.                2           2F8  hex              3
  152.                3           3E8  hex              4
  153.                4           2E8  hex              3
  154.  
  155.         Valid values for -I are 0 (use IRQ default for Port) to 15.
  156.  
  157.  
  158.     (c) -L[Word Length]  --  default value = 8
  159.  
  160.         This specifies the word length of the serial data.
  161.  
  162.         Valid values for -L are 7 or 8.
  163.  
  164.  
  165.     (d) -T[Parity]  --  default value = 0
  166.  
  167.         This specifies the parity to use. It can be  NONE (0),  ODD (1),
  168.         or  EVEN (2).
  169.  
  170.         Valid values for -T are 0-2.
  171.  
  172.  
  173.     (e) -B[Baud Rate]  --  default value = 1200
  174.  
  175.         This specifies the baud rate to be used for the port.  If a rate
  176.         of 0 is specified the port will be used "AS-IS". This will leave
  177.         the baud rate, parity, and word length unchanged. That might NOT
  178.         be the case if you were operating the program in FOSSIL mode (as
  179.         this is an undefined condition in the FOSSIL specification),  so
  180.         it is always best to provide a speed.
  181.  
  182.         Valid values for  -B  are 0, 300, 1200, 2400, 4800, 9600, 19200,
  183.         38400, 57600, and 115200. (Note: 57600 & 115200 not supported if
  184.         you are using the program in FOSSIL mode.)
  185.  
  186.  
  187.     (f) -H[Handshake]  --  default value = 0
  188.  
  189.         This specifies the type of handshake you want to use between the
  190.         CPU and the port (modem). You can select NONE (0), XON/XOFF (1),
  191.         CTS/RTS (2), or XON/XOFF and CTS/RTS (3).
  192.  
  193.         Valid values for -H are 0-3.
  194.  
  195.  
  196.     (g) -F[FOSSIL Mode]  --  default value = 0
  197.  
  198.         This specifies whether or not you will be using a FOSSIL driver.
  199.  
  200.         Valid values for -F are 0 (no FOSSIL), or 1 (with FOSSIL).
  201.  
  202.  
  203.     (h) -C[Modem Command]  --  no default value
  204.  
  205.         This is the command you would like ATPlus to send to your modem,
  206.         and it can be any valid command. The "AT" prefix is added to the
  207.         command automatically, so you only need to enter the actual com-
  208.         mand. If you are going to enter a command (such as one to return
  209.         the modem's NVRAM settings) that will generate a response great-
  210.         er than "OK" from the modem, you must make sure that you set the
  211.         -V(erbose) switch to 1 in order to get the proper display. There
  212.         cannot be any spaces in the command you enter (ie H 1 will *NOT*
  213.         work, but H1 will).
  214.  
  215.         Valid values for -C are any valid modem commands.
  216.  
  217.  
  218.     (i) -V[Verbose]  --  default value = 0
  219.  
  220.         This tells ATPlus how it should display the modem response. If a
  221.         command will only result in an "OK" message from the modem, then
  222.         the default mode (verbose OFF) is appropriate. In this mode your
  223.         command is sent to the modem,  and ATPlus waits for the modem to
  224.         respond with "OK". If there is no response from the modem within
  225.         8 seconds, or if a key is pressed to abort the process, then the
  226.         port will be closed and ATPlus will terminate.
  227.  
  228.         If you are going to give the modem a command that will result in
  229.         more than an "OK" message (or no "OK" message as would result if
  230.         you were using ATPlus to dial a number),  then you would set the
  231.         verbose mode ON. In this mode your command is sent to the modem,
  232.         and ATPlus will display the entire results from the modem rather
  233.         than waiting for an "OK" to be returned. Just like the OFF mode,
  234.         if a key is pressed the port will be closed and the program will
  235.         terminate.  ATPlus will also monitor the time in this mode,  but
  236.         instead of waiting 8 seconds, it will wait 10 seconds. (This may
  237.         be needed to give the modem time to finish sending the requested
  238.         data.) This mode can be used with commands that will only result
  239.         in an "OK" message, however, the display will not be as "clean",
  240.         and the additional timeout delay is wasteful. (Hint: Output from
  241.         the program can be redirected using DOS redirection. This can be
  242.         a handy way to save results to a file for later reference.)
  243.  
  244.             If you are going to use the program in a BATch file, you can set
  245.             the verbose mode to BATCH. In this mode ATPlus will suppress the
  246.             display unless an error occurs.
  247.  
  248.         Valid values for -V are 0 (OFF), 1 (ON), and 2 (BATCH).
  249.  
  250.  
  251.       The command line is not case sensitive (ie -p is the same as -P),  and
  252.       options do not have to be given in a specific order.  You must include
  253.       the leading dash ("-") before each switch,  and the value entered must
  254.       follow the switch immediately. (Eg: -p2 is acceptable but -p 2 isn't.)
  255.  
  256.       All of the options here can be entered in a configuration file so that
  257.       none need to be specified on the command line when you run the program
  258.       unless you want to override one or more of the values. The configurat-
  259.       ion file MUST be named ATPLUS.CFG and it must either be in the current
  260.       directory,  or in a directory listed in your DOS PATH statement (refer
  261.       to your DOS manual for details on the PATH statement if needed).
  262.  
  263.       The configuration file is a plain ASCII text file, nine (9) lines long
  264.       with one option per line. All options must start at the beginning of a
  265.       line, with no leading spaces. The order of the file DOES matter (refer
  266.       to the sample configuration file that was included in the archive).
  267.  
  268.  
  269.         The order of the configuration file is as follows:
  270.  
  271.            Line No.     Option                Example
  272.  
  273.           Line 1 -->  Modem Command              H1
  274.           Line 2 -->  Port                       1
  275.           Line 3 -->  IRQ                        0
  276.           Line 4 -->  Word Length                8
  277.           Line 5 -->  Parity                     0
  278.           Line 6 -->  Baud Rate                  1200
  279.           Line 7 -->  Handshake                  0
  280.           Line 8 -->  FOSSIL Mode                0
  281.           Line 9 -->  Verbose Mode               0
  282.  
  283.  
  284.       Below you will see a few sample command lines, (with an explanation as
  285.       to how these would run the program).
  286.  
  287.     Eg: ATPlus
  288.  
  289.     (this runs the program using the defaults set in ATPLUS.CFG)
  290.  
  291.  
  292.     Eg: ATPlus -CZ
  293.  
  294.     (this runs the program using the defaults set in ATPLUS.CFG,  but
  295.      overrides the Modem Command in the file and sends ATZ instead)
  296.  
  297.  
  298.     Eg: ATPlus -p3 -i15 -b38400 -c&V -v1
  299.  
  300.     (this runs the program using COM3 & IRQ15 at 38400 baud, with the
  301.      verbose mode on, for the modem command AT&V -- all other options
  302.      are left at the default value)
  303.  
  304.  
  305.  
  306.     ╒════════════════════════════════════════════════════════════════════════╕
  307.     │▒▒▒ What you should have received ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  308.     ╘════════════════════════════════════════════════════════════════════════╛
  309.  
  310.       The following files should have been included in the "AV" stamped file
  311.       ATPLUS11.ZIP you received:
  312.  
  313.  
  314.       ATPLUS.CFG  --  example configuration file
  315.       ATPLUS.DOC  --  documentation in text format
  316.       ATPLUS.EXE  --  the basic executable
  317.       ATPLUS.HST  --  a brief history of versions
  318.       ATPLUS.PRN  --  this file
  319.      FILE_ID.DIZ  --  sample description
  320.      PACKING.LST  --  file list (with size/time details)
  321.       README.1ST  --  any last minute updates
  322.     REGISTER.FRM  --  registration form
  323.       VENDOR.DOC  --  information on distribution
  324.  
  325.  
  326.  
  327.     ╒════════════════════════════════════════════════════════════════════════╕
  328.     │▒▒▒ License ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  329.     ╘════════════════════════════════════════════════════════════════════════╛
  330.  
  331.       ATPlus is being distributed as Shareware. Both the program and its re-
  332.       lated files are copyrighted, and NOT in the public domain, NOR is this
  333.       free software. Ownership is retained by the author.
  334.  
  335.       Under the Shareware concept you are permitted to evaluate software for
  336.       a period of time to determine its usefulness to you.  This also offers
  337.       you a chance to test the software and ensure it will operate as stated
  338.       on your computer. If you continue to use the software after this eval-
  339.       uation period, then you MUST pay for it or remove it from your system.
  340.  
  341.       You are granted a license to use this software for evaluation purposes
  342.       for a period of 30 (thirty) days. After 30 days you must either remove
  343.       the software from your system, or send in the registration fee for the
  344.       program.  The registration fee for ATPlus is $15.00 for non commercial
  345.       users, and $25.00 for commercial users.
  346.  
  347.       For the purpose of this license, commercial includes any use in a "for
  348.       profit" organization (whether or not a profit is being made), and also
  349.       includes any governmental agency or educational institution. (The fees
  350.       stated are in Canadian dollars for Canadian users and U.S. dollars for
  351.       all others.)
  352.  
  353.       Registration is a one time thing.  By registering the program now, you
  354.       are entitled to use any further versions of the program without having
  355.       to pay any additional registration fees. (This remains true even if in
  356.       the future "unlimited updates" are not included in the initial regist-
  357.       ration fee.)
  358.  
  359.       This license applies only to version 1.1 of ATPlus, and will remain in
  360.       effect for one (1) year from the date the program is released or until
  361.       another version is released.  Future versions (if any) may not contain
  362.       the same license as stated here.
  363.  
  364.       ATPlus is NOT crippled in any way. You have received a fully function-
  365.       al version of the program.  Registration merely gives you the right to
  366.       continue using the program legally after the 30 day evaluation period.
  367.  
  368.       You are encouraged to share this program with your friends, and anyone
  369.       else you think might find the program beneficial. Please make sure you
  370.       only pass along the complete set of files. (It would be unfair to give
  371.       anyone an incomplete package, including all the documentation and sup-
  372.       port files.)
  373.  
  374.       Refer to the REGISTER.FRM file for details on how to register, and the
  375.       bonus programs you could receive with your registration.
  376.  
  377.       Please, help support the Shareware concept by registering your copy of
  378.       this program. Remember that even the software used to create this pro-
  379.       gram cost the author hundreds of dollars, not to mention the time that
  380.       was spent developing and testing this software. Your support is needed
  381.       to continue the development of this, and other software programs.
  382.  
  383.  
  384.  
  385.     ╒════════════════════════════════════════════════════════════════════════╕
  386.     │▒▒▒ Warranty ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  387.     ╘════════════════════════════════════════════════════════════════════════╛
  388.  
  389.       THERE IS NONE WHATSOEVER. Every effort has been made to ensure no harm
  390.       will be caused by this program, however, by using it the risk is yours
  391.       entirely. ATPlus is used on a regular basis by the author and found to
  392.       operate as stated, however,  this is NO GUARANTEE that it will work on
  393.       your system. In no event will the author assume ANY responsibility for
  394.       any damages of any kind as a result of your use of this program.
  395.  
  396.       THIS SOFTWARE IS SUPPLIED "AS IS". THERE ARE NO WARRANTIES OF ANY KIND
  397.       EXPRESS OR IMPLIED, INCLUDING THOSE OF MERCHANTABILITY, PERFORMANCE OR
  398.       FITNESS FOR A PARTICULAR PURPOSE.  IN *NO* EVENT WILL ALIEN ARCHIVES!,
  399.       ITS OWNERS, THE AUTHOR, OR ANY AFFILIATES BE LIABLE FOR DIRECT, INCID-
  400.       ENTAL, INDIRECT, SPECIAL,  OR CONSEQUENTIAL DAMAGES (INCLUDING DAMAGES
  401.       FOR LOSS OF PROFITS, BUSINESS INTERRUPTION, LOSS OF DATA AND THE LIKE)
  402.       RESULTING FROM ANY DEFECT IN THIS  SOFTWARE  OR ITS  DOCUMENTATION  OR
  403.       ARISING OUT OF THE USE OF  OR  INABILITY TO USE THIS  SOFTWARE  OR ITS
  404.       DOCUMENTATION EVEN IF THE AFOREMENTIONED HAS BEEN ADVISED OF THE POSS-
  405.       IBILITY OF SUCH DAMAGE.
  406.  
  407.  
  408.  
  409.     ╒════════════════════════════════════════════════════════════════════════╕
  410.     │▒▒▒ Miscellaneous ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  411.     ╘════════════════════════════════════════════════════════════════════════╛
  412.  
  413.       The program was written in Visual Basic for MS-DOS v1.00 (Professional
  414.       Edition), and was written on a 486/33C IBM compatible computer operat-
  415.       ing under MS-DOS 5.0.
  416.  
  417.       Serial I/O routines were provided from QBserial v3.10 by Jeff Sumberg.
  418.  
  419.       Trade names mentioned in this document are the property of their resp-
  420.       ective owners.
  421.  
  422.  
  423.  
  424.     ╒════════════════════════════════════════════════════════════════════════╕
  425.     │▒▒▒ Contacting the author ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  426.     ╘════════════════════════════════════════════════════════════════════════╛
  427.  
  428.       The author can be contacted via one of the following:
  429.  
  430.     --  BBS    : Alien Archives! (905)949-9437 -- HST/v32bis/v42/v42bis
  431.  
  432.     --  FidoNet: 1:259/501
  433.  
  434.     --  IMExNet: 89:480/310
  435.  
  436.     --  Mail   : Mark Allan
  437.              3-2325 Hurontario Street, Suite 173
  438.              Mississauga, Ontario L5A 2E8
  439.              Canada
  440.  
  441.  
  442.  
  443.     ╒════════════════════════════════════════════════════════════════════════╕
  444.     │▒▒▒ Distribution ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  445.     ╘════════════════════════════════════════════════════════════════════════╛
  446.  
  447.       The program may be freely distributed *PROVIDED* it is distributed the
  448.       way it was released, and with all files intact.  You are NOT permitted
  449.       to convert the archive to another format. Only if ATPLUS11.ZIP has the
  450.       "-AV" code from  Alien Archives!  on each file in the ZIP may you dis-
  451.       tribute the file - ANYTHING ELSE IS A COPYRIGHT INFRINGEMENT!  Version
  452.       2.04g of PKZIP was used in creating the original archive.
  453.  
  454.       You may archive the original  ZIP  file "inside" an archive of another
  455.       format if you prefer, but the original file must remain intact.
  456.  
  457.       See the included VENDOR.DOC file for complete details on the terms and
  458.       conditions for distributing this software.
  459.  
  460.     ╒════════════════════════════════════════════════════════════════════════╕
  461.     │▒▒▒ End of Document ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒│
  462.     ╘════════════════════════════════════════════════════════════════════════╛