home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / sysutl / comsnd14.arc / COMSEND.DOC next >
Text File  |  1988-11-08  |  10KB  |  258 lines
  1.                        COMSEND  (Version 1.40)
  2.           (C) Copyright 1988  Venu P. Gopal
  3.                 All Rights Reserved.
  4. -------------------------------------------------------------------------------
  5.  
  6. DISTRIBUTION NOTICE
  7.  
  8. This program may be freely distributed to anyone as long as the documentation 
  9. (COMSEND.DOC) and the program (COMSEND.EXE) are in no way modified (except for
  10. the configuration) and the program and the documentation are distributed
  11. together.
  12.  
  13. -------------------------------------------------------------------------------
  14.  
  15. NAME
  16.  
  17.   comsend - send file(s) over the serial communications line
  18.  
  19. SYNOPSIS
  20.  
  21.   comsend [-options] file1 file2 ...
  22.  
  23. DESCRIPTION
  24.  
  25.   COMSEND is a program that will send files over a communications line
  26.   connected to one of the serial ports (COM1: or COM2:) of the PC.
  27.  
  28.   COMSEND will automatically set up the speed, parity, number of data
  29.   bits and stop bits for the serial port before sending the file(s).
  30.   It can also use flow control.
  31.  
  32.   In addition, COMSEND can go through a sequence of operations
  33.   needed to establish the connection.  This sequence is specified by a
  34.   string of characters called the CONNECT SEQUENCE.
  35.  
  36.   After the connnection is established and the file(s) transmitted,
  37.   COMSEND can go through another sequence of operations to disconnect.
  38.   This sequence is specified by the DISCONNECT SEQUENCE.
  39.  
  40.   If no filename is specified, the standard input is used.  Wildcard
  41.   characters are allowed in filenames.
  42.  
  43. CONFIGURATION
  44.  
  45.   COMSEND needs to be configured to set up the default parameters
  46.   (speed, parity, connect/disconnect sequences etc.). In order to
  47.   configure COMSEND, `cd' to the directory that contains COMSEND.EXE
  48.   and enter
  49.  
  50.     comsend -C
  51.  
  52.   For each parameter, the choices are displayed along with the
  53.   current value. To keep the current value, press the return key.
  54.   To change it, enter a value from the choices displayed.
  55.  
  56.   Configuration cannot be done if COMSEND.EXE file is not in the
  57.   current directory or is READ-ONLY.
  58.  
  59. COMMAND LINE OPTIONS
  60.  
  61.   Any of the configured values may be overridden during execution
  62.   of the program by entering a command line option. For example,
  63.   entering "comsend -b1200 somefile" will use 1200 baud even though
  64.   COMSEND may be configured for 9600 baud.
  65.  
  66.   Available command line options are:
  67.  
  68.   -bxxxx    use baud rate xxxx. xxxx = 110, 150, 300
  69.             600, 1200, 2400, 4800 or 9600
  70.  
  71.   -px       use parity x. x = N, O or E
  72.             N=none, O=Odd parity, E=Even parity
  73.  
  74.   -nx       use x as number of data bits. x = 7 or 8
  75.  
  76.   -sx       use x as number of stop bits. x = 1 or 2
  77.  
  78.   -mx       use serial port COMx:.  x = 1 or 2
  79.  
  80.   -fx       use x as flow control. x=D for DTR/CTS, X for XON/XOFF,
  81.             N for No flow control
  82.  
  83.   -cx..x    use connect sequence x..x. Sequence x..x should not contain
  84.             any spaces - use \s for a space
  85.             (see section on connect/disconnect sequences)
  86.  
  87.   -dx..x    use disconnect sequence x..x. Sequence x..x should not contain
  88.             any spaces - use \s for a space
  89.             (see section on connect/disconnect sequences)
  90.  
  91.   -v        verbose mode: displays incoming characters and additional
  92.             information (see NOTES section)
  93.  
  94.   -C        Configure COMSEND (see CONFIGURATION section)
  95.  
  96. CONNECT/DISCONNECT SEQUENCES
  97.  
  98.   These are two sequences of commands that are to be executed
  99.   in order to establish connection and break the connection.
  100.   These sequences are specified during configuration
  101.   and may be overridden by the -c and -d command line options.
  102.  
  103.   The list of commands available is shown below:
  104.  
  105.  
  106.     t          Toggle DTR (set low (0), delay, set high (1)).
  107.                Delay duration 500 ms unless set by command T (below).
  108.  
  109.     Tnnn       Set DTR toggle time period to nnn X 0.1 seconds.
  110.                'nnn' MUST be a 3 digit number - 000 to 999
  111.                (0 to 99.9 seconds).
  112.  
  113.     b          Send break.
  114.                Duration 200 ms unless set by command B (below).
  115.  
  116.     Bnnn       Set break time period to nnn X 0.1 seconds.
  117.                'nnn' MUST be a 3 digit number - 000 to 999
  118.                (0 to 99.9 seconds).
  119.  
  120.     p          Pause for 0.5 seconds.
  121.  
  122.     P          Pause for 2 seconds.
  123.  
  124.     Dnnn       Pause (delay) for nnn X 0.1 seconds.
  125.                'nnn' MUST be a 3 digit number - 000 to 999
  126.                (0 to 99.9 seconds)
  127.  
  128.     r          Transmit a carriage return over the COM port.
  129.  
  130.     n          Transmit a line feed (newline) over the COM port.
  131.  
  132.     R          Transmit a carriage return followed by a line feed
  133.                over the COM port.
  134.  
  135.     "xx..xx"   Transmit the string in quotes over the COM port.
  136.                The string may contain special characters (\r,\n,
  137.                \" etc. - listed in the next section).
  138.  
  139.     d"xx..xx"  Display the string in quotes on screen.
  140.                The string may contain special characters.
  141.  
  142.     m"xx..xx"  Try to match the characters received over the
  143.                communications line with the string in quotes.
  144.                If the match FAILS, COMSEND issues an error
  145.                message and ends.
  146.                The string may contain special characters.
  147.                The time period over which COMSEND will wait to find
  148.                a match may be set by command M (below).
  149.  
  150.                After a command m, it is a good idea to use a command
  151.                p, P or dnnn followed by a command f to make sure
  152.                that all characters received after the match will
  153.                be read and flushed before the next operation.
  154.  
  155.     Mnnn       Set timeout for the m command to nnn seconds.
  156.                'nnn' MUST be a 3 digit number - 000 to 999
  157.                (0 to 999 seconds). The default is 20 seconds.
  158.  
  159.     q"xx..xx""yy..yy"
  160.                Try to match the characters received over the
  161.                communications line with the first quoted string.
  162.                If the match SUCCEEDS, COMSEND displays the second
  163.                string and ends.
  164.                Both strings may contain special characters.
  165.                The time period over which COMSEND will wait to find
  166.                a match may be set by command Q (below).
  167.                If the second string is to be empty, use "".
  168.  
  169.                After a command q , it is a good idea to use a command
  170.                p, P or dnnn followed by command f to make sure
  171.                that all characters received after the match will
  172.                be read and flushed before the next operation.
  173.  
  174.     Qnnn       Set timeout for command q to nnn seconds.
  175.                'nnn' MUST be a 3 digit number - 000 to 999
  176.                (0 to 999 seconds). The default is 5 seconds.
  177.  
  178.     e          Turn echo mode on. Displays incoming characters
  179.                as they are read by one of the other commands.
  180.  
  181.     E          Turn echo mode off (see command e).
  182.  
  183.     f          Flush receive buffer. It is a good idea to use one of
  184.                the delay commands (p,P,dnnn) before this.
  185.                If verbose mode is turned on from the command line,
  186.                characters will be displayed as they are flushed.
  187.  
  188.   EXAMPLE: For example, the connect sequence PRp"dial"m"no""123\r"
  189.      will cause the following to occur before file transmission:
  190.  
  191.     1) Pause for 2 seconds.
  192.     2) Transmit a carriage return followed by a linefeed.
  193.     3) Pause for 0.2 seconds.
  194.     4) Transmit the string "dial"
  195.     5) Wait till the string "no" is received.
  196.         6) Transmit the string "123" followed by a carriage return.
  197.  
  198.   SPECIAL CHARACTERS ALLOWED IN STRINGS 
  199.  
  200.   The following special characters are allowed in strings (i.e. within
  201.   double quotes) :
  202.  
  203.     \r    carriage return (without an added linefeed)
  204.     \n    line feed (newline)
  205.     \f    formfeed
  206.     \s    space
  207.     \e    escape
  208.     \b    backspace
  209.     \\    the character `\'
  210.     \"    the character `"'
  211.     \nnn  the character with ascii code nnn (3 digits, DECIMAL)
  212.  
  213.   For example, the string "\fmyname\r\n\f" consists of a
  214.   formfeed followed by `myname' followed by a <CR>, a <LF> and a
  215.   formfeed.
  216.  
  217. NOTES ON WRITING CONNECT/DISCONNECT SEQUENCES
  218.  
  219.   Use of a command p, P or dnnn followed by a command f is recommended
  220.   before sending a reply to the device being communicated with.
  221.   This ensures that all characters that were sent by the device are
  222.   read before the device is replied to.
  223.  
  224.   The results obtained when using the verbose or echo mode may be
  225.   different from when not using it: this is because in these modes,
  226.   the program runs slower and the receive buffer is not emptied out
  227.   as fast.
  228.  
  229.   While transmitting the file(s), all characters that are received
  230.   accumulate in the receive buffer. These may be displayed by
  231.   placing appropriate commands in the disconnect sequence.
  232.  
  233.   Flow control is used only for transmission.
  234.  
  235.   If a connect fails, COMSEND will still try to disconnect using
  236.   the disconnect sequence.
  237.  
  238.   All screen output maybe redirected into a file.
  239.  
  240. VERSION HISTORY
  241.  
  242.   V 1.40 - Allows upto 173 chars in the Connect Sequence.
  243.  
  244.   V 1.30 - Allows path name for files.
  245.        Allows multiple files to be transmitted.
  246.        Allows wild card characters in filenames.
  247.        Changed format of connect/ disconnect sequences.
  248.        Sets exit error code that may be tested with the "errorlevel"
  249.          command in batch files (Codes: 1=command line error,
  250.          2=some files not found, 3=no files found, 4=connect error,
  251.          5=disconnect error, 6=connect and disconnect error).
  252.  
  253.   V 1.21 - Fixed a bug that gave invalid communication errors
  254.  
  255.   V 1.20 - Changed format of connect/disconnect sequences
  256.  
  257.   V 1.10 - First official release.
  258.