xref: /dragonfly/share/man/man4/screen.4 (revision 9dbf638f)
1.\"
2.\" $FreeBSD: src/share/man/man4/screen.4,v 1.14.2.9 2001/08/17 13:08:39 ru Exp $
3.\" $DragonFly: src/share/man/man4/screen.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
4.\"
5.Dd October 6, 2000
6.Dt SCREEN 4
7.Os
8.Sh NAME
9.Nm screen
10.Nd pc display interface
11.Sh DESCRIPTION
12Access to the
13.Em virtual consoles
14are obtained through the device files
15.Pa /dev/ttyv0
16-
17.Pa /dev/ttyvb .
18Each of these files correspond to a separate
19virtual console.
20All virtual console devices can be open at once, but only one is
21active at a time.
22The active virtual console "owns" the keyboard and
23display screen.
24.Pp
25Output to a virtual console that not currently is on the display is
26saved in a buffer that holds a "screenfull" (normally 25) lines.
27Any output written to
28.Pa /dev/console
29(the original console device) is echoed to
30.Pa /dev/ttyv0 .
31.Pp
32To switch between the virtual consoles one uses the sequence
33.Em ALT+Fn ,
34which means hold down ALT and press one of the function keys.
35The
36virtual console with the same number as the function key is then
37selected as the current virtual console, and given exclusive use of
38the keyboard and display.
39This switch sequence can be changed via
40the keyboard mapping ioctl call (see
41.Xr keyboard 4 ) .
42.Pp
43The console allows entering values that are not physically
44present on the keyboard via a special keysequence.
45To use this facility press and hold down ALT,
46then enter a decimal number from 0-255 via the numerical keypad, then
47release ALT.
48The entered value is then used as the ASCII value for one
49character.
50This way it is possible to enter any ASCII value.
51The console driver also includes a history function.
52It is activated by
53pressing the scroll-lock key.
54This holds the display, and enables the cursor
55arrows for scrolling up and down through the last scrolled out lines.
56.Pp
57The console understands a subset of the ANSI x3.64 character
58sequences.
59For compatibility with the old pccons, the PC3 character
60sequences is also supported.
61.Pp
62.Bd -literal
63ANSI	Seq	Function				Termcap entry
64======= ======= =====================================   ==============
65
66--	E7	Save cursor position			sc
67
68--	E8	Restore	saved cursor position		rc
69
70--	Ec	Reset					rs
71
72--	EM	move cursor up 1 line,			--
73		scroll if at top
74
75CUU     E[nA    move cursor up n lines                  up/UP (ku)
76
77CUD     E[nB    move cursor down n lines                do/DO (kd)
78
79CUF     E[nC    move cursor right n characters          nd/RI (kr)
80
81CUB     E[nD    move cursor left n characters           --/LE (kl)
82
83HPA     E[n`    move cursor to character position n     ch
84
85HPR	E[na	move cursor right n characters 		--
86
87VPA     E[nd    move cursor to line n                   cv
88
89VPR	E[ne	move cursor down n lines		--
90
91CPL     E[nF    move cursor to start of line,           -- (@7)
92		n lines up
93
94CNL     E[nE    move cursor to start of line,           nw
95		n lines down
96
97CUP	E[y;xH	Move cursor to x, y			cm
98
99HVP	E[y;xf	Move cursor to x, y			--
100
101CBT     E[nZ    Move cursor back n tab stops            bt (kB)
102
103IL      E[nL    Insert n blank lines                    al/AL
104
105ICH     E[n@    Insert n blank characters               ic/IC
106
107DL      E[nM    Delete n lines                          dl/DL
108
109DCH     E[nP    Delete n characters                     dc/DC
110
111ED	E[nJ	Erase part or all of display:		cd
112		n=0 from cursor to end of display,
113		n=1 from begin of display to cursor,
114		n=2 entire display.
115
116EL	E[nK	Erase part or all of line:		ce
117		n=0 from cursor to end of line,
118		n=1 from begin of line to cursor,
119		n=2 entire line.
120
121ECH     E[nX    Erase n characters                      ec
122
123SU      E[nS    Scroll display n lines up (forward)     sf/SF
124
125SD      E[nT    Scroll display n lines down (reverse)   sr/SR
126
127
128SGR	E[nm	Set character attributes:		--
129		n= 0  normal attribute (all off)
130		n= 1  bold (highlight)
131		n= 4  underscore (if supported by HW)
132		n= 5  blink (if supported by HW)
133		n= 7  reverse
134		n= 22 remove bold
135		n= 24 remove underscore
136		n= 25 remove blink
137		n= 27 remove reverse
138		n= 3X set ANSI foreground color
139		      (see table)
140		n= 4X set ANSI background color
141		      (see table)
142
143		   X=0 black 	X=1 red
144		   X=2 green	X=3 brown
145		   X=4 blue	X=5 magenta
146		   X=6 cyan	X=7 light grey
147		   X=9 reset to the normal color
148
149--	E[s	Save cursor position			sc
150
151--	E[u	Restore	saved cursor position		rc
152
153--      E[x     Reset normal colors and attributes      --
154		to their default values
155
156--	E[nz	Switch to virtual console n		--
157
158--      E[1;nx  Set normal ANSI background color        --
159		to n (see table)
160
161--      E[2;nx  Set normal ANSI foreground color        --
162		to n (see table)
163
164--      E[3;nx  Set normal video attribute directly     --
165		to n (n	from 0 to 255)
166
167--      E[5;nx  Set normal ANSI reverse background      --
168		color to n (see	table)
169
170--      E[6;nx  Set normal ANSI reverse foreground      --
171		color to n (see	table)
172
173		   n= 0	black	   n= 8	dark grey
174		   n= 1	red	   n= 9	light red
175		   n= 2	green	   n=10	light green
176		   n= 3	brown	   n=11	yellow
177		   n= 4	blue	   n=12	light blue
178		   n= 5	magenta	   n=13	light magenta
179		   n= 6	cyan	   n=14	light cyan
180		   n= 7	light grey n=15	white
181
182--      E[7;nx  Set normal reverse video attribute      --
183		directly to n (n from 0	to 255)
184
185--	E[=p;dB	Set bell pitch (p) and duration (d),	--
186			pitch is in units of 840 nS,
187			duration is units of 0,1 S.
188
189--	E[=tC	Set cursor type (see table)		--
190
191		   t=0 normal non-blinking
192		   t=1 normal blinking
193		   t=2 custom non-blinking
194		   t=3 custom blinking
195
196--	E[=s;eC	Set custom cursor shape, where		--
197		s is the starting and e is the ending
198		scanlines of the cursor.
199
200--      E[=nA   Set the border color to n               --
201		(see table) (if supported by HW)
202
203--      E[=nF   Set normal foreground color to n        --
204		(see table)
205
206--      E[=nG   Set normal background color to n        --
207		(see table)
208
209--      E[=nH   Set normal reverse foreground color     --
210		to n (see table)
211
212--      E[=nI   Set normal reverse background color     --
213		to n (see table)
214
215		   n= 0	black	   n= 8	dark grey
216		   n= 1	blue	   n= 9	light blue
217		   n= 2	green	   n=10	light green
218		   n= 3	cyan	   n=11	light cyan
219		   n= 4	red	   n=12	light red
220		   n= 5	magenta	   n=13	light magenta
221		   n= 6	brown	   n=14	yellow
222		   n= 7	light grey n=15	white
223
224note: the first E in the sequences stands for ESC (0x1b)
225.Ed
226.Sh AUTHORS
227.An S\(/oren Schmidt Aq sos@FreeBSD.org
228