Path: utzoo!attcan!utgpu!jarvis.csri.toronto.edu!mailrus!purdue!ames!apple!netcom!ward
From: ward@netcom.UUCP (Mike Ward)
Newsgroups: comp.os.minix
Subject: XCOMM 2.2 for MINIX v1.3d (part 1)
Keywords: terminal emulation, xmodem, cisb, phonelist, script
Message-ID: <1273@netcom.UUCP>
Date: 23 May 89 13:28:13 GMT
Organization: NetCom Services - Public Access Unix System (408) 997-9175 guest
Lines: 680


Greetings ...

I was looking around for a communications program to use under MINIX
V1.3 and found XCOMM 2.2 by Larry Gensch on the COMPUSERVE UNIX forum.
It took a little hacking to get it to run properly under MINIX, and I
haven't tested everything thouroughly, but the things I have tried seem
to work, so I though it would be safe to post.  (Please send me info on
any problems you find). 

MINIX XCOMM 2.2 supports the XMODEM file transfer protocol with CRC or
CHECKSUM error detection, CompuServe Information Service protocol B,
text capturing, and a phone directory.  It also comes with
documentation (which I've updated to reflect the changes I made), and
should be fairly compatable with XCOMM 2.2 which Larry will support.

I'm posting the package in three shell archives. Enjoy ...

cut below the dotted line and place it in a file (xc22pX.sh) 
and then run through the MINIX v1.3 shell:

	sh xc22pX.sh

-------------------------------------------------------------------------------
echo x - historical.doc
sed '/^X/s///' > historical.doc << '/'
X
X	X C O M M    R E V I S I O N     H I S T O R Y
X
XVersion 2.2 MINIX	mike ward	20 May 89
X    Modified terminal mode special characters to IBM-PC ALT chars
X    Removed PUT_TAKE if defs and PUT_TAKE code
X    Removed HAVE_DUP2 if defs and DUP2 code
X    Removed HAVE_STRSTR if defs and STRSTR code
X    Removed DTR_DROPS_CARRIER if defs and associated code
X    Modified to use <sgtty.h> rather than <termio.h> however
X	XON/XOFF control is stubbed out since not controllable in RAW mode
X	Interruptability is not controllable in RAW mode
X    Removed text vs binary XMODEM transfers. Can only send/recieve XMODEM
X	one way. If you want to modify the file contents use a filter.
X    Modified open of /dev/tty to use w+, this required MINIX fopen mod
X    Removed reperences to getopt, opterr, optarg for command line args
X    Had to add fflush calls to get output to screen working in places
X    Had to shorten some external names to make them uniq in first 7/8 chars
X	s_set_* to ss_*, script_* to spt_*
X    Had to add code to define strdup
X    Added help message to terminal mode
X    Modified signal stuff since MINIX did not behave as expected
X	SIGALRM to SIGIOT
X	SIGUSR1 to SIGQUIT
X	SIGCLD  to SIGHUP
X	added signal SIGHUP from child to parent on child termination
X    Modified erasln to use ^[[0K to erase to end of line
X
XVersion 2.2	larry gensch	12/8/87		Major code restructure
X    Reduced program and command options
X    Added SET command for setting various parameters
X    Added HANGUP command for disconnecting modem
X    Modified xccisb.c code to support CIS "Quick B" Protocol
X    Added xcscrpt.c code for processing script files
X    Added SCRIPT= parameter to phonebook processing (auto-logon scripts)
X    Added CIS parameter for CIS <ENQ> auto transfers
X    Added NL parameter for newline translation
X    Added HANGUP command from terminal mode
X    Added SCRIPT command from terminal mode
X
XVersion 2.1b	larry gensch	11/11/87	Bug Fix release
X    (no bugs in the code, just some portability fixes)
X    Changed "sigset" in xccisb to "signal"
X    Removed #include <setjmp.h> from xcxmdm
X
XVersion 2.1a	larry gensch	10/28/87	General Update
X    Added CIS "B" Protocol (c, ct commands)
X    Added BAUD= & BITS= parameters to phonelist file.
X    Switched some command letters
X    Revised command line parsing to use getopt()
X
XVersion 2.0	larry gensch	10/19/87	Revisions for System V.3
X    Basically version 1.1 with minor modifications
X
XVersion 1.1	Eric E Coe	7/21/85
X    Autodial for Hayes-compatible modem.
X    General rearranging of the code
X
XVersion 1.0	Eric E Coe	4/12/85
X    Program created
/
echo x - phonelist.doc
sed '/^X/s///' > phonelist.doc << '/'
XFormat of the .phonelist file:
X
X1.  The .phonelist must exist with the file name ".phonelist" either in the
X    current directory, or your home directory as defined by the $HOME
X    environment variable.  The name of the phonelist file can be changed
X    using the SET PFILE command.
X
X2.  The .phonelist file is ASCII text (lines of text separated by newlines).
X    It can be created and maintained using emacs, vi, or even ed.
X
X3.  The first field of data in each line (after any whitespace and up to the
X    next occurance of whitespace) is assumed to be a phone number in a valid
X    format for the modem being dialed.
X
X4.  Any text may follow the phone number.
X
X5.  Special strings within each line:
X
X    BITS=x	(x=7|8) - Set the terminal mode mask to 7/8 bits.
X    BAUD=nnnn	(n=300|1200|2400|4800|9600) - Set the baud rate to the
X		specified value
X    SCRIPT=file	Immediately after sending the autodial string, execute the
X		script file specified. (Note that the specified filename is
X		CASE SENSITIVE!)
X
X6.  A sample entry is shown below:
X
X     687-0374	CompuServe		BITS=7	BAUD=1200, SCRIPT=cis.cmd
X
X    The above entry indicates that the number to be dialed is 687-0374; the
X    bit mask is to be set to seven bits (ignore high bits), the baud rate is
X    to be set to 1200 baud, and commands are to be taken from the file
X    "compusrv.cmd" in either the current or home directory.
X
X    A sample .phonelist file is included in the XCOMM source code
X    distribution.
/
echo x - readme
sed '/^X/s///' > readme << '/'
XXCOMM 2.2 MINIX:
X
XNew in this release...
X
X*   Modified XCOMM command line interface
X*   CIS "Quick B" Protocol support for faster up/downloads
X*   Brand new script processor with integration into the phonebook
X*   Some code cleanup
X*   Better "vanilla" Unix support (thanks to bug reports)
X
XRefer to "historical.doc" for a list of ALL new features.
X
XXCOMM is a PUBLIC DOMAIN (not shareware) communication program that works on 
XUnix System V.3 (and MINIX).  It probably works on other Unix systems with no 
Xmodification, since no machine specific coding was done.  
X
XMINIX XCOMM is distributed in three bundles:
X
XXCM22P1.SH	All documentation for XCOMM
XXCM22P2.SH	source code, header files, and makefile.
XXCM22P3.SH	source code
X
XThis README manifest file is included in both packages.
X
XContents of XCM22P1.SH:
X
Xreadme		This manifest file
Xscript.doc	Quick reference to the XCOMM script language
Xxcomm.doc	Latest documentation for the XCOMM program
Xhistorical.doc	Historical information about versions 1.0 and 1.1
Xphonelist.doc	Documentation on using XCOMM's phonelist
X
X
XContents of XCM22SRC.SH:
X
Xreadme		This manifest file
Xinstall.doc	Quick installation notes
Xmakefile	Make file for compiling XCOMM
Xcis.cmd		A sample XCOMM script file for logging onto CompuServe.
X.phonelist	A sample Phone List file
Xxcomm.h		XCOMM's header file
Xxcxmdm.c	XCOMM XMODEM protocol module
Xxccisb.c	XCOMM CIS-B/QuickB protocol module
X
X
XContents of XCM22SRC.SH:
X
Xreadme		This manifest file
Xxcomm.c		XCOMM main program
Xxcport.c	XCOMM Terminal I/O module
Xxcscrpt.c	XCOMM Script processor
Xxcsubs.c	XCOMM's subroutines
Xxcterm.c	XCOMM Terminal mode module
/
echo x - script.doc
sed '/^X/s///' > script.doc << '/'
X
X		    XCOMM SCRIPT QUICK REFERENCE
X			XCOMM Release 2.2
X
X
X
XIntroduction
X
X    Script files can automate some tedious tasks such as logging into a
X    system.  A script file is an Ascii text file and may be entered or
X    edited using any standard Unix text editor.
X
X    The script file is read line by line.  Empty lines (consisting of white
X    space only) are ignored.  Comments are lines whose first non-space
X    character is a pound sign (#).
X
X    The script processor reads each script line, ignoring leading white
X    space, into "words".  A word is defined as either:
X
X    - A sequence of characters delimited by white space; or
X    - A sequence of characters enclosed in single or double quotes.
X
X    The first word of a script file is considered the "command word."
X    If the last character of the command word is a colon (:), the line is
X    considered to be a LABEL (the object of a GOTO statement).  Otherwise,
X    it is assumed to be a script command and is interpreted as such.
X    Command words are case insensative.
X
X    Some commands take one or more arguments.  Each argument is parsed as a
X    single word as defined above.  If blanks are required in an argument,
X    the argument MUST be quoted using single or double quotes.
X
X    Enclosed in the XCOMM distribution is the file "compusrv.cmd".  This is
X    an example script file (No, that is not really my user ID or my
X    password in that file!), and shows the use of most of the available
X    script commands.  The script commands are self explanatory for the most
X    part.
X
X
XStartup Scripts
X
X    When XCOMM is started up, it looks for the file ".xcomm" in the current
X    or $HOME directory.  If it is found, it is executed.  This is useful for
X    setting your "basic" parameters without having to recompile XCOMM.  For
X    example, your startup file may turn CIS <ENQ> mode off, set your baud
X    rate to 9600, and set 7BIT translation.
X
X
XScript Command List
X
X    Below is the description of all commands that may be used in the XCOMM
X    script language:
X
X
XCAPTURE ON|OFF
X
X    The command CAPTURE ON will open the capture command; all characters
X    received during WAITFOR processing will be appended to the capture file.
X    The command CAPTURE OFF will close the capture file.
X
X    This setting does NOT currently extend to terminal mode.  This may be
X    offered in a later release (probably through the SET command).
X
X
XDIAL <number>
X
X    Dial the specified number.  XCOMM supports generic "Hayes" compatible
X    modems for dialing.  Note that this command requires an actual phone
X    number; the phonebook is not used for this function.
X
X
XECHO ON|OFF
X
X    If the argument to the ECHO command is ON, all subsequent command lines
X    that are processed will be displayed on the local screen.  The exception
X    to this is lines containing a TRANSMIT command.  These lines will just
X    print "TRANSMIT ...", so that passwords, etc. can be protected.
X
X    If the argument to the ECHO command is OFF, scripts will execute
X    quietly (this is the default setting).
X
X
XEXIT
X
X    Terminate the script file prior to the end of file.  Returns to terminal
X    mode.
X
X
XGOTO <label>
X
X    Go to the specified label in the script file and continue execution from
X    that point.  The label may either precede or follow the actual GOTO
X    statement.
X
X
XIF <condition>
X    <statements>
X[ ELSE
X    statements ]
XENDIf
X
X    Conditionally execute statements based on specified condition.  XCOMM
X    supports the following conditions:
X
X    WAITFOR		TRUE if the last WAITFOR command was successful
X    LINKED		TRUE if this script was executed from the phonebook
X
X    Conditions may be negated using the prefix NOT or the character "!":
X
X    !WAITFOR		TRUE If the last WAITFOR command timed out
X    NOT WAITFOR		Same as !WAITFOR above
X
X    The ELSE and ENDIF keywords must appear on their own lines.  IF
X    statements may not be nested.
X
X
XPAUSE <time>
X
X    Suspend execution of the script for the specified number of seconds.
X    This is usually used for timing considerations; for example, waiting a
X    couple of seconds after receiving the CONNECT message and typing ^C to
X    CompuServe.
X
X
XQUIT
X
X    Terminate the script AND the XCOMM program (return to the shell).
X
X
XREDIAL
X
X    Redial the last number dialed using the DIAL command OR the phonebook.
X
X
XSET <parameter> <value>
X
X    Sets the specified parameter to the specified value.  The SET parser
X    used in command mode is used, and the parameters/values are identical.
X    Refer to the main documentation for information on the SET command.
X
X    During script processing, internal status messages are NOT displayed on
X    the local terminal (eg, SET 7BIT ON in a script file does not display
X    the new value on the terminal).  This may be changed in the future
X    (probably tied to the ECHO setting).
X
X    During script processing, specifying SET alone is an ERROR... there is
X    no way currently display the current status of the SET-able parameters
X    during script processing.
X
X
XTRANSMIT <text>
X
X    Transmit the specified text to the remote.  The text argument should be
X    quoted (using single or double quotes) if there are spaces to be
X    transmitted.  The text is transmitted AS IS (no case conversions are
X    performed).
X
X    Prefix characters:
X
X    ^	Control character prefix - The next character is made into a
X	control character.  
X	For example:  ^M = RETURN (0x0D); ^J = NEWLINE (0x0A).
X
X    \	Quote prefix - The next character is transmitted verbatim.  For
X	example, \^ would transmit a literal ^.
X
X
XTTY ON|OFF
X
X    The TTY command specifies whether or not characters received from the
X    modem will be displayed on the local terminal.  Since the only time that
X    the script processor looks at the receive queue is during WAITFOR
X    processing, the displays may look a bit erratic.
X
X    Use the TTY OFF command to disable local display of received characters
X    during script processing.
X
X
XWAITFOR <text> [timeout]
X
X    Wait for the specified text to appear from the modem.  The text argument
X    should be quoted (using single or double quotes) if there are spaces to
X    be transmitted.
X
X    Special characters are interpreted the same as for TRANSMIT.
X
X    If the timeout argument is specified, XCOMM will wait that number of
X    seconds for the string to appear.  If no timeout is given, XCOMM
X    defaults to 30 seconds.
X
X    During WAITFOR processing, characters received (up to and including the
X    last character found in the text or in the timeout) can be captured to a
X    disk file (if CAPTURE ON was specified), and/or displayed to the screen
X    (if TTY ON was specified).
X
X
XNotes to Next Release:
X
X    In the next release (2.4?), the script processor will support ALL
X    command mode options, including xmodem send and receive, CIS transfers,
X    local dump to terminal mode and back to script, shell commands, PUT and
X    TAKE, plus a DIVERT command to transmit the contents of a data file
X    through the modem (similar to the terminal mode <ESC> F command).
X
X    I am always open to reasonable suggestions for improvements to the XCOMM
X    program and its script language.
/
echo x - xcomm.doc
sed '/^X/s///' > xcomm.doc << '/'
XXCOMM is a public domain terminal program that currently features
X
Xo XMODEM and CIS "QuickB" file transfers with optional "text" translation
Xo Hayes Modem dialing directory with BAUD and BIT parameters
Xo Unix CU compatible PUT and TAKE commands
Xo Simple HOST communication mode
Xo Communication scripting with optional linkage from phone directory.
X
XXCOMM is offerred free of charge with NO requests for financial compensation
Xreqested (this is public domain, not shareware).  The source code may be
Xused or modified by anyone, but this code, or derivations of this code,
Xmay not be sold by anyone to anyone.
X
XDocumentation on the SCRIPT language and the XCOMM Phone directory is
Xcontained in separate files.
X
X
XXCOMM Command Summary
X---------------------
X
XXCOMM prompts for commands using the string:
X
X    XCOMM>
X
XWith version 2.2, XCOMM supports the following commands:
X
X
Xc		
X
XInitiate CIS QuickB File Transfer.  This command is used for both uploading and
Xdownloading from CompuServe.
X
X
Xg file
X
XExecute the XCOMM script file "file".  Returns to terminal mode when the
Xscript is complete.
X
X
Xxr file
X
XXMODEM receive.  Receive the specified file from the remote system using
Xthe XMODEM file transfer protocol (with or without CRC checking - see set).
X
X
Xxs file
X
XXMODEM transmit.  Transmit the specified file to the remote system using
Xthe XMODEM file transfer protocol (with or without CRC checking - see set).
X
X
Xset
X
XDisplay or set the transmission parameters used by the XCOMM program.  Refer
Xto the SET section of this document.
X
X
Xt
X
XEnter terminal mode.  Refer to the TERMINAL section of this document.
X
X
Xx
X
XExit program.  Return to invoking program/shell.
X
X
X! <cmd>
X
XExecute the specified command as a child process.  If <cmd> is ommitted,
Xexecute a local interactive shell.
X
X
X!!
X
XRe-execute the last shell command string.
X
X
X$
X
XExecute a shell command with stdin and stdout redirected to the modem port.
XThis effectively puts the computer into a "host" mode.
X
X
X?
X
XPrint a short XCOMM command summary.
X
X
X
XUsing the SET Command
X---------------------
X
XThe SET command is used to display and set/reset XCOMM's tunable parameters.
XThe usage is shown below:
X
X(1)   set
X
X      Display XCOMM's current parameters.
X
X
X(2)   set 7bit
X      set 8bit
X      set crc
X      set chk
X      set term
X      set cmd
X
X      Set the indicated parameter:
X
X      7bit	Modem high-bit masking.  All characters received from the
X		modem are masked so their values are between 0 and 127.
X		This is useful for remote systems that transmit parity
X		characters (the parity is ignored).
X
X      8bit	Disable Modem high-bit masking.  All characters received
X		from the modem are displayed verbatim.
X
X      crc	Set XMODEM CRC protocol.  All transferred blocks use a
X     		16-bit block check, which is more reliable than the older
X		"checksum" block check.
X
X      chk	Set XMODEM Checksum protocol.  All transferred blocks use an
X     		8-bit block check, which is not as reliable as the CRC
X		block check, but is compatible with older programs using
X		XMODEM.
X
X      term	Set auto-jumpback to terminal mode after all file transfers.
X
X
X      The above parameters are paired; that is, the "crc" parameter is
X      negated by the "chk" parameter.
X
X      XMODEM Transfers:  When using "crc" protocol on a transmit, the XCOMM
X      program will fall back to "checksum" block checks if the receiving
X      program does not support the special "crc" handshake.
X
X(3)   set cis   on|off
X      set mung  on|off
X      set purge on|off
X      set xoff  on|off
X      set baud  <value>
X      set cfile name
X      set pfile name
X      set nl
X
X      cis	Set CompuServe <ENQ> file transfer requests.  An "on" value
X     		specifies that when in terminal mode, an <ENQ> character
X		will perform an automatic CIS QuickB protocol transfer.
X		This parameter should be set "off" when not connected to
X		CompuServe, as phone line noise may cause a bogus file
X		transfer request.
X
X      mung	Set file overwrite flag.  If "on", files may be overwritten
X		when receiving data files.  If "off", files will not be
X		overwritten (will cause an error message to be displayed).
X
X      purge	Set Bad Telephone Line Purge mode.  If "on", removes
X      		spurious characters received through the phone line due to
X		noise before listening for an acknowledgement.  This
X		increases the amount of time spent transmitting each block,
X		but can improve throughput overall by reducing the number of
X		block retransmissions.
X
X      (XON/XOFF doesn't work under MINIX for RAW streams)
X      xoff	Set XON/XOFF flow control flag.  If "on", the program will
X		honor the XOFF control character and wait until an XON
X		character is received before transmitting any more
X		information.  If "off", the program will ignore XOFF/XON
X		requests.
X
X      baud	Set the desired baud rate.  Supported baud rates are 300,
X		1200, 2400, 4800, and 9600 baud.
X
X      cfile	Set the name of the terminal mode capture file to "name".
X
X      pfile	Set the name of the terminal mode phonelist file to "name".
X
X      nl	Set newline translation mode ON or OFF. When ON (the default)
X		all newlines will be translated to carriage returns in
X		terminal mode. When OFF all newlines are sent as newlines,
X		carriage returns are sent as carriage returns.
X
X
XA sample "set" command status display is shown below:
X
X    Modem port is '/dev/tty00'.
X    Speed is 1200 baud.
X    Seven-bit communication mask enabled.
X    XMODEM CRC protocol enabled.
X    Extra bad telephone line purging enabled.
X    Capture save file is 'capture.log'.
X    Phone number file is '.phonelist'.
X    XON/XOFF Flow control is OFF.
X    CIS <ENQ> Auto Download is ON.
X    Terminal NL Translation is ON.
X
X
XTERMINAL Mode operation
X-----------------------
X
XIn terminal mode, all characters typed at the keyboard are sent to the
Xmodem (except the special character lited below); all characters received
Xfrom the modem are displayed on the local terminal screen.
X
XNewline characters (0x0A) are translated to carriage returns (0x0D) when
XNewline mode is active.
X
XTerminal Mode Special Characters:
X
XALT-?	Help		Displays a short message describing these keys.
X
XALT-c	toggle Capture	Toggle capture file - If the file is not open, it is
X			opened in APPEND mode (text receive accumulates at
X			the end of the file).  If the file is already open,
X			it is closed, instead.
X
XATL-d	Dial		Select a phone number and dial it.
X
XALT-g	script (GO)	Execute a script file.
X
XALT-h	Hangup		Disconnect from the remote system.
X
XALT-s	Send file	Send a file through the modem (ascii transfer).  An
X			option is available for waiting after each line is
X			sent to avoid overrunning the remote systems input
X			buffer.
X
XALT-x	eXit		Exit terminal mode back to XCOMM command mode.
X
X
X
XXCOMM Command Line switches
X---------------------------
X
X-l device
X
X    (Line option) Specifies the path name to be used for the modem device.  
X    This overrides the value of the MODEM environment variable.  
X
X    Note that if the MODEM environment variable is not set, the -l Line option 
X    is mandatory.  
X
X    The MODEM environment variable is used as the default path name to be used 
X    for the modem device.  If this environment variable is not set, the -l 
X    Line option is mandatory.  
X
X    The MODEM variable is usually set in a shell profile.  In the Bourne 
X    shell, this is placed in the .profile file of your home directory with 
X    statements similar to that shown below:  
X
X	export MODEM; set MODEM="/dev/tty00"
X
X    (assuming your modem device is /dev/tty00).  Using the C Shell, the 
X    following statement may be place in .cshrc in your home directory:  
X
X	setenv MODEM "/dev/tty00"
X
X
X-g file
X
X    (GO option) Specifies a script to be executed as soon as XCOMM is finished 
X    initializing.  
X
X
X-t
X
X    (Terminal option) Directs XCOMM to jump directly into terminal mode after 
X    initializing.  
X
X
XEntering XCOMM with an invalid option will display a summary of the valid
Xoptions supported.
X
X
XBUG REPORTS, ENHANCEMENTS, ETC...
X---------------------------------
X
XMy electronic addresses are:
X
XCompu$erve:		[72236,3516]   (UNIXFORUM)
XDelphi:			larryg
XBix:			lar3ry
XAndover CNode:		larry gensch
X			(This is a FIDO BBS dedicated to C Language
X			programming - phone number (617) 470-2548)
/