aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorjames <>2008-03-10 11:49:33 +0000
committerjames <>2008-03-10 11:49:33 +0000
commit0a4c67a874e7bce9e358c82489782c9e402a58a4 (patch)
tree8c157ec80ee5373abf27075e91906a9a03ad99c0 /README
parent3bfc6a76971bce4c16360f6cc2896dec3f1fbafe (diff)
downloadsympathy-0a4c67a874e7bce9e358c82489782c9e402a58a4.tar.gz
sympathy-0a4c67a874e7bce9e358c82489782c9e402a58a4.tar.bz2
sympathy-0a4c67a874e7bce9e358c82489782c9e402a58a4.zip
*** empty log message ***
Diffstat (limited to 'README')
-rw-r--r--README41
1 files changed, 26 insertions, 15 deletions
diff --git a/README b/README
index 4c2edea..6886876 100644
--- a/README
+++ b/README
@@ -1,16 +1,27 @@
-#
-#
-# README:
-#
-# Copyright (c) 2008 James McKenzie <james@fishsoup.dhs.org>,
-# All rights reserved.
-#
-# $Id$
-#
-# $Log$
-# Revision 1.1 2008/02/03 16:20:23 james
-# *** empty log message ***
-#
-#
-#
+Copyright (c) 2008 James McKenzie <james@fishsoup.dhs.org>,
+All rights reserved.
+
+$Id$
+
+ Sympathy is a replacement for screen(1), minicom(1) and consolidate(1).
+It is a VT52/VT100/ANSI terminal emulator with some special features. In
+normal use sympathy would sit between a terminal device (a serial port or
+a pseudo-tty) and the user’s usual terminal emulator (eg xterm(1)).
+Sympathy renders data from the terminal device into an internal frame
+buffer and then expresses changes in this frame buffer to the outer terminal
+emulator using a small subset of ANSI escape codes. Sympathy always
+generates valid escape codes to the outer ter- minal, and will reset the state
+of its internal terminal emulator when it detects receive errors on the
+terminal device.
+
+ Sympathy, unlike screen(1), takes care to preserve the scroll-back fea-
+tures of the outer terminal emulator: lines that scroll off the top of the
+internal frame buffer are scrolled off the top of the outer termi- nal
+emulator. When sympathy is used in client/server mode, some history is added to
+the outer terminal emulator when the client connects.
+
+ Sympathy also supports automatic baud-rate detection, and advanced log-
+ging features. Sympathy logs whenever any of the modem control lines change
+state, receive errors, and the contents of any line on the frame buffer as the
+cursor moves off it.