1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README.txt	Fri Apr 07 23:43:06 2017 +0300
     1.3 @@ -0,0 +1,129 @@
     1.4 +dterm: A simple terminal program
     1.5 +
     1.6 +
     1.7 +dterm is a simple terminal emulator, which doesn't actually emulate
     1.8 +any particular terminal.  Mainly, it is designed for use with xterm
     1.9 +and friends, which already do a perfectly good emulation, and therefore
    1.10 +don't need any special help; dterm simply provides a means by which 
    1.11 +keystrokes are forwarded to the serial line, and data forwarded from
    1.12 +the serial line appears on the terminal.
    1.13 +
    1.14 +
    1.15 +Running dterm
    1.16 +
    1.17 +dterm is invoked thusly:
    1.18 +
    1.19 +	dterm [options|device ...] 
    1.20 +
    1.21 +dterm attempts to read the file ~/.dtermrc for options; if this doesn't
    1.22 +exist, it tries /etc/dtermrc.  Then it parses the options passed on the
    1.23 +command line.
    1.24 +
    1.25 +The options read should include a device name, e.g "ttyS0" or "ttyd0"
    1.26 +for the first serial port on a Linux or FreeBSD system respectively.  If
    1.27 +no device is specified, dterm tries /dev/ttyS0, /dev/ttyd0, /dev/ttyUSB0
    1.28 +and /dev/ttyU0.
    1.29 +
    1.30 +Once started, dterm can be got into command mode using Ctrl/].  Press
    1.31 +enter once from command mode to get back into conversational mode.  (The
    1.32 +command character can be changed with the esc= option, e.g. esc=p to 
    1.33 +use Ctrl/P instead of Ctrl/].)
    1.34 +
    1.35 +
    1.36 +Options
    1.37 +
    1.38 +The following options can be used from command mode
    1.39 +
    1.40 +- 300, 1200, 9600 etc: Set speed, default 9600.
    1.41 +- 5, 6, 7, 8: Set bits per character, default 8.
    1.42 +- 1, 2: Set number of stop bits, default 1.
    1.43 +- e, o, n, m, s: Set parity to even, odd, none, mark or space, default none.
    1.44 +- cts, nocts:  Enable / disable CTS flow control, default nocts.
    1.45 +- xon, noxon: Enable / disable XON/XOFF flow control, default noxon.
    1.46 +- modem: Enable / disable modem control (hang up modem on exit, exit if
    1.47 +modem hangs up), default nomodem.
    1.48 +- bs, nobs: Enable / disable mapping of Delete to Backspace, default nobs.
    1.49 +- del, nodel: Enable / disable mapping of Backspace to Delete, default nodel.
    1.50 +- maplf, nomaplf: Enable / disable mapping of LF to CR, default nomaplf.
    1.51 +- igncr, noigncr: Ignore / output carriage returns, default noigncr.
    1.52 +- crlf, nocrlf: Enable / disable sending LF after each CR, default nocrlf.
    1.53 +- ctrl, noctrl: Enable / disable control character display mode.  In this
    1.54 +mode, non-printable characters are displayed as ^c for the codes 0-31 (except
    1.55 +CR, LF & TAB), [DEL] for 127, or [xx] for non-printing characters >= 128.
    1.56 +- hex, nohex: As for ctrl, but prints [xx] for all characters except 7-bit
    1.57 +printable ASCII, CR and LF.
    1.58 +- b: Send a 500 ms break.
    1.59 +- dtr, nodtr: Raise / lower DTR, default dtr.
    1.60 +- rts, norts: Raise / lower RTS, default rts.
    1.61 +- d, r: Toggle DTR / RTS.
    1.62 +- esc=<c>: Set command mode character to Ctrl/<c> (default ']') 
    1.63 +- @<filename>: Read and process configuration from <filename>.
    1.64 +- !<command>: Execute shell command
    1.65 +- sx <filename>: Send a file using XMODEM.
    1.66 +- rx <filename>: Receive a file using XMODEM.
    1.67 +- sz <filename>: Send a file using ZMODEM.
    1.68 +- rz: Receive file(s) using ZMODEM.
    1.69 +- show: Display current configuration and modem status.
    1.70 +- help, h, ?: Display a summary of commands.
    1.71 +- version: Display version, copyright and warranty information.
    1.72 +- quit, q: Exit
    1.73 +
    1.74 +
    1.75 +File Transfer
    1.76 +
    1.77 +If the rzsz package (or lrzsz) package is installed, the sx, sz, rx & rz
    1.78 +commands can be used to initiate file transfers using the reliable
    1.79 +XMODEM and ZMODEM file transfer protocols.  Note that the program files
    1.80 +for rzsz must be in /usr/bin or /usr/local/bin for dterm to find them.
    1.81 +
    1.82 +Note that rx, sx and rz require that the transfer be initiated at the
    1.83 +remote end before escaping back to the dterm command prompt.  sz will send 
    1.84 +an "rz" command down the serial link in start-up to initiate the transfer.
    1.85 +
    1.86 +
    1.87 +Examples
    1.88 +
    1.89 +Connect via ttyS1 to a system running at 2400 bps, 7 bits even parity:
    1.90 +
    1.91 +	dterm ttyS1 2400 7 e
    1.92 +
    1.93 +Send a break in a running session:
    1.94 +
    1.95 +	^]
    1.96 +	dterm> b
    1.97 +	dterm>
    1.98 +
    1.99 +Transmit a file using ZMODEM:
   1.100 +
   1.101 +	^]
   1.102 +	dterm> sz file.txt
   1.103 +	rz waiting to receive.Sending: file.txt
   1.104 +	Bytes Sent:  22943   BPS:645                             
   1.105 +	Transfer complete
   1.106 +	dterm>
   1.107 +
   1.108 +
   1.109 +Copyright
   1.110 +
   1.111 +dterm is Copyright 2007 Knossos Networks Ltd.
   1.112 +
   1.113 +This program is free software; you can redistribute it and/or
   1.114 +modify it under the terms of the GNU General Public License version 2
   1.115 +as published by the Free Software Foundation.
   1.116 +
   1.117 +This program is distributed in the hope that it will be useful,
   1.118 +but WITHOUT ANY WARRANTY; without even the implied warranty of
   1.119 +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   1.120 +GNU General Public License for more details.
   1.121 +
   1.122 +A copy of the GNU General Public License version 2 is available at
   1.123 +http://www.knossos.net.nz/gpl.html or can be obtained from the Free
   1.124 +Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
   1.125 +02110-1301 USA.
   1.126 +
   1.127 +
   1.128 +Source Code
   1.129 +
   1.130 +dterm source code is located at 
   1.131 +http://www.knossos.net.nz/downloads/dterm-0.3.tgz
   1.132 +