share/man/man4/vt.4

   1 .\" Copyright (c) 2014 Warren Block
   2 .\" All rights reserved.
   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 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd June 27, 2014
  28 .Dt "VIRTUAL TERMINALS" 4
  29 .Os
  30 .Sh NAME
  31 .Nm vt
  32 .Nd virtual terminal console driver
  33 .Sh SYNOPSIS
  34 .Cd "options TERMINAL_KERN_ATTR=_attribute_"
  35 .Cd "options TERMINAL_NORM_ATTR=_attribute_"
  36 .Cd "options VT_MAXWINDOWS=N"
  37 .Cd "options VT_ALT_TO_ESC_HACK=1"
  38 .Cd "options VT_TWOBUTTON_MOUSE"
  39 .Cd "options VT_FB_DEFAULT_WIDTH=X"
  40 .Cd "options VT_FB_DEFAULT_HEIGHT=Y"
  41 .Cd "options SC_NO_CUTPASTE"
  42 .Cd "device vt"
  43 .Pp
  44 In
  45 .Xr loader.conf 5 :
  46 .Cd hw.vga.textmode=1
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 device provides multiple virtual terminals with an extensive feature
  51 set:
  52 .Bl -item -offset indent
  53 .It
  54 Unicode UTF-8 text with double-width characters.
  55 .It
  56 Large font maps in graphics mode, including support for Asian
  57 character sets.
  58 .It
  59 Graphics-mode consoles.
  60 .It
  61 Integration with
  62 KMS
  63 .Pq Kernel Mode Setting
  64 video drivers for switching between the
  65 .Em X Window System
  66 and virtual terminals.
  67 .El
  68 .Ss Virtual Terminals
  69 Multiple virtual terminals are provided on a single computer.
  70 Up to sixteen virtual terminals can be defined.
  71 A single virtual terminal is connected to the screen and keyboard
  72 at a time.
  73 Key combinations are used to select a virtual terminal.
  74 Alt-F1 through Alt-F12 correspond to the first twelve virtual terminals.
  75 If more than twelve virtual terminals are created, Shift-Alt-F1 through
  76 Shift-Alt-F4 are used to switch to the additional terminals.
  77 .Ss Copying and Pasting Text with a Mouse
  78 Copying and pasting text from the screen with a mouse is supported.
  79 Press and hold down mouse button 1, usually the left button, while
  80 moving the mouse to select text.
  81 Selected text is highlighted with reversed foreground and background
  82 colors.
  83 To select more text after releasing mouse button 1, press mouse button
  84 3, usually the right button.
  85 To paste text that has been selected, press mouse button 2, usually the
  86 middle button.
  87 The text is entered as if it were typed at the keyboard.
  88 The
  89 .Dv VT_TWOBUTTON_MOUSE
  90 kernel option can be used with mice that only have two buttons.
  91 Setting this option makes the second mouse button into the
  92 paste button.
  93 See
  94 .Xr moused 8
  95 for more information.
  96 .Ss Scrolling Back
  97 Output that has scrolled off the screen can be reviewed by pressing the
  98 Scroll Lock key, then scrolling up and down with the arrow keys.
  99 The Page Up and Page Down keys scroll up or down a full screen at a
 100 time.
 101 The Home and End keys jump to the beginning or end of the scrollback
 102 buffer.
 103 When finished reviewing, press the Scroll Lock key again to return to
 104 normal use.
 105 .Sh DRIVER CONFIGURATION
 106 .Ss Kernel Configuration Options
 107 These kernel options control the
 108 .Nm
 109 driver.
 110 .Bl -tag -width MAXCONS
 111 .It Dv TERMINAL_NORM_ATTR=_attribute_
 112 .It Dv TERMINAL_KERN_ATTR=_attribute_
 113 These options allow to change the default colors used for normal and kernel
 114 text respectively.
 115 Available colors are defined in
 116 .In sys/terminal.h .
 117 See
 118 .Sx EXAMPLES
 119 below.
 120 .It Dv VT_MAXWINDOWS=N
 121 Set the number of virtual terminals to be created to
 122 .Fa N .
 123 The value defaults to 12.
 124 .It Dv VT_ALT_TO_ESC_HACK=1
 125 When the Alt key is held down while pressing another key, send an ESC
 126 sequence instead of the Alt key.
 127 .It Dv VT_TWOBUTTON_MOUSE
 128 If defined, swap the functions of mouse buttons 2 and 3.
 129 In effect, this makes the right-hand mouse button perform a paste.
 130 These options are checked in the order shown.
 131 .It Dv SC_NO_CUTPASTE
 132 Disable mouse support.
 133 .It VT_FB_DEFAULT_WIDTH=X
 134 Set the default width to
 135 .Fa X .
 136 .It VT_FB_DEFAULT_HEIGHT=Y
 137 Set the default height to
 138 .Fa Y .
 139 .El
 140 .Sh BACKWARDS COMPATIBILITY
 141 Several options are provided for compatibility with the previous
 142 console device,
 143 .Xr sc 4 .
 144 These options will be removed in a future
 145 .Fx
 146 version.
 147 .Bl -column -offset indent ".Sy vt VT_TWOBUTTON_MOUSE" ".Sy SC_TWOBUTTON_MOUSE"
 148 .It Sy vt Option Name Ta Sy sc Option Name
 149 .It Dv TERMINAL_KERN_ATTR Ta Dv SC_KERNEL_CONS_ATTR
 150 .It Dv TERMINAL_NORM_ATTR Ta Dv SC_NORM_ATTR
 151 .It Dv VT_TWOBUTTON_MOUSE Ta Dv SC_TWOBUTTON_MOUSE
 152 .It Dv VT_MAXWINDOWS Ta Dv MAXCONS
 153 .It none Ta Dv SC_NO_CUTPASTE
 154 .El
 155 .Sh START-UP OPERATION WITH X86 BIOS SYSTEMS
 156 The computer BIOS starts in text mode, and
 157 the
 158 .Fx
 159 .Xr loader 8
 160 runs, loading the kernel.
 161 If
 162 .Va hw.vga.textmode
 163 is set, the system remains in text mode.
 164 Otherwise,
 165 .Nm
 166 switches to 640x480x16 VGA mode using
 167 .Xr vt_vga 4 .
 168 If a KMS
 169 .Pq Kernel Mode Switching
 170 video driver is available, the display is switched to high resolution
 171 and the KMS driver takes over.
 172 When a KMS driver is not available,
 173 .Xr vt_vga 4
 174 remains active.
 175 .Sh LOADER TUNABLES
 176 These settings can be entered at the
 177 .Xr loader 8
 178 prompt or in
 179 .Xr loader.conf 5 .
 180 .Bl -tag -width indent
 181 .It Va hw.vga.textmode
 182 Set to 1 to use virtual terminals in text mode instead of graphics mode.
 183 Features that require graphics mode, like loadable fonts, will be
 184 disabled.
 185 .El
 186 .Sh EXAMPLES
 187 The following line will change the default color of normal text.
 188 Normal text will be green on black background.
 189 Reversed normal text will be black on green background.
 190 Note that you cannot put any white space inside the quoted string,
 191 because of the current implementation of
 192 .Xr config 8 .
 193 .Pp
 194 .Dl "options TERMINAL_NORM_ATTR=(FG_GREEN|BG_BLACK)"
 195 .Pp
 196 The following line will change the default color of kernel messages.
 197 Kernel messages will be printed bright red on black background.
 198 Reversed kernel messages will be black on bright red background.
 199 .Pp
 200 .Dl "options TERMINAL_KERN_ATTR=(FG_LIGHTRED|BG_BLACK)"
 201 .Sh FILES
 202 .Bl -tag -width /usr/share/syscons/keymaps/* -compact
 203 .It Pa /dev/console
 204 .It Pa /dev/consolectl
 205 .It Pa /dev/ttyv*
 206 virtual terminals
 207 .It Pa /etc/ttys
 208 terminal initialization information
 209 .El
 210 .Sh SEE ALSO
 211 .Xr kbdcontrol 1 ,
 212 .Xr login 1 ,
 213 .Xr vidcontrol 1 ,
 214 .Xr atkbd 4 ,
 215 .Xr atkbdc 4 ,
 216 .Xr keyboard 4 ,
 217 .Xr screen 4 ,
 218 .Xr splash 4 ,
 219 .Xr syscons 4 ,
 220 .Xr ukbd 4 ,
 221 .Xr vga 4 ,
 222 .Xr kbdmap 5 ,
 223 .Xr rc.conf 5 ,
 224 .Xr ttys 5 ,
 225 .Xr config 8 ,
 226 .Xr getty 8 ,
 227 .Xr kbdmux 8 ,
 228 .Xr kldload 8 ,
 229 .Xr moused 8
 230 .Sh HISTORY
 231 The
 232 .Nm
 233 driver first appeared in
 234 .Fx 9.3 .
 235 .Sh AUTHORS
 236 .An -nosplit
 237 The
 238 .Nm
 239 device driver was developed by
 240 .An Ed Schouten Aq ed@FreeBSD.org ,
 241 .An Ed Maste Aq emaste@FreeBSD.org ,
 242 and
 243 .An Aleksandr Rybalko Aq ray@FreeBSD.org ,
 244 with sponsorship provided by the
 245 .Fx
 246 Foundation.
 247 This manual page was written by
 248 .An Warren Block <wblock@FreeBSD.org>.
 249 .Sh CAVEATS
 250 Paste buffer size is limited by the system value
 251 .Brq Dv MAX_INPUT ,
 252 the number of bytes that can be stored in the terminal
 253 input queue, usually 1024 bytes
 254 (see
 255 .Xr termios 4 ) .