usr.sbin/vidcontrol/vidcontrol.1

   1 .\"
   2 .\" vidcontrol - a utility for manipulating the syscons video driver
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\"     @(#)vidcontrol.1
  14 .\" $FreeBSD$
  15 .\"
  16 .Dd June 30, 1999
  17 .Dt VIDCONTROL 1
  18 .Os
  19 .Sh NAME
  20 .Nm vidcontrol
  21 .Nd a utility for manipulating the syscons console driver.
  22 .Sh SYNOPSIS
  23 .Nm
  24 .Op Fl b Ar color
  25 .Op Fl c Ar appearance
  26 .Op Fl d
  27 .Op Fl f Ar size Ar file
  28 .Op Fl g Ar geometry
  29 .Op Fl i Cm adapter | mode
  30 .Op Fl l Ar screen_map
  31 .Op Fl L
  32 .Op Fl M Ar char
  33 .Op Fl m Cm on | off
  34 .Op Fl r Ar foreground Ar background
  35 .Op Fl s Ar number
  36 .Op Fl t Ar N | Cm off
  37 .Op Fl x
  38 .Op Ar mode
  39 .Op Ar foreground Op Ar background
  40 .Op Cm show
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 command is used to set various options for the
  45 .Xr syscons 4
  46 console driver,
  47 such as video mode, colors, cursor shape, screen output map, font and screen
  48 saver timeout.
  49 .Pp
  50 The following command line options are supported:
  51 .Bl -tag -width indent
  52 .It Ar mode
  53 Select a new video mode.
  54 The modes currently recognized are:
  55 .Ar 80x25 ,
  56 .Ar 80x30 ,
  57 .Ar 80x43 ,
  58 .Ar 80x50 ,
  59 .Ar 80x60 ,
  60 .Ar 132x25 ,
  61 .Ar 132x30 ,
  62 .Ar 132x43 ,
  63 .Ar 132x50 ,
  64 .Ar 132x60 ,
  65 .Ar VGA_40x25 ,
  66 .Ar VGA_80x25 ,
  67 .Ar VGA_80x30 ,
  68 .Ar VGA_80x50 ,
  69 .Ar VGA_80x60 ,
  70 .Ar VGA_90x25 ,
  71 .Ar VGA_90x30 ,
  72 .Ar VGA_90x43 ,
  73 .Ar VGA_90x50 ,
  74 .Ar VGA_90x60 ,
  75 .Ar EGA_80x25 ,
  76 .Ar EGA_80x43 ,
  77 .Ar VESA_132x25 ,
  78 .Ar VESA_132x43 ,
  79 .Ar VESA_132x50 ,
  80 .Ar VESA_132x60 .
  81 .\"The graphic mode
  82 .\".Ar VGA_320x200
  83 .\"and
  84 The raster text mode
  85 .Ar VESA_800x600
  86 can also be chosen.
  87 See
  88 .Sx Video Mode Support
  89 below.
  90 .It Ar foreground Op Ar background
  91 Change colors when displaying text.
  92 Specify the foreground color
  93 (e.g.
  94 .Dq vidcontrol white ) ,
  95 or both a foreground and background colors
  96 (e.g.
  97 .Dq vidcontrol yellow blue ) .
  98 Use the
  99 .Cm show
 100 command below to see available colors.
 101 .It Cm show
 102 See the supported colors on a given platform.
 103 .It Fl r Ar foreground background
 104 Change reverse mode colors to
 105 .Ar foreground
 106 and
 107 .Ar background .
 108 .It Fl b Ar color
 109 Set border color to
 110 .Ar color .
 111 This option may not be always supported by the video driver.
 112 .It Fl c Cm normal | blink | destructive
 113 Change the cursor appearance.
 114 The cursor is either an inverting block
 115 .Pq Cm normal
 116 that eventually can
 117 .Cm blink .
 118 Or it can be like the old hardware cursor
 119 .Pq Cm destructive .
 120 The latter is actually a simulation.
 121 .It Fl d
 122 Print out current output screen map.
 123 .It Fl l Ar screen_map
 124 Install screen output map file from
 125 .Ar screen_map .
 126 See also
 127 .Xr syscons 4 .
 128 .It Fl L
 129 Install default screen output map.
 130 .It Fl i Cm adapter
 131 Shows info about the current video adapter.
 132 .It Fl i Cm mode
 133 Shows the possible video modes with the current video hardware.
 134 .It Fl M Ar char
 135 Sets the base character used to render the mouse pointer to
 136 .Ar char .
 137 .It Fl m Cm on | off
 138 Switch the mouse pointer
 139 .Cm on
 140 or
 141 .Cm off .
 142 Used together with the
 143 .Xr moused 8
 144 daemon for text mode cut & paste functionality.
 145 .It Fl f Ar size Ar file
 146 Load font
 147 .Ar file
 148 for
 149 .Ar size
 150 (currently, only
 151 .Cm 8x8 ,
 152 .Cm 8x14
 153 or
 154 .Cm 8x16 ) .
 155 The font file can be either uuencoded or in raw binary format.
 156 You can also use the menu-driven
 157 .Xr vidfont 1
 158 command to load the font of your choice.
 159 .Pp
 160 Note that older video cards, such as MDA and CGA, do not support
 161 software font.
 162 See also
 163 .Sx Video Mode Support
 164 and
 165 .Sx EXAMPLES
 166 below and the man page for
 167 .Xr syscons 4 .
 168 .It Fl g Ar geometry
 169 Set the
 170 .Ar geometry
 171 of the text mode for the modes with selectable
 172 geometry.  Currently only raster modes, such as
 173 .Ar VESA_800x600 ,
 174 support this option.
 175 See also
 176 .Sx Video Mode Support
 177 and
 178 .Sx EXAMPLES
 179 below.
 180 .It Fl s Ar number
 181 Set the current vty to
 182 .Ar number .
 183 .It Fl t Ar N | Cm off
 184 Set the screensaver timeout to
 185 .Ar N
 186 seconds, or turns it
 187 .Cm off .
 188 .It Fl x
 189 Use hexadecimal digits for output.
 190 .El
 191 .Ss Video Mode Support
 192 Note that not all modes listed above may be supported by the video
 193 hardware.
 194 You can verify which mode is supported by the video hardware, using the
 195 .Fl i Cm mode
 196 option.
 197 .Pp
 198 The VESA BIOS support must be linked to the kernel
 199 or loaded as a KLD module if you wish to use VESA video modes
 200 or 132 column modes
 201 .Pq see Xr vga 4 .
 202 .Pp
 203 You need to compile your kernel with the
 204 .Ar VGA_WIDTH90
 205 option if you wish to use VGA 90 column modes
 206 .Pq see Xr vga 4 .
 207 .Pp
 208 Video modes other than 25 and 30 line modes may require specific size of font.
 209 Use
 210 .Fl f
 211 option above to load a font file to the kernel.
 212 If the required size of font has not been loaded to the kernel,
 213 .Nm
 214 will fail if the user attempts to set a new video mode.
 215 .Pp
 216 .Bl -column "25 line modes" "8x16 (VGA), 8x14 (EGA)" -compact
 217 .Sy Modes Ta Sy Font size
 218 .Li 25 line modes Ta 8x16 (VGA), 8x14 (EGA)
 219 .Li 30 line modes Ta 8x16
 220 .Li 43 line modes Ta 8x8
 221 .Li 50 line modes Ta 8x8
 222 .Li 60 line modes Ta 8x8
 223 .El
 224 .Pp
 225 It is better to always load all three sizes (8x8, 8x14 and 8x16)
 226 of the same font.
 227 .Pp
 228 You may set variables in
 229 .Pa /etc/rc.conf
 230 or
 231 .Pa /etc/rc.conf.local
 232 so that desired font files will be automatically loaded
 233 when the system starts up.
 234 See below.
 235 .Pp
 236 If you want to use the raster text mode
 237 .Ar VESA_800x600 ,
 238 you need to recomile your kernel with the
 239 .Em SC_PIXEL_MODE
 240 option.  See
 241 .Xr syscons 4
 242 for more details on this kernel option.
 243 .Sh VIDEO OUTPUT CONFIGURATION
 244 .Ss Boot Time Configuration
 245 You may set the following variables in
 246 .Pa /etc/rc.conf
 247 or
 248 .Pa /etc/rc.conf.local
 249 in order to configure the video output at boot time.
 250 .Pp
 251 .Bl -tag -width foo_bar_var -compact
 252 .It Ar blanktime
 253 Sets the timeout value for the
 254 .Fl t
 255 option.
 256 .It Ar font8x16 , font8x14 , font8x8
 257 Specifies font files for the
 258 .Fl f
 259 option.
 260 .It Ar scrnmap
 261 Specifies a screen output map file for the
 262 .Fl l
 263 option.
 264 .El
 265 .Pp
 266 See
 267 .Xr rc.conf 5
 268 for more details.
 269 .Ss Driver Configuration
 270 The video card driver may let you change default configuration
 271 options, such as the default font, so that you do not need to set up
 272 the options at boot time.
 273 See video card driver manuals,
 274 .Pq e.g. Xr vga 4
 275 for details.
 276 .Sh FILES
 277 .Bl -tag -width /usr/share/syscons/scrnmaps/foo-bar -compact
 278 .It Pa /usr/share/syscons/fonts/*
 279 font files.
 280 .It Pa /usr/share/syscons/scrnmaps/*
 281 screen output map files.
 282 .El
 283 .Sh EXAMPLES
 284 If you want to load
 285 .Pa /usr/share/syscons/fonts/iso-8x16.fnt
 286 to the kernel, run
 287 .Nm
 288 as:
 289 .Pp
 290 .Dl vidcontrol -f 8x16 /usr/share/syscons/fonts/iso-8x16.fnt
 291 .Pp
 292 So long as the font file is in
 293 .Pa /usr/share/syscons/fonts ,
 294 you may abbreviate the file name as
 295 .Pa iso-8x16 :
 296 .Pp
 297 .Dl vidcontrol -f 8x16 iso-8x16
 298 .Pp
 299 Likewise, you can also abbreviate the screen output map file name for
 300 the
 301 .Fl l
 302 option if the file is found in
 303 .Pa /usr/share/syscons/scrnmaps .
 304 .Pp
 305 .Dl vidcontrol -l iso-8859-1_to_cp437
 306 .Pp
 307 The above command will load
 308 .Pa /usr/share/syscons/scrnmaps/iso-8859-1_to_cp437.scm .
 309 .Pp
 310 The following command will set-up a 100x37 raster text mode (useful for
 311 some LCD models):
 312 .Pp
 313 .Dl vidcontrol -g 100x37 VESA_800x600
 314 .Sh SEE ALSO
 315 .Xr kbdcontrol 1 ,
 316 .Xr vidfont 1 ,
 317 .Xr keyboard 4 ,
 318 .Xr screen 4 ,
 319 .Xr syscons 4 ,
 320 .Xr vga 4 ,
 321 .Xr rc.conf 5 ,
 322 .Xr kldload 8 ,
 323 .Xr moused 8
 324 .Sh AUTHORS
 325 .An S\(/oren Schmidt Aq sos@FreeBSD.org