dterm-nuc
view README.txt @ 2:68e6bdd9c9df
minor copyright message adjustment
| author | John Tsiombikas <nuclear@member.fsf.org> |
|---|---|
| date | Sat, 08 Apr 2017 00:00:47 +0300 |
| parents | ad098a33fd34 |
| children |
line source
1 dterm: A simple terminal program
4 dterm is a simple terminal emulator, which doesn't actually emulate
5 any particular terminal. Mainly, it is designed for use with xterm
6 and friends, which already do a perfectly good emulation, and therefore
7 don't need any special help; dterm simply provides a means by which
8 keystrokes are forwarded to the serial line, and data forwarded from
9 the serial line appears on the terminal.
12 Running dterm
14 dterm is invoked thusly:
16 dterm [options|device ...]
18 dterm attempts to read the file ~/.dtermrc for options; if this doesn't
19 exist, it tries /etc/dtermrc. Then it parses the options passed on the
20 command line.
22 The options read should include a device name, e.g "ttyS0" or "ttyd0"
23 for the first serial port on a Linux or FreeBSD system respectively. If
24 no device is specified, dterm tries /dev/ttyS0, /dev/ttyd0, /dev/ttyUSB0
25 and /dev/ttyU0.
27 Once started, dterm can be got into command mode using Ctrl/]. Press
28 enter once from command mode to get back into conversational mode. (The
29 command character can be changed with the esc= option, e.g. esc=p to
30 use Ctrl/P instead of Ctrl/].)
33 Options
35 The following options can be used from command mode
37 - 300, 1200, 9600 etc: Set speed, default 9600.
38 - 5, 6, 7, 8: Set bits per character, default 8.
39 - 1, 2: Set number of stop bits, default 1.
40 - e, o, n, m, s: Set parity to even, odd, none, mark or space, default none.
41 - cts, nocts: Enable / disable CTS flow control, default nocts.
42 - xon, noxon: Enable / disable XON/XOFF flow control, default noxon.
43 - modem: Enable / disable modem control (hang up modem on exit, exit if
44 modem hangs up), default nomodem.
45 - bs, nobs: Enable / disable mapping of Delete to Backspace, default nobs.
46 - del, nodel: Enable / disable mapping of Backspace to Delete, default nodel.
47 - maplf, nomaplf: Enable / disable mapping of LF to CR, default nomaplf.
48 - igncr, noigncr: Ignore / output carriage returns, default noigncr.
49 - crlf, nocrlf: Enable / disable sending LF after each CR, default nocrlf.
50 - ctrl, noctrl: Enable / disable control character display mode. In this
51 mode, non-printable characters are displayed as ^c for the codes 0-31 (except
52 CR, LF & TAB), [DEL] for 127, or [xx] for non-printing characters >= 128.
53 - hex, nohex: As for ctrl, but prints [xx] for all characters except 7-bit
54 printable ASCII, CR and LF.
55 - b: Send a 500 ms break.
56 - dtr, nodtr: Raise / lower DTR, default dtr.
57 - rts, norts: Raise / lower RTS, default rts.
58 - d, r: Toggle DTR / RTS.
59 - esc=<c>: Set command mode character to Ctrl/<c> (default ']')
60 - @<filename>: Read and process configuration from <filename>.
61 - !<command>: Execute shell command
62 - sx <filename>: Send a file using XMODEM.
63 - rx <filename>: Receive a file using XMODEM.
64 - sz <filename>: Send a file using ZMODEM.
65 - rz: Receive file(s) using ZMODEM.
66 - show: Display current configuration and modem status.
67 - help, h, ?: Display a summary of commands.
68 - version: Display version, copyright and warranty information.
69 - quit, q: Exit
72 File Transfer
74 If the rzsz package (or lrzsz) package is installed, the sx, sz, rx & rz
75 commands can be used to initiate file transfers using the reliable
76 XMODEM and ZMODEM file transfer protocols. Note that the program files
77 for rzsz must be in /usr/bin or /usr/local/bin for dterm to find them.
79 Note that rx, sx and rz require that the transfer be initiated at the
80 remote end before escaping back to the dterm command prompt. sz will send
81 an "rz" command down the serial link in start-up to initiate the transfer.
83 This version also supports plain ascii transfers using `ascii-xfr`. Use
84 commands sa/ra to do ascii transfers.
87 Examples
89 Connect via ttyS1 to a system running at 2400 bps, 7 bits even parity:
91 dterm ttyS1 2400 7 e
93 Send a break in a running session:
95 ^]
96 dterm> b
97 dterm>
99 Transmit a file using ZMODEM:
101 ^]
102 dterm> sz file.txt
103 rz waiting to receive.Sending: file.txt
104 Bytes Sent: 22943 BPS:645
105 Transfer complete
106 dterm>
109 Copyright
111 dterm is Copyright 2007 Knossos Networks Ltd.
112 Copyright 2017 John Tsiombikas <nuclear@member.fsf.org>
114 This program is free software; you can redistribute it and/or
115 modify it under the terms of the GNU General Public License version 2
116 as published by the Free Software Foundation.
118 This program is distributed in the hope that it will be useful,
119 but WITHOUT ANY WARRANTY; without even the implied warranty of
120 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
121 GNU General Public License for more details.
123 A copy of the GNU General Public License version 2 is available at
124 http://www.knossos.net.nz/gpl.html or can be obtained from the Free
125 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
126 02110-1301 USA.
129 Source Code
131 Mercurial repo: http://nuclear.mutantstargoat.com/hg/dterm-nuc
133 original dterm source code is located at
134 http://www.knossos.net.nz/downloads/dterm-0.3.tgz