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