Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / usr.sbin / pcvt / scon / scon.1
1 .\" Copyright (c) 1992, 2000 Hellmuth Michaelis
2 .\" Copyright (c) 1992, 1994 Joerg Wunsch
3 .\"
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 .\"
26 .\" Last Edit-Date: [Mon Mar 27 17:17:50 2000]
27 .\"
28 .\" $FreeBSD: src/usr.sbin/pcvt/scon/scon.1,v 1.8.2.5 2001/12/14 16:48:11 ru Exp $
29 .\" $DragonFly: src/usr.sbin/pcvt/scon/Attic/scon.1,v 1.2 2003/06/17 04:29:59 dillon Exp $
30 .\"
31 .Dd March 27, 2000
32 .Dt SCON 1
33 .Os
34 .Sh NAME
35 .Nm scon
36 .Nd controls screen modes for pcvt video driver
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl a
40 .Op Fl c Ar screenno
41 .Op Fl d Ar device
42 .Op Fl f Ar on|off
43 .Op Fl h
44 .Op Fl H
45 .Op Fl l
46 .Op Fl m
47 .Op Fl v
48 .Op Fl V
49 .Op Fl s Ar lines
50 .Nm
51 .Op Fl v
52 .Op Fl d Ar device
53 .Fl p Ar entry,red,green,blue
54 .Nm
55 .Op Fl v
56 .Op Fl d Ar device
57 .Fl p Ar default
58 .Nm
59 .Op Fl v
60 .Op Fl d Ar device
61 .Fl p Ar list
62 .Nm
63 .Op Fl v
64 .Fl t Ar timeout
65 .Nm
66 .Op Fl v
67 .Fl 1 | Fl 8
68 .Sh DESCRIPTION
69 The
70 .Nm
71 utility controls several aspects of the runtime behaviour of the pcvt vt220
72 driver.
73 .Pp
74 The options are as follows:
75 .Bl -tag -width Ds
76 .It Fl a
77 Returns a string describing the video adaptor found by pcvt, the string
78 returned could be MDA, HGC, CGA, EGA, VGA or UNKNOWN.
79 .It Fl c
80 Specify the screen number the current (displayed) screen should be switched
81 to.
82 .It Fl d
83 Specify the device filename (i.e. /dev/ttyv2) further operations specified on
84 the command line should be applied to.
85 .It Fl f
86 Some programs which silently assume 24 lines when they run on a VT220 show
87 incorrect behaviour when the terminal has really 25 lines.
88 To support full
89 VT220 behaviour, it is possible to force pcvt to select only 24 lines when
90 it is running in 25-lines pure VT mode and/or in 28-lines HP-mode.
91 The
92 .Fl f
93 option requires one additional parameter, the string 'on' or 'off' to switch
94 this mode for a virtual screen on or off respectively.
95 This mode has no effect
96 if any other vertical resolutions are selected than the two above mentioned.
97 .It Fl h
98 Prints a usage/help text.
99 .It Fl l
100 Lists the current configuration of runtime changeable options and fixed
101 parameters (such as the type of the adaptor, and in case of a VGA adaptor,
102 the Manufacturer, Chipset and 132 column support) of the output portion
103 of the pcvt driver.
104 .It Fl m
105 Returns a string describing the connected display monitor type found by pcvt,
106 the string returned can be MONO, COLOR or UNKNOWN.
107 .It Fl v
108 Specify verbose operation of the program.
109 .It Fl V
110 Switch the specified/current screen into a pure VT220 mode without recognizing
111 any HP escape sequences and without displaying function key labels.
112 .It Fl H
113 Switch the specified/current screen into a mixed HP/VT220 mode.
114 That is, that
115 in addition to the full VT220 emulation, the HP function key labels and the
116 escape sequences for handling the labels are available to the user.
117 .It Fl s
118 Specify the number of character lines on the screen.
119 Possible parameters are
120 25, 28, 35, 40, 43 or 50. To use all this screen sizes, the fonts required
121 for proper operation of a desired size have to be downloaded to the EGA/VGA
122 font ram.
123 This option is available only for EGA and VGA boards.
124 .It Fl p
125 Modify VGA palette
126 (DAC).
127 The
128 .Fl p
129 is mutually exclusive with
130 .Fl s ,
131 .Fl H ,
132 and
133 .Fl V .
134 Naturally, option
135 .Fl p
136 is available only for VGA boards.
137 Three flavors are available.
138 .Pp
139 If used with argument
140 .Dq Ar default ,
141 this flag will restore the default palette
142 (as installed by VGA ROM BIOS after hardware reset).
143 .Pp
144 If used with argument
145 .Dq Ar list ,
146 the current VGA DAC palette entries are listed.
147 Each entry contains
148 the table index, values for red, green, and blue, and if there's a
149 known name for this entry, the color name.
150 Trailing empty table
151 slots (RGB values all zero) are omitted.
152 .Pp
153 Otherwise, four comma-separated arguments are expected.
154 The first
155 denotes the number of palette entry to be modified.
156 This may be either
157 a number between 0 and 255, or the usual name of an associated color
158 (case-insensitive).
159 The following values for red, green and blue are restricted to 0 through 63
160 due to VGA DAC conventions.
161 Note that the first delimiter within such an argument may be a colon
162 .Dq \&:
163 instead of a comma
164 .Dq \&,
165 for better readability, but this violates common command argument
166 conventions.
167 Multiple
168 .Fl p
169 options may be specified if unambiguous.
170 .It Fl t
171 Specifying
172 .Fl t
173 will activate the screen saver.
174 The behaviour depends on
175 .Ar timeout :
176 if
177 .Ar timeout
178 is given as 0, the screen saver is turned off.
179 Otherwise,
180 .Ar timeout
181 is taken as a number of seconds to wait until activating the
182 screen saver.
183 NOTE: the
184 .Fl t
185 option is only available if screen saver support has been compiled into
186 the driver!
187 .It Fl 1
188 Sets 132 columns mode
189 (only available on VGA adaptors).
190 .It Fl 8
191 Sets 80 columns mode.
192 .El
193 .Pp
194 When switching between HP and VT mode, when switching the force 24 lines
195 mode on and off, or when switching between 80 and 132 columns operation,
196 the screen is cleared, the scrolling
197 region is reset and the cursor is placed in the home position.
198 .Sh EXAMPLES
199 The command
200 .Dq Li scon Fl H s Ar 28
201 places the current screen into HP mode and sets the screen size to 28x80.
202 .Pp
203 Invoking
204 .Do
205 .Li scon Fl p
206 .Ar lightgray,0,15,0
207 .Fl p
208 .Ar 0:45,45,45
209 .Dc
210 will result in green on gray output for normal text.
211 Note that normal text color is light gray, and not white as one might expect.
212 .Sh BUGS
213 the
214 .Fl c
215 and
216 .Fl d
217 options collide somehow, this will change in a future release.
218 .Sh SEE ALSO
219 .Xr cursor 1 ,
220 .Xr loadfont 1 ,
221 .Xr pcvt 4