First (hopefully) working version of caption processing.
[screen-lua.git] / src / doc / README.DOTSCREEN
blobf17fa37dd33eff2cfc42b3a3e74864de4c34c8bf
1 From bargi@dots.physics.orst.edu Thu Aug 31 23:42 MET 1995
2 Received: from faui45.informatik.uni-erlangen.de (root@faui45.informatik.uni-erlangen.de [131.188.34.45]) by immd4.informatik.uni-erlangen.de with ESMTP
3         id XAA14775 (8.6.12/7.4f-FAU);; Thu, 31 Aug 1995 23:42:15 +0200
4 Received: from dots.physics.orst.edu (bargi@dots.PHYSICS.ORST.EDU [128.193.96.106]) by uni-erlangen.de with ESMTP
5         id XAA03048 (8.6.12/7.4f-FAU); for <screen@uni-erlangen.de>; Thu, 31 Aug 1995 23:42:03 +0200
6 Received: (from bargi@localhost) by dots.physics.orst.edu (8.6.11/8.6.9) id OAA15627; Thu, 31 Aug 1995 14:41:47 -0700
7 From: Hadi Bargi Rangin <bargi@dots.physics.orst.edu>
8 Message-Id: <199508312141.OAA15627@dots.physics.orst.edu>
9 Subject: README.DOTSCREEN
10 To: screen@uni-erlangen.de
11 Date: Thu, 31 Aug 1995 14:41:47 -0700 (PDT)
12 Cc: bargi@dots.physics.orst.edu (Hadi Bargi Rangin)
13 X-Mailer: ELM [version 2.4 PL24]
14 MIME-Version: 1.0
15 Content-Transfer-Encoding: 7bit
16 Content-Type: text/plain; charset=US-ASCII
17 Content-Length: 5423
18 Status: RO
20 Hallo,
22    leider war readme file fuer dotscreen nicht in unserem dotscreen-Packet, 
23 deshalb schicke ich es Euch nachtraeglich.  Nachdem Ihr unseren packet
24 getestet habt, koennen wir Euch anrufen und vielleicht mehr ueber die
25 Einzelnheiten sprechen, ob wir unsere Weiterentwicklung koordinieren
26 wollen.
28 Danke,
30 Gruss,
31 Hadi
33 ===============================================================================
34 Quick introduction to dotscreen
35 -------------------------------
37 1. Introduction
38 2. Is dotscreen different as screen?
39 3. Installation instructions
40 4. Functions description
41 5. Further development
44 1. Introduction
45 =============== 
47 Dotscreen, is a system which allow a person direct access to unix via
48 a braille display. The emphasis is on direct, because the braille
49 display is connected directly to the serial port on the unix
50 machine. You no longer must use a dos machine running a terminal
51 emulation logged into a unix machine.  Dotscreen is built on top of
52 screen, a powerful full-screen window manager for unix tty terminals.
53 Screen keeps track of what is being displayed in each window that it
54 is managing so that it can easily switch back and forth between these
55 windows. Dotscreen makes this stored window information available via
56 a braille display. Dotscreen only allows access to tty terminal
57 sessions, it does not allow access to X-Windows, however, it will run
58 in an xterm window. Currently, it works with the TSI Navigator 40 and
59 the TSI PowerBraille 40 braille displays. We plan to support other
60 displays as demand and information about other displays is made
61 available to us
63 2. Is dotscreen different than screen?
64 ======================================
66 All of screens functions still work in dotscreen. A few of the
67 functions are not accessible via braille, but we expect to remedy that
68 in future releases.
70 3. Installation instructions
71 ============================
73 Please read the INSTALL file for full installation instructions.
74 In addition to those instructions, note that you must create
75 a .screenrc file and that file must contain the type of braille
76 display that you are using and the serial device that the display
77 is connected to. A minimal .screenrc file should contain something
78 like the following four lines, (these are only examples, please
79 customize them for your configuration)
82 # example of .screenrc when using  braille display
83 bd_start_braille on
84 bd_type  powerbraille_40
85 bd_port  /dev/ttyS0
86 bd_braille_table /home/gardner/us-braille.tbl
87 # end of example
90 4. Functions description
91 ========================
93 The basic operation of screen is described in README.  The braille
94 navigation commands are similar to commands usually found on dos
95 braille screenreaders. Also, because dotscreen is built on top of
96 screen, the user can switch back and forth easily between many running
97 applications.  The braille commands can be changed any time after
98 starting screen using the internal screen "C-a :" command line.  All
99 braille commands begin with "bd_"; following is the list of braille
100 commands:
102 bd_start_braille on/off      # Starts/stops using braille features on screen
103 bd_link on/off               # links/unlinks braille cursor to/from screen cursor
104 bd_bell on/off               # turn on/off sending bell-signal to terminal
105 bd_scroll on/off             # enables/disables scrolling
106 bd_skip on/off               # skip/don't skip balnk lines
107 bd_width <integer-value>     # number of braille cells that user want to use,
108                              # this value is always <= total number of cells
109 bd_ncrc <interger-value>     # number of cells displayed on the right side 
110                              # of physical cursor (default = 1)   
111 bd_info  <integer-value>     # displays braille/screen cursor position 
112                              # depending on its value, (no info: 0, only 
113                              # bc-info: 1, only sc-info: 2, bc- and sc-info: 3
114 bd_port <serial-device>      # serial port which braille display is connected to
115 bd_braille_table <bl-table>  # braille table to be used. German, US and GS 
116                              # braille tables are provided
117 bd_type <braille-display-type> 
118                              # braille display type being used     
120 Note: currently valid value for some parameters:
121 bd_type: 
122  1. navigator_40 
123  2. powerbraille_40.
125 bd_braille_table:
126  1. gr-braille.tbl     German braille code
127  2. us-braille.tbl     US computer braille code
128  3. gs-braille.tbl     GS braille code
130 Since the braille tables are in files, you should give the full
131 pathnames of the files either in .screenrc or using the
132 internal screen "C-a :" command line.
134 5. Further development
135 ======================
137 As mentioned above, currently Dotscreen works with Telesensory braille
138 displays the PowerBraille and the Navigator because Telesensory has
139 given us the information needed to program their braille display. We
140 plan to add support for other braille displays when and if we get the
141 requisite information from the braille display manufacturer. 
142 Also some things such as cursor navigation from the braille display
143 have not been implemented. If you find a feature missing that
144 you wish to have, please contact us.
146 This software has been developed within the Science Access Project at
147 Oregon State University under the direction of John Gardner.
149 Authors:   Hadi Bargi Rangin (bargi@dots.physics.orst.edu)
150            Bill Barry (barryb@dots.physics.orst.edu)