diff options
Diffstat (limited to 'static/freebsd/man4/syscons.4 3.html')
| -rw-r--r-- | static/freebsd/man4/syscons.4 3.html | 519 |
1 files changed, 519 insertions, 0 deletions
diff --git a/static/freebsd/man4/syscons.4 3.html b/static/freebsd/man4/syscons.4 3.html new file mode 100644 index 00000000..7d000095 --- /dev/null +++ b/static/freebsd/man4/syscons.4 3.html @@ -0,0 +1,519 @@ +<table class="head"> + <tr> + <td class="head-ltitle">SYSCONS(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">SYSCONS(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">syscons</code>, <code class="Nm">sc</code> + — <span class="Nd">the legacy console driver</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp"><code class="Cd">options MAXCONS=N</code> + <br/> + <code class="Cd">options SC_ALT_MOUSE_IMAGE</code> + <br/> + <code class="Cd">options SC_CUT_SEPCHARS=_characters_</code> + <br/> + <code class="Cd">options SC_CUT_SPACES2TABS</code> + <br/> + <code class="Cd">options SC_DFLT_TERM</code> + <br/> + <code class="Cd">options SC_DISABLE_KDBKEY</code> + <br/> + <code class="Cd">options SC_DISABLE_REBOOT</code> + <br/> + <code class="Cd">options SC_HISTORY_SIZE=N</code> + <br/> + <code class="Cd">options SC_MOUSE_CHAR=C</code> + <br/> + <code class="Cd">options SC_NO_CUTPASTE</code> + <br/> + <code class="Cd">options SC_NO_FONT_LOADING</code> + <br/> + <code class="Cd">options SC_NO_HISTORY</code> + <br/> + <code class="Cd">options SC_NO_PALETTE_LOADING</code> + <br/> + <code class="Cd">options SC_NO_SUSPEND_VTYSWITCH</code> + <br/> + <code class="Cd">options SC_NO_SYSMOUSE</code> + <br/> + <code class="Cd">options SC_NO_TERM_DUMB</code> + <br/> + <code class="Cd">options SC_NO_TERM_SC</code> + <br/> + <code class="Cd">options SC_NO_TERM_SCTEKEN</code> + <br/> + <code class="Cd">options SC_PIXEL_MODE</code> + <br/> + <code class="Cd">options SC_TWOBUTTON_MOUSE</code> + <br/> + <code class="Cd">options SC_NORM_ATTR=_attribute_</code> + <br/> + <code class="Cd">options SC_NORM_REV_ATTR=_attribute_</code> + <br/> + <code class="Cd">options SC_KERNEL_CONS_ATTR=_attribute_</code> + <br/> + <code class="Cd">options SC_KERNEL_CONS_ATTRS=_attributes_</code> + <br/> + <code class="Cd">options SC_KERNEL_CONS_REV_ATTR=_attribute_</code> + <br/> + <code class="Cd">options SC_DFLT_FONT</code> + <br/> + <code class="Cd">makeoptions SC_DFLT_FONT=_font_name_</code> + <br/> + <code class="Cd">device sc</code></p> +<p class="Pp">In <span class="Pa">/boot/device.hints</span>: + <br/> + <code class="Cd">hint.sc.0.at="isa"</code> + <br/> + <code class="Cd">hint.sc.0.vesa_mode=0x103</code></p> +<p class="Pp">In <span class="Pa">/boot/loader.conf</span>: + <br/> + <code class="Cd">kern.vty=sc</code></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DEPRECATION_NOTICE"><a class="permalink" href="#DEPRECATION_NOTICE">DEPRECATION + NOTICE</a></h1> +<p class="Pp">The <code class="Nm">syscons</code> console is deprecated, and + will be removed in a future version of <span class="Ux">FreeBSD</span>. + Users are advised to migrate to the <a class="Xr">vt(4)</a> console + instead.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">syscons</code> driver provides multiple + virtual terminals. It resembles the SCO color console driver.</p> +<p class="Pp">Note that the <code class="Nm">syscons</code> driver is not + compatible with systems booted via <a class="Xr">UEFI(8)</a>. Forcing use of + <code class="Nm">syscons</code> on such systems will result in no usable + console.</p> +<p class="Pp">The <code class="Nm">syscons</code> driver is implemented on top + of the keyboard driver (<a class="Xr">atkbd(4)</a>) and the video card + driver (<a class="Xr">vga(4)</a>) and so requires both of them to be + configured in the system.</p> +<p class="Pp">There can be only one <code class="Nm">syscons</code> device + defined in the system.</p> +<section class="Ss"> +<h2 class="Ss" id="Virtual_Terminals"><a class="permalink" href="#Virtual_Terminals">Virtual + Terminals</a></h2> +<p class="Pp">The <code class="Nm">syscons</code> driver provides multiple + virtual terminals which appear as if they were separate terminals. One + virtual terminal is considered current and exclusively occupies the screen + and the keyboard; the other virtual terminals are placed in the + background.</p> +<p class="Pp">In order to use virtual terminals, they must be individually + marked ``on'' in <span class="Pa">/etc/ttys</span> so that + <a class="Xr">getty(8)</a> will recognize them to be active and run + <a class="Xr">login(1)</a> to let the user log in to the system. By default, + only the first eight virtual terminals are activated in + <span class="Pa">/etc/ttys</span>.</p> +<p class="Pp">You press the <code class="Dv">Alt</code> key and a switch key to + switch between virtual terminals. The following table summarizes the + correspondence between the switch key and the virtual terminal.</p> +<div class="Bd Pp Bd-indent Li"> +<pre>Alt-F1 ttyv0 Alt-F7 ttyv6 Shift-Alt-F1 ttyva +Alt-F2 ttyv1 Alt-F8 ttyv7 Shift-Alt-F2 ttyvb +Alt-F3 ttyv2 Alt-F9 ttyv8 Shift-Alt-F3 ttyvc +Alt-F4 ttyv3 Alt-F10 ttyv9 Shift-Alt-F4 ttyvd +Alt-F5 ttyv4 Alt-F11 ttyva Shift-Alt-F5 ttyve +Alt-F6 ttyv5 Alt-F12 ttyvb Shift-Alt-F6 ttyvf</pre> +</div> +<p class="Pp">You can also use the ``nscr'' key (usually the + <code class="Dv">PrintScreen</code> key on the AT Enhanced keyboard) to + cycle available virtual terminals.</p> +<p class="Pp">The default number of available virtual terminals is 16. This can + be changed with the kernel configuration option + <code class="Dv">MAXCONS</code> (see below).</p> +<p class="Pp">Note that the X server usually requires a virtual terminal for + display purposes, so at least one terminal must be left unused by + <a class="Xr">getty(8)</a> so that it can be used by the X server.</p> +</section> +<section class="Ss"> +<h2 class="Ss" id="Key_Definitions_and_Function_Key_Strings"><a class="permalink" href="#Key_Definitions_and_Function_Key_Strings">Key + Definitions and Function Key Strings</a></h2> +<p class="Pp">The <code class="Nm">syscons</code> driver, in conjunction with + the keyboard driver, allows the user to change key definitions and function + key strings. The <a class="Xr">kbdcontrol(1)</a> command will load a key + definition file (known as ``keymap'' file), dump the current keymap, and + assign a string to a function key. See <a class="Xr">keyboard(4)</a> and + <a class="Xr">kbdmap(5)</a> for the keymap file.</p> +<p class="Pp">You may want to set the <var class="Ar">keymap</var> variable in + <span class="Pa">/etc/rc.conf.local</span> to the desired keymap file so + that it will be automatically loaded when the system starts up.</p> +</section> +<section class="Ss"> +<h2 class="Ss" id="Software_Font"><a class="permalink" href="#Software_Font">Software + Font</a></h2> +<p class="Pp">For most modern video cards, e.g., VGA, the + <code class="Nm">syscons</code> driver and the video card driver allow the + user to change the font used on the screen. The + <a class="Xr">vidcontrol(1)</a> command can be used to load a font file from + <span class="Pa">/usr/share/syscons/fonts</span>.</p> +<p class="Pp">The font comes in various sizes: 8x8, 8x14 and 8x16. The 8x16 font + is typically used for the VGA card in the 80-column-by-25-line mode. Other + video modes may require different font sizes. It is better to always load + all three sizes of the same font.</p> +<p class="Pp">You may set <var class="Ar">font8x8</var>, + <var class="Ar">font8x14</var> and <var class="Ar">font8x16</var> variables + in <span class="Pa">/etc/rc.conf</span> to the desired font files so that + they will be automatically loaded when the system starts up.</p> +<p class="Pp">Optionally you can specify a particular font file as the default. + See the <code class="Dv">SC_DFLT_FONT</code> option below.</p> +</section> +<section class="Ss"> +<h2 class="Ss" id="Screen_Map"><a class="permalink" href="#Screen_Map">Screen + Map</a></h2> +<p class="Pp">If your video card does not support software fonts, you may still + be able to achieve a similar effect by re-mapping the font built into your + video card. Use <a class="Xr">vidcontrol(1)</a> to load a screen map file + which defines the mapping between character codes.</p> +</section> +<section class="Ss"> +<h2 class="Ss" id="Mouse_Support_and_Copy-and-Paste"><a class="permalink" href="#Mouse_Support_and_Copy-and-Paste">Mouse + Support and Copy-and-Paste</a></h2> +<p class="Pp">You can use your mouse to copy text on the screen and paste it as + if it was typed by hand. You must be running the mouse daemon + <a class="Xr">moused(8)</a> and enable the mouse cursor in the virtual + terminal via <a class="Xr">vidcontrol(1)</a>.</p> +<p class="Pp">Pressing mouse button 1 (usually the left button) will start + selection. Releasing button 1 will end the selection process. The selected + text will be marked by inverting foreground and background colors. You can + press button 3 (usually the right button) to extend the selected region. The + selected text is placed in the copy buffer and can be pasted at the cursor + position by pressing button 2 (usually the middle button) as many times as + you like.</p> +<p class="Pp">If your mouse has only two buttons, you may want to use the + <code class="Dv">SC_TWOBUTTON_MOUSE</code> option below to make the right + button to paste the text. Alternatively you can make the mouse daemon + emulate the middle button. See the man page for <a class="Xr">moused(8)</a> + for more details.</p> +</section> +<section class="Ss"> +<h2 class="Ss" id="Back_Scrolling"><a class="permalink" href="#Back_Scrolling">Back + Scrolling</a></h2> +<p class="Pp">The <code class="Nm">syscons</code> driver allows the user to + browse the output which has ``scrolled off'' the top of the screen.</p> +<p class="Pp">Press the ``slock'' key (usually <code class="Dv">ScrllLock</code> + / <code class="Dv">Scroll Lock</code> or <code class="Dv">Pause</code> on + many keyboards) and the terminal is in the ``scrollback'' mode. It is + indicated by the <code class="Dv">Scroll Lock</code> LED. Use the arrow + keys, the <code class="Dv">Page Up/Down</code> keys and the + <code class="Dv">Home/End</code> keys to scroll buffered terminal output. + Press the ``slock'' key again to get back to the normal terminal mode.</p> +<p class="Pp">The size of the scrollback buffer can be set by the + <code class="Dv">SC_HISTORY_SIZE</code> option described below.</p> +</section> +<section class="Ss"> +<h2 class="Ss" id="Screen_Saver"><a class="permalink" href="#Screen_Saver">Screen + Saver</a></h2> +<p class="Pp">The <code class="Nm">syscons</code> driver can be made to put up + the screen saver if the current virtual terminal is idle, that is, the user + is not typing on the keyboard nor moving the mouse. See + <a class="Xr">splash(4)</a> and <a class="Xr">vidcontrol(1)</a> for more + details.</p> +</section> +</section> +<section class="Sh"> +<h1 class="Sh" id="DRIVER_CONFIGURATION"><a class="permalink" href="#DRIVER_CONFIGURATION">DRIVER + CONFIGURATION</a></h1> +<section class="Ss"> +<h2 class="Ss" id="Kernel_Configuration_Options"><a class="permalink" href="#Kernel_Configuration_Options">Kernel + Configuration Options</a></h2> +<p class="Pp">The following kernel configuration options control the + <code class="Nm">syscons</code> driver.</p> +<dl class="Bl-tag"> + <dt id="MAXCONS=N"><a class="permalink" href="#MAXCONS=N"><code class="Dv">MAXCONS=N</code></a></dt> + <dd>This option sets the number of virtual terminals to + <var class="Fa">N</var>. The default value is 16.</dd> + <dt id="SC_ALT_MOUSE_IMAGE"><a class="permalink" href="#SC_ALT_MOUSE_IMAGE"><code class="Dv">SC_ALT_MOUSE_IMAGE</code></a></dt> + <dd>This option selects the alternative way of displaying the mouse cursor in + the virtual terminal. It may be expensive for some video cards to draw the + arrow-shaped cursor, and you may want to try this option. However, the + appearance of the alternative mouse cursor may not be very appealing. Note + that if you use the <code class="Dv">SC_NO_FONT_LOADING</code> option then + you must also use this option if you wish to be able to use the + mouse.</dd> + <dt id="SC_CUT_SEPCHARS=_characters_"><a class="permalink" href="#SC_CUT_SEPCHARS=_characters_"><code class="Dv">SC_CUT_SEPCHARS=_characters_</code></a></dt> + <dd>This options specifies characters that will be looked for when the driver + searches for words boundaries when doing cut operation. By default, its + value is "<code class="Li">\x20</code>" — a space + character.</dd> + <dt id="SC_CUT_SPACES2TABS"><a class="permalink" href="#SC_CUT_SPACES2TABS"><code class="Dv">SC_CUT_SPACES2TABS</code></a></dt> + <dd>This options instructs the driver to convert leading spaces into tabs when + copying data into cut buffer. This might be useful to preserve indentation + when copying tab-indented text.</dd> + <dt id="SC_DFLT_TERM=_name_"><a class="permalink" href="#SC_DFLT_TERM=_name_"><code class="Dv">SC_DFLT_TERM=_name_</code></a></dt> + <dd>This option specifies the name of the preferred terminal emulator.</dd> + <dt id="SC_DISABLE_KDBKEY"><a class="permalink" href="#SC_DISABLE_KDBKEY"><code class="Dv">SC_DISABLE_KDBKEY</code></a></dt> + <dd>This option disables the ``debug'' key combination (by default, it is + <code class="Dv">Alt-Esc</code>, or + <code class="Dv">Ctl-PrintScreen</code>). It will prevent users from + entering the kernel debugger (KDB) by pressing the key combination. KDB + will still be invoked when the kernel panics or hits a break point if it + is included in the kernel. If this option is not defined, this behavior + may be controlled at runtime by the <a class="Xr">sysctl(8)</a> variable + <var class="Va">hw.syscons.kbd_debug</var>.</dd> + <dt id="SC_DISABLE_REBOOT"><a class="permalink" href="#SC_DISABLE_REBOOT"><code class="Dv">SC_DISABLE_REBOOT</code></a></dt> + <dd>This option disables the ``reboot'' key (by default, it is + <code class="Dv">Ctl-Alt-Del</code>), so that the casual user may not + accidentally reboot the system. If this option is not defined, this + behavior may be controlled at runtime by the <a class="Xr">sysctl(8)</a> + variable <var class="Va">hw.syscons.kbd_reboot</var>.</dd> + <dt id="SC_HISTORY_SIZE=N"><a class="permalink" href="#SC_HISTORY_SIZE=N"><code class="Dv">SC_HISTORY_SIZE=N</code></a></dt> + <dd>Sets the size of back scroll buffer to <var class="Fa">N</var> lines. The + default value is 100.</dd> + <dt id="SC_MOUSE_CHAR=C"><a class="permalink" href="#SC_MOUSE_CHAR=C"><code class="Dv">SC_MOUSE_CHAR=C</code></a></dt> + <dd>Unless the <code class="Dv">SC_ALT_MOUSE_IMAGE</code> option above is + specified, the <code class="Nm">syscons</code> driver reserves four + consecutive character codes in order to display the mouse cursor in the + virtual terminals in some systems. This option specifies the first + character code to <var class="Fa">C</var> to be used for this purpose. The + default value is 0xd0. A good candidate is 0x03.</dd> + <dt id="SC_PIXEL_MODE"><a class="permalink" href="#SC_PIXEL_MODE"><code class="Dv">SC_PIXEL_MODE</code></a></dt> + <dd>Adds support for pixel (raster) mode console. This mode is useful on some + laptop computers, but less so on most other systems, and it adds + substantial amount of code to syscons. If this option is NOT defined, you + can reduce the kernel size a lot. See the <code class="Dv">VESAMODE</code> + flag below.</dd> + <dt id="SC_TWOBUTTON_MOUSE"><a class="permalink" href="#SC_TWOBUTTON_MOUSE"><code class="Dv">SC_TWOBUTTON_MOUSE</code></a></dt> + <dd>If you have a two button mouse, you may want to add this option to use the + right button of the mouse to paste text. See + <a class="Sx" href="#Mouse_Support_and_Copy_and_Paste">Mouse Support and + Copy-and-Paste</a> above.</dd> + <dt id="SC_NORM_ATTR=_attribute_"><a class="permalink" href="#SC_NORM_ATTR=_attribute_"><code class="Dv">SC_NORM_ATTR=_attribute_</code></a></dt> + <dd style="width: auto;"> </dd> + <dt id="SC_NORM_REV_ATTR=_attribute_"><a class="permalink" href="#SC_NORM_REV_ATTR=_attribute_"><code class="Dv">SC_NORM_REV_ATTR=_attribute_</code></a></dt> + <dd style="width: auto;"> </dd> + <dt id="SC_KERNEL_CONS_ATTR=_attribute_"><a class="permalink" href="#SC_KERNEL_CONS_ATTR=_attribute_"><code class="Dv">SC_KERNEL_CONS_ATTR=_attribute_</code></a></dt> + <dd style="width: auto;"> </dd> + <dt id="SC_KERNEL_CONS_ATTRS=_attributes_"><a class="permalink" href="#SC_KERNEL_CONS_ATTRS=_attributes_"><code class="Dv">SC_KERNEL_CONS_ATTRS=_attributes_</code></a></dt> + <dd style="width: auto;"> </dd> + <dt id="SC_KERNEL_CONS_REV_ATTR=_attribute_"><a class="permalink" href="#SC_KERNEL_CONS_REV_ATTR=_attribute_"><code class="Dv">SC_KERNEL_CONS_REV_ATTR=_attribute_</code></a></dt> + <dd>These options will set the default colors. Available colors are defined in + <code class="In"><<a class="In">machine/pc/display.h</a>></code>. + See <a class="Sx" href="#EXAMPLES">EXAMPLES</a> below. + <code class="Dv">SC_KERNEL_CONS_ATTRS</code> is a character string giving + a sequence of attributes in binary format. The sequence will be repeated + up to the number of CPUs. Beware that the string must not be null, since + the kernel divides by its length.</dd> + <dt id="SC_DFLT_FONT"><a class="permalink" href="#SC_DFLT_FONT"><code class="Dv">SC_DFLT_FONT</code></a></dt> + <dd>This option will specify the default font. Available fonts are: iso, iso2, + koi8-r, koi8-u, cp437, cp850, cp865, cp866 and cp866u. 16-line, 14-line + and 8-line font data will be compiled in. Without this option, the + <code class="Nm">syscons</code> driver will use whatever font is already + loaded in the video card, unless you explicitly load a software font at + startup. See <a class="Sx" href="#EXAMPLES">EXAMPLES</a> below.</dd> + <dt id="SC_NO_SUSPEND_VTYSWITCH"><a class="permalink" href="#SC_NO_SUSPEND_VTYSWITCH"><code class="Dv">SC_NO_SUSPEND_VTYSWITCH</code></a></dt> + <dd>This option, which is also available as <a class="Xr">loader(8)</a> + tunable and <a class="Xr">sysctl(8)</a> variable + <var class="Va">hw.syscons.sc_no_suspend_vtswitch</var>, disables + switching between virtual terminals (graphics <-> text) during + suspend/resume (ACPI and APM). Use this option if your system is freezing + when you are running X and trying to suspend.</dd> +</dl> +<p class="Pp">The following options will remove some features from the + <code class="Nm">syscons</code> driver and save kernel memory.</p> +<dl class="Bl-tag"> + <dt id="SC_NO_CUTPASTE"><a class="permalink" href="#SC_NO_CUTPASTE"><code class="Dv">SC_NO_CUTPASTE</code></a></dt> + <dd>This option disables ``copy and paste'' operation in virtual + terminals.</dd> + <dt id="SC_NO_FONT_LOADING"><a class="permalink" href="#SC_NO_FONT_LOADING"><code class="Dv">SC_NO_FONT_LOADING</code></a></dt> + <dd>The <code class="Nm">syscons</code> driver can load software fonts on some + video cards. This option removes this feature. Note that if you still wish + to use the mouse with this option then you must also use the + <code class="Dv">SC_ALT_MOUSE_IMAGE</code> option.</dd> + <dt id="SC_NO_HISTORY"><a class="permalink" href="#SC_NO_HISTORY"><code class="Dv">SC_NO_HISTORY</code></a></dt> + <dd>This option disables back-scrolling in virtual terminals.</dd> + <dt id="SC_NO_SYSMOUSE"><a class="permalink" href="#SC_NO_SYSMOUSE"><code class="Dv">SC_NO_SYSMOUSE</code></a></dt> + <dd>This option removes mouse support in the <code class="Nm">syscons</code> + driver. The mouse daemon <a class="Xr">moused(8)</a> will fail if this + option is defined. This option implies the + <code class="Dv">SC_NO_CUTPASTE</code> option too.</dd> + <dt id="SC_NO_TERM_DUMB"><a class="permalink" href="#SC_NO_TERM_DUMB"><code class="Dv">SC_NO_TERM_DUMB</code></a></dt> + <dd style="width: auto;"> </dd> + <dt id="SC_NO_TERM_SC"><a class="permalink" href="#SC_NO_TERM_SC"><code class="Dv">SC_NO_TERM_SC</code></a></dt> + <dd style="width: auto;"> </dd> + <dt id="SC_NO_TERM_SCTEKEN"><a class="permalink" href="#SC_NO_TERM_SCTEKEN"><code class="Dv">SC_NO_TERM_SCTEKEN</code></a></dt> + <dd>These options remove the "dumb", "sc", and + "scteken" terminal emulators, respectively.</dd> +</dl> +</section> +<section class="Ss"> +<h2 class="Ss" id="Driver_Flags"><a class="permalink" href="#Driver_Flags">Driver + Flags</a></h2> +<p class="Pp">The following driver flags can be used to control the + <code class="Nm">syscons</code> driver. Driver flags can be set with the + <code class="Cd">hint.sc.0.flags</code> tunable, either in + <span class="Pa">/boot/device.hints</span>, or else at the loader prompt + (see <a class="Xr">loader(8)</a>).</p> +<dl class="Bl-tag"> + <dt>0x0080 (VESAMODE)</dt> + <dd>This option puts the video card in the VESA mode specified by + <span class="Pa">/boot/device.hints</span> variable + <var class="Va">vesa_mode</var> during kernel initialization. Note that in + order for this flag to work, the kernel must be compiled with the + <code class="Dv">SC_PIXEL_MODE</code> option explained above. A list of + the available mode can be obtained via + <a class="Xr">vidcontrol(1)</a>.</dd> + <dt>0x0100 (AUTODETECT_KBD)</dt> + <dd>This option instructs the syscons driver to periodically scan for a + keyboard device if it is not currently attached to one. Otherwise, the + driver only probes for a keyboard once during bootup.</dd> +</dl> +</section> +<section class="Ss"> +<h2 class="Ss" id="Loader_Tunables"><a class="permalink" href="#Loader_Tunables">Loader + Tunables</a></h2> +<p class="Pp">These settings can be entered at the <a class="Xr">loader(8)</a> + prompt or in <a class="Xr">loader.conf(5)</a>.</p> +<dl class="Bl-tag"> + <dt id="kern.vty"><var class="Va">kern.vty</var></dt> + <dd>When both <code class="Nm">syscons</code> and <a class="Xr">vt(4)</a> have + been compiled into the kernel, the one to use for the system console can + be selected by setting this variable to + ‘<code class="Li">sc</code>’ or + ‘<code class="Li">vt</code>’. The + <span class="Pa">GENERIC</span> kernel uses <a class="Xr">vt(4)</a> when + this value is not set.</dd> +</dl> +</section> +</section> +<section class="Sh"> +<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1> +<dl class="Bl-tag Bl-compact"> + <dt><span class="Pa">/dev/console</span></dt> + <dd style="width: auto;"> </dd> + <dt><span class="Pa">/dev/consolectl</span></dt> + <dd style="width: auto;"> </dd> + <dt><span class="Pa">/dev/ttyv?</span></dt> + <dd>virtual terminals</dd> + <dt><span class="Pa">/etc/ttys</span></dt> + <dd>terminal initialization information</dd> + <dt><span class="Pa">/usr/share/syscons/fonts/*</span></dt> + <dd>font files</dd> + <dt><span class="Pa">/usr/share/syscons/keymaps/*</span></dt> + <dd>key map files</dd> + <dt><span class="Pa">/usr/share/syscons/scrmaps/*</span></dt> + <dd>screen map files</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> +<p class="Pp">As the <code class="Nm">syscons</code> driver requires the + keyboard driver and the video card driver, the kernel configuration file + should contain the following lines.</p> +<div class="Bd Pp Bd-indent Li"> +<pre>device atkbdc +device atkbd +device vga +device sc +device splash</pre> +</div> +<p class="Pp">You also need the following lines in + <span class="Pa">/boot/device.hints</span> for these drivers.</p> +<div class="Bd Pp Bd-indent Li"> +<pre>hint.atkbdc.0.at="isa" +hint.atkbdc.0.port="0x060" +hint.atkbd.0.at="atkbdc" +hint.atkbd.0.irq="1" +hint.vga.0.at="isa" +hint.sc.0.at="isa"</pre> +</div> +<p class="Pp">If you do not intend to load the splash image or use the screen + saver, the last line is not necessary, and can be omitted.</p> +<p class="Pp">Note that the keyboard controller driver + <code class="Nm">atkbdc</code> is required by the keyboard driver + <code class="Nm">atkbd</code>.</p> +<p class="Pp">The following lines will set the default colors. The normal text + will be green on black background. The reversed text will be yellow on green + background. Note that you cannot put any white space inside the quoted + string, because of the current implementation of + <a class="Xr">config(8)</a>.</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">options + SC_NORM_ATTR=(FG_GREEN|BG_BLACK)</code></div> +<div class="Bd Bd-indent"><code class="Li">options + SC_NORM_REV_ATTR=(FG_YELLOW|BG_GREEN)</code></div> +<p class="Pp">The following lines will set the default colors of the kernel + message. The kernel message will be printed bright red on black background. + The reversed message will be black on red background.</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">options + SC_KERNEL_CONS_ATTR=(FG_LIGHTRED|BG_BLACK)</code></div> +<div class="Bd Bd-indent"><code class="Li">options + SC_KERNEL_CONS_REV_ATTR=(FG_BLACK|BG_RED)</code></div> +<p class="Pp">Provided <code class="Dv">SC_KERNEL_CONS_ATTR</code> is not set, + or is set to its default of bright white on black, the following line will + set 4 red-ish colors for printing kernel messages in colors depending on the + CPU.</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">options + SC_KERNEL_CONS_ATTRS=\"\x0c\x04\x40\x0e\"</code></div> +<p class="Pp">The default scheme is probably better for up to 8 CPUs. Use a long + string to get unique colors for more than 8 CPUs.</p> +<p class="Pp">To turn off all per-CPU coloring of kernel messages, set + SC_KERNEL_CONS_ATTR to a non-default value, or use the default in a pattern + of length 1.</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">options + SC_KERNEL_CONS_ATTRS=\"\x0f\"</code></div> +<p class="Pp">The following example adds the font files + <span class="Pa">cp850-8x16.fnt</span>, + <span class="Pa">cp850-8x14.font</span> and + <span class="Pa">cp850-8x8.font</span> to the kernel.</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">options SC_DFLT_FONT</code></div> +<div class="Bd Bd-indent"><code class="Li">makeoptions + SC_DFLT_FONT=cp850</code></div> +<div class="Bd Bd-indent"><code class="Li">device sc</code></div> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">kbdcontrol(1)</a>, <a class="Xr">login(1)</a>, + <a class="Xr">vidcontrol(1)</a>, <a class="Xr">atkbd(4)</a>, + <a class="Xr">atkbdc(4)</a>, <a class="Xr">keyboard(4)</a>, + <a class="Xr">screen(4)</a>, <a class="Xr">splash(4)</a>, + <a class="Xr">ukbd(4)</a>, <a class="Xr">vga(4)</a>, + <a class="Xr">vt(4)</a>, <a class="Xr">kbdmap(5)</a>, + <a class="Xr">rc.conf(5)</a>, <a class="Xr">ttys(5)</a>, + <a class="Xr">config(8)</a>, <a class="Xr">getty(8)</a>, + <a class="Xr">kldload(8)</a>, <a class="Xr">moused(8)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Nm">syscons</code> driver first appeared in + <span class="Ux">FreeBSD 1.0</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp">The <code class="Nm">syscons</code> driver was written by + <span class="An">Søren Schmidt</span> + <<a class="Mt" href="mailto:sos@FreeBSD.org">sos@FreeBSD.org</a>>. + This manual page was written by <span class="An">Kazutaka Yokota</span> + <<a class="Mt" href="mailto:yokota@FreeBSD.org">yokota@FreeBSD.org</a>>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1> +<p class="Pp">The amount of data that is possible to insert from the cut buffer + is limited by the {<code class="Dv">MAX_INPUT</code>}, a system limit on the + number of bytes that may be stored in the terminal input queue - usually + 1024 bytes (see <a class="Xr">termios(4)</a>).</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1> +<p class="Pp">This manual page is incomplete and urgently needs revision.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">November 2, 2024</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |