diff --git a/usr.sbin/vidcontrol/vidcontrol.1 b/usr.sbin/vidcontrol/vidcontrol.1 index 4a6497a6e819..9d35528accc5 100644 --- a/usr.sbin/vidcontrol/vidcontrol.1 +++ b/usr.sbin/vidcontrol/vidcontrol.1 @@ -1,728 +1,732 @@ .\" .\" vidcontrol - a utility for manipulating the syscons or vt video driver .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. .\" .\" @(#)vidcontrol.1 .\" $FreeBSD$ .\" -.Dd January 19, 2016 +.Dd April 6, 2022 .Dt VIDCONTROL 1 .Os .Sh NAME .Nm vidcontrol .Nd system console control and configuration utility .Sh SYNOPSIS .Nm .Op Fl CdLHPpx .Op Fl b Ar color .Op Fl c Ar appearance .Oo .Fl f .Oo .Op Ar size .Ar file .Oc .Oc .Op Fl g Ar geometry .Op Fl h Ar size .Op Fl i Cm active | adapter | mode .Op Fl l Ar screen_map .Op Fl M Ar char .Op Fl m Cm on | off .Op Fl r Ar foreground Ar background .Op Fl S Cm on | off .Op Fl s Ar number .Op Fl T Cm xterm | cons25 .Op Fl t Ar N | Cm off .Op Ar mode .Op Ar foreground Op Ar background .Op Cm show .Sh DESCRIPTION The .Nm utility is used to set various options for the .Xr syscons 4 or .Xr vt 4 console driver, such as video mode, colors, cursor shape, screen output map, font and screen saver timeout. Only a small subset of options is supported by .Xr vt 4 . Unsupported options lead to error messages, typically including the text "Inappropriate ioctl for device". .Pp The following command line options are supported: .Bl -tag -width indent .It Ar mode Select a new video mode. The modes currently recognized are: .Ar 80x25 , .Ar 80x30 , .Ar 80x43 , .Ar 80x50 , .Ar 80x60 , .Ar 132x25 , .Ar 132x30 , .Ar 132x43 , .Ar 132x50 , .Ar 132x60 , .Ar VGA_40x25 , .Ar VGA_80x25 , .Ar VGA_80x30 , .Ar VGA_80x50 , .Ar VGA_80x60 , .Ar VGA_90x25 , .Ar VGA_90x30 , .Ar VGA_90x43 , .Ar VGA_90x50 , .Ar VGA_90x60 , .Ar EGA_80x25 , .Ar EGA_80x43 , .Ar VESA_132x25 , .Ar VESA_132x43 , .Ar VESA_132x50 , .Ar VESA_132x60 . .\"The graphic mode .\".Ar VGA_320x200 .\"and The raster text mode .Ar VESA_800x600 can also be chosen. Alternatively, a mode can be specified with its number by using a mode name of the form .Li MODE_ Ns Aq Ar NUMBER . A list of valid mode numbers can be obtained with the .Fl i Cm mode option. See .Sx Video Mode Support below. .It Ar foreground Op Ar background Change colors when displaying text. Specify the foreground color (e.g.\& .Dq vidcontrol white ) , or both a foreground and background colors (e.g.\& .Dq vidcontrol yellow blue ) . Use the .Cm show command below to see available colors. .It Cm show See the supported colors on a given platform. .It Fl b Ar color Set border color to .Ar color . This option may not be always supported by the video driver. .It Fl C Clear the history buffer. .It Fl c Ar setting Ns Op , Ns Ar setting ... Change the cursor appearance. The change is specified by a non-empty comma-separated list of .Cm setting Ns s . Each .Cm setting overrides or modifies previous ones in left to right order. .Pp The following override .Cm setting Ns s are available: .Bl -tag -width indent .It Cm normal Set to a block covering 1 character cell, with a configuration-dependent coloring that should be at worst inverse video. .It Cm destructive Set to a blinking sub-block with .Cm height scanlines starting at .Cm base . The name .Dq destructive is bad for backwards compatibility. This .Cm setting should not force destructiveness, and it now only gives destructiveness in some configurations (typically for hardware cursors in text mode). Blinking limits destructiveness. This .Cm setting should now be spelled .Cm normal , Ns Cm blink , Ns Cm noblock . A non-blinking destructive cursor would be unusable, so old versions of .Nm didn't support it, and this version doesn't have an override for it. .It Cm base Ns = Ns Ar value, Cm height Ns = Ns Ar value Set the specified scanline parameters. These parameters are only active in .Cm noblock mode. .Cm value is an integer in any base supported by .Xr strtol 3 . Setting .Cm height to 0 turns off the cursor in .Cm noblock mode. Negative .Ar value Ns s are silently ignored. Positive .Ar value Ns s are clamped to fit in the character cell when the cursor is drawn. .El .Pp The following modifier .Cm setting Ns s are available: .Bl -tag -width indent .It Cm blink , noblink Set or clear the blinking attribute. This is not quite backwards compatible. In old versions of .Nm , Cm blink was an override to a blinking block. .It Cm block , noblock Set or clear the .Cm block attribute. This attribute is the inverse of the flag .Dv CONS_CHAR_CURSOR in the implementation. It deactivates the scanline parameters, and expresses a preference for using a simpler method of implementation. Its inverse does the opposite. When the scanline parameters give a full block, this attribute reduces to a method selection bit. The .Cm block method tends to give better coloring. .It Cm hidden , nohidden Set or clear the hidden attribute. .El .Pp The following (non-sticky) flags control application of the .Cm setting Ns s : .Bl -tag -width indent .It Cm charcolors Apply .Cm base and .Cm height to the (character) cursor's list of preferred colors instead of its shape. Beware that the color numbers are raw VGA palette indexes, not ANSI color numbers. The indexes are reduced mod 8, 16 or 256, or ignored, depending on the video mode and renderer. .It Cm mousecolors Colors for the mouse cursor in graphics mode. Like .Cm charcolors , except there is no preference or sequence; .Cm base gives the mouse border color and .Cm height gives the mouse interior color. Together with .Cm charcolors , this gives 2 selection bits which select between only 3 of 4 sub-destinations of the 4 destinations selected by .Cm default and .Cm local (by ignoring .Cm mousecolors if .Cm charcolors is also set). .It Cm default Apply the changes to the default settings and then to the active settings, instead of only to the active settings. Together with .Cm local , this gives 2 selection bits which select between 4 destinations. .It Cm shapeonly Ignore any changes to the .Cm block and .Cm hidden attributes. .It Cm local Apply the changes to the current vty. The default is to apply them to a global place and copy from there to all vtys. .It Cm reset Reset everything. The default is to not reset. When the .Cm local parameter is specified, the current local settings are reset to default local settings. Otherwise, the current global settings are reset to default global settings and then copied to the current and default settings for all vtys. .It Cm show Show the current changes. .El .It Fl d Print out current output screen map. .It Xo .Fl f .Oo .Op Ar size .Ar file .Oc .Xc Load font .Ar file for .Ar size (currently, only .Cm 8x8 , .Cm 8x14 or .Cm 8x16 ) . The font file can be either uuencoded or in raw binary format. You can also use the menu-driven .Xr vidfont 1 command to load the font of your choice. .Pp .Ar Size may be omitted, in this case .Nm will try to guess it from the size of font file. .Pp When using .Xr vt 4 both .Ar size and .Ar font can be omitted, and the default font will be loaded. .Pp Note that older video cards, such as MDA and CGA, do not support software font. See also .Sx Video Mode Support and .Sx EXAMPLES below and the man page for either .Xr syscons 4 or .Xr vt 4 (depending on which driver you use). .It Fl g Ar geometry Set the .Ar geometry of the text mode for the modes with selectable geometry. Currently only raster modes, such as .Ar VESA_800x600 , support this option. See also .Sx Video Mode Support and .Sx EXAMPLES below. .It Fl h Ar size Set the size of the history (scrollback) buffer to .Ar size lines. .It Fl i Cm active Shows the active vty number. .It Fl i Cm adapter Shows info about the current video adapter. .It Fl i Cm mode Shows the possible video modes with the current video hardware. .It Fl l Ar screen_map Install screen output map file from .Ar screen_map . See also .Xr syscons 4 or .Xr vt 4 (depending on which driver you use). .It Fl L Install default screen output map. .It Fl M Ar char Sets the base character used to render the mouse pointer to .Ar char . .It Fl m Cm on | off Switch the mouse pointer .Cm on or .Cm off . Used together with the .Xr moused 8 daemon for text mode cut & paste functionality. .It Fl p Capture the current contents of the video buffer corresponding to the terminal device referred to by standard input. The .Nm utility writes contents of the video buffer to the standard output in a raw binary format. For details about that format see .Sx Format of Video Buffer Dump below. +Supported only with +.Xr syscons 4 . .It Fl P Same as .Fl p , but dump contents of the video buffer in a plain text format ignoring nonprintable characters and information about text attributes. +Supported only with +.Xr syscons 4 . .It Fl H When used with .Fl p or .Fl P , it instructs .Nm to dump full history buffer instead of visible portion of the video buffer only. .It Fl r Ar foreground background Change reverse mode colors to .Ar foreground and .Ar background . .It Fl S Cm on | off Turn vty switching on or off. When vty switching is off, attempts to switch to a different virtual terminal will fail. (The default is to permit vty switching.) This protection can be easily bypassed when the kernel is compiled with the .Dv DDB option. However, you probably should not compile the kernel debugger on a box which is supposed to be physically secure. .It Fl s Ar number Set the active vty to .Ar number . .It Fl T Cm xterm | cons25 Switch between xterm and cons25 style terminal emulation. .It Fl t Ar N | Cm off Set the screensaver timeout to .Ar N seconds, or turns it .Cm off . .It Fl x Use hexadecimal digits for output. .El .Ss Video Mode Support Note that not all modes listed above may be supported by the video hardware. You can verify which mode is supported by the video hardware, using the .Fl i Cm mode option. .Pp The VESA BIOS support must be linked to the kernel or loaded as a KLD module if you wish to use VESA video modes or 132 column modes (see .Xr vga 4 ) . .Pp You need to compile your kernel with the .Ar VGA_WIDTH90 option if you wish to use VGA 90 column modes (see .Xr vga 4 ) . .Pp Video modes other than 25 and 30 line modes may require specific size of font. Use .Fl f option above to load a font file to the kernel. If the required size of font has not been loaded to the kernel, .Nm will fail if the user attempts to set a new video mode. .Pp .Bl -column "25 line modes" "8x16 (VGA), 8x14 (EGA)" -compact .Sy Modes Ta Sy Font size .No 25 line modes Ta 8x16 (VGA), 8x14 (EGA) .No 30 line modes Ta 8x16 .No 43 line modes Ta 8x8 .No 50 line modes Ta 8x8 .No 60 line modes Ta 8x8 .El .Pp It is better to always load all three sizes (8x8, 8x14 and 8x16) of the same font. .Pp You may set variables in .Pa /etc/rc.conf or .Pa /etc/rc.conf.local so that desired font files will be automatically loaded when the system starts up. See below. .Pp If you want to use any of the raster text modes you need to recompile your kernel with the .Dv SC_PIXEL_MODE option. See .Xr syscons 4 or .Xr vt 4 (depending on which driver you use) for more details on this kernel option. .Ss Format of Video Buffer Dump The .Nm utility uses the .Xr syscons 4 .\" is it supported on vt(4)??? or .Xr vt 4 .Dv CONS_SCRSHOT .Xr ioctl 2 to capture the current contents of the video buffer. The .Nm utility writes version and additional information to the standard output, followed by the contents of the video buffer. .Pp VGA video memory is typically arranged in two byte tuples, one per character position. In each tuple, the first byte will be the character code, and the second byte is the character's color attribute. .Pp The VGA color attribute byte looks like this: .Bl -column "X:X" "<00000000>" "width" "bright foreground color" .Sy "bits# width meaning" .Li "7 1 character blinking" .Li "6:4 <0XXX0000> 3 background color" .Li "3 <0000X000> 1 bright foreground color" .Li "2:0 <00000XXX> 3 foreground color" .El .Pp Here is a list of the three bit wide base colors: .Pp .Bl -hang -offset indent -compact .It 0 Black .It 1 Blue .It 2 Green .It 3 Cyan .It 4 Red .It 5 Magenta .It 6 Brown .It 7 Light Grey .El .Pp Base colors with bit 3 (the bright foreground flag) set: .Pp .Bl -hang -offset indent -compact .It 0 Dark Grey .It 1 Light Blue .It 2 Light Green .It 3 Light Cyan .It 4 Light Red .It 5 Light Magenta .It 6 Yellow .It 7 White .El .Pp For example, the two bytes .Pp .Dl "65 158" .Pp specify an uppercase A (character code 65), blinking (bit 7 set) in yellow (bits 3:0) on a blue background (bits 6:4). .Pp The .Nm output contains a small header which includes additional information which may be useful to utilities processing the output. .Pp The first 10 bytes are always arranged as follows: .Bl -column "Byte range" "Contents" -offset indent .It Sy "Byte Range Contents" .It "1 thru 8 Literal text" Dq Li SCRSHOT_ .It "9 File format version number" .It "10 Remaining number of bytes in the header" .El .Pp Subsequent bytes depend on the version number. .Bl -column "Version" "13 and up" -offset indent .It Sy "Version Byte Meaning" .It "1 11 Terminal width, in characters" .It " 12 Terminal depth, in characters" .It " 13 and up The snapshot data" .El .Pp So a dump of an 80x25 screen would start (in hex) .Bd -literal -offset indent 53 43 52 53 48 4f 54 5f 01 02 50 19 ----------------------- -- -- -- -- | | | | ` 25 decimal | | | `--- 80 decimal | | `------ 2 remaining bytes of header data | `--------- File format version 1 `------------------------ Literal "SCRSHOT_" .Ed .Sh VIDEO OUTPUT CONFIGURATION .Ss Boot Time Configuration You may set the following variables in .Pa /etc/rc.conf or .Pa /etc/rc.conf.local in order to configure the video output at boot time. .Pp .Bl -tag -width foo_bar_var -compact .It Ar blanktime Sets the timeout value for the .Fl t option. .It Ar font8x16 , font8x14 , font8x8 Specifies font files for the .Fl f option. .It Ar scrnmap Specifies a screen output map file for the .Fl l option. .El .Pp See .Xr rc.conf 5 for more details. .Ss Driver Configuration The video card driver may let you change default configuration options, such as the default font, so that you do not need to set up the options at boot time. See video card driver manuals, (e.g.\& .Xr vga 4 ) for details. .Sh FILES .Bl -tag -width /usr/share/syscons/scrnmaps/foo-bar -compact .It Pa /usr/share/syscons/fonts/* .It Pa /usr/share/vt/fonts/* font files. .It Pa /usr/share/syscons/scrnmaps/* screen output map files (relevant for .Xr syscons 4 only). .El .Sh EXAMPLES If you want to load .Pa /usr/share/syscons/fonts/iso-8x16.fnt to the kernel, run .Nm as: .Pp .Dl vidcontrol -f 8x16 /usr/share/syscons/fonts/iso-8x16.fnt .Pp So long as the font file is in .Pa /usr/share/syscons/fonts (if using syscons) or .Pa /usr/share/vt/fonts (if using vt), you may abbreviate the file name as .Pa iso-8x16 : .Pp .Dl vidcontrol -f 8x16 iso-8x16 .Pp Furthermore, you can also omit font size .Dq Li 8x16 : .Pp .Dl vidcontrol -f iso-8x16 .Pp Moreover, the suffix specifying the font size can be also omitted; in this case, .Nm will use the size of the currently displayed font to construct the suffix: .Pp .Dl vidcontrol -f iso .Pp Likewise, you can also abbreviate the screen output map file name for the .Fl l option if the file is found in .Pa /usr/share/syscons/scrnmaps . .Pp .Dl vidcontrol -l iso-8859-1_to_cp437 .Pp The above command will load .Pa /usr/share/syscons/scrnmaps/iso-8859-1_to_cp437.scm . .Pp The following command will set-up a 100x37 raster text mode (useful for some LCD models): .Pp .Dl vidcontrol -g 100x37 VESA_800x600 .Pp The following command will capture the contents of the first virtual terminal video buffer, and redirect the output to the .Pa shot.scr file: .Pp .Dl vidcontrol -p < /dev/ttyv0 > shot.scr .Pp The following command will dump contents of the fourth virtual terminal video buffer to the standard output in the human readable format: .Pp .Dl vidcontrol -P < /dev/ttyv3 .Sh SEE ALSO .Xr kbdcontrol 1 , .Xr vidfont 1 , .Xr keyboard 4 , .Xr screen 4 , .Xr syscons 4 , .Xr vga 4 , .Xr vt 4 , .Xr rc.conf 5 , .Xr kldload 8 , .Xr moused 8 , .Xr watch 8 .Pp The various .Pa scr2* utilities in the .Pa graphics and .Pa textproc categories of the .Em "Ports Collection" . .Sh AUTHORS .An S\(/oren Schmidt Aq Mt sos@FreeBSD.org .An Sascha Wildner Aq Mt saw@online.de .Sh CONTRIBUTORS .An -split .An Maxim Sobolev Aq Mt sobomax@FreeBSD.org .An Nik Clayton Aq Mt nik@FreeBSD.org diff --git a/usr.sbin/vidcontrol/vidcontrol.c b/usr.sbin/vidcontrol/vidcontrol.c index 67c0a9d3f8a5..848ef5401f31 100644 --- a/usr.sbin/vidcontrol/vidcontrol.c +++ b/usr.sbin/vidcontrol/vidcontrol.c @@ -1,1533 +1,1533 @@ /*- * SPDX-License-Identifier: BSD-3-Clause * * Copyright (c) 1994-1996 Søren Schmidt * All rights reserved. * * Portions of this software are based in part on the work of * Sascha Wildner contributed to The DragonFly Project * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer, * in this position and unchanged. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. The name of the author may not be used to endorse or promote products * derived from this software without specific prior written permission * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * * $DragonFly: src/usr.sbin/vidcontrol/vidcontrol.c,v 1.10 2005/03/02 06:08:29 joerg Exp $ */ #ifndef lint static const char rcsid[] = "$FreeBSD$"; #endif /* not lint */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "path.h" #include "decode.h" #define DATASIZE(x) ((x).w * (x).h * 256 / 8) /* Screen dump modes */ #define DUMP_FMT_RAW 1 #define DUMP_FMT_TXT 2 /* Screen dump options */ #define DUMP_FBF 0 #define DUMP_ALL 1 /* Screen dump file format revision */ #define DUMP_FMT_REV 1 static const char *legal_colors[16] = { "black", "blue", "green", "cyan", "red", "magenta", "brown", "white", "grey", "lightblue", "lightgreen", "lightcyan", "lightred", "lightmagenta", "yellow", "lightwhite" }; static struct { int active_vty; vid_info_t console_info; unsigned char screen_map[256]; int video_mode_number; struct video_info video_mode_info; } cur_info; struct vt4font_header { uint8_t magic[8]; uint8_t width; uint8_t height; uint16_t pad; uint32_t glyph_count; uint32_t map_count[4]; } __packed; static int hex = 0; static int vesa_cols; static int vesa_rows; static int font_height; static int vt4_mode = 0; static int video_mode_changed; static struct video_info new_mode_info; /* * Initialize revert data. * * NOTE: the following parameters are not yet saved/restored: * * screen saver timeout * cursor type * mouse character and mouse show/hide state * vty switching on/off state * history buffer size * history contents * font maps */ static void init(void) { if (ioctl(0, VT_GETACTIVE, &cur_info.active_vty) == -1) err(1, "getting active vty"); cur_info.console_info.size = sizeof(cur_info.console_info); if (ioctl(0, CONS_GETINFO, &cur_info.console_info) == -1) err(1, "getting console information"); /* vt(4) use unicode, so no screen mapping required. */ if (vt4_mode == 0 && ioctl(0, GIO_SCRNMAP, &cur_info.screen_map) == -1) err(1, "getting screen map"); if (ioctl(0, CONS_GET, &cur_info.video_mode_number) == -1) err(1, "getting video mode number"); cur_info.video_mode_info.vi_mode = cur_info.video_mode_number; if (ioctl(0, CONS_MODEINFO, &cur_info.video_mode_info) == -1) err(1, "getting video mode parameters"); } /* * If something goes wrong along the way we call revert() to go back to the * console state we came from (which is assumed to be working). * * NOTE: please also read the comments of init(). */ static void revert(void) { int save_errno, size[3]; save_errno = errno; ioctl(0, VT_ACTIVATE, cur_info.active_vty); ioctl(0, KDSBORDER, cur_info.console_info.mv_ovscan); fprintf(stderr, "\033[=%dH", cur_info.console_info.mv_rev.fore); fprintf(stderr, "\033[=%dI", cur_info.console_info.mv_rev.back); if (vt4_mode == 0) ioctl(0, PIO_SCRNMAP, &cur_info.screen_map); if (video_mode_changed) { if (cur_info.video_mode_number >= M_VESA_BASE) ioctl(0, _IO('V', cur_info.video_mode_number - M_VESA_BASE), NULL); else ioctl(0, _IO('S', cur_info.video_mode_number), NULL); if (cur_info.video_mode_info.vi_flags & V_INFO_GRAPHICS) { size[0] = cur_info.video_mode_info.vi_width / 8; size[1] = cur_info.video_mode_info.vi_height / cur_info.console_info.font_size; size[2] = cur_info.console_info.font_size; ioctl(0, KDRASTER, size); } } /* Restore some colors last since mode setting forgets some. */ fprintf(stderr, "\033[=%dF", cur_info.console_info.mv_norm.fore); fprintf(stderr, "\033[=%dG", cur_info.console_info.mv_norm.back); errno = save_errno; } /* * Print a short usage string describing all options, then exit. */ static void usage(void) { if (vt4_mode) fprintf(stderr, "%s\n%s\n%s\n%s\n%s\n%s\n", -"usage: vidcontrol [-CHPpx] [-b color] [-c appearance] [-f [[size] file]]", +"usage: vidcontrol [-Cx] [-b color] [-c appearance] [-f [[size] file]]", " [-g geometry] [-h size] [-i active | adapter | mode]", " [-M char] [-m on | off]", " [-r foreground background] [-S on | off] [-s number]", " [-T xterm | cons25] [-t N | off] [mode]", " [foreground [background]] [show]"); else fprintf(stderr, "%s\n%s\n%s\n%s\n%s\n%s\n", "usage: vidcontrol [-CdHLPpx] [-b color] [-c appearance] [-f [size] file]", " [-g geometry] [-h size] [-i active | adapter | mode]", " [-l screen_map] [-M char] [-m on | off]", " [-r foreground background] [-S on | off] [-s number]", " [-T xterm | cons25] [-t N | off] [mode]", " [foreground [background]] [show]"); exit(1); } /* Detect presence of vt(4). */ static int is_vt4(void) { char vty_name[4] = ""; size_t len = sizeof(vty_name); if (sysctlbyname("kern.vty", vty_name, &len, NULL, 0) != 0) return (0); return (strcmp(vty_name, "vt") == 0); } /* * Retrieve the next argument from the command line (for options that require * more than one argument). */ static char * nextarg(int ac, char **av, int *indp, int oc, int strict) { if (*indp < ac) return(av[(*indp)++]); if (strict != 0) { revert(); errx(1, "option requires two arguments -- %c", oc); } return(NULL); } /* * Guess which file to open. Try to open each combination of a specified set * of file name components. */ static FILE * openguess(const char *a[], const char *b[], const char *c[], const char *d[], char **name) { FILE *f; int i, j, k, l; for (i = 0; a[i] != NULL; i++) { for (j = 0; b[j] != NULL; j++) { for (k = 0; c[k] != NULL; k++) { for (l = 0; d[l] != NULL; l++) { asprintf(name, "%s%s%s%s", a[i], b[j], c[k], d[l]); f = fopen(*name, "r"); if (f != NULL) return (f); free(*name); } } } } return (NULL); } /* * Load a screenmap from a file and set it. */ static void load_scrnmap(const char *filename) { FILE *fd; int size; char *name; scrmap_t scrnmap; const char *a[] = {"", SCRNMAP_PATH, NULL}; const char *b[] = {filename, NULL}; const char *c[] = {"", ".scm", NULL}; const char *d[] = {"", NULL}; fd = openguess(a, b, c, d, &name); if (fd == NULL) { revert(); errx(1, "screenmap file not found"); } size = sizeof(scrnmap); if (decode(fd, (char *)&scrnmap, size) != size) { rewind(fd); if (fread(&scrnmap, 1, size, fd) != (size_t)size) { fclose(fd); revert(); errx(1, "bad screenmap file"); } } if (ioctl(0, PIO_SCRNMAP, &scrnmap) == -1) { revert(); err(1, "loading screenmap"); } fclose(fd); } /* * Set the default screenmap. */ static void load_default_scrnmap(void) { scrmap_t scrnmap; int i; for (i=0; i<256; i++) *((char*)&scrnmap + i) = i; if (ioctl(0, PIO_SCRNMAP, &scrnmap) == -1) { revert(); err(1, "loading default screenmap"); } } /* * Print the current screenmap to stdout. */ static void print_scrnmap(void) { unsigned char map[256]; size_t i; if (ioctl(0, GIO_SCRNMAP, &map) == -1) { revert(); err(1, "getting screenmap"); } for (i=0; ishape[0]; while ((word = strsep(¶m, ",")) != NULL) { if (strcmp(word, "normal") == 0) type = 0; else if (strcmp(word, "destructive") == 0) type = CONS_BLINK_CURSOR | CONS_CHAR_CURSOR; else if (strcmp(word, "blink") == 0) type |= CONS_BLINK_CURSOR; else if (strcmp(word, "noblink") == 0) type &= ~CONS_BLINK_CURSOR; else if (strcmp(word, "block") == 0) type &= ~CONS_CHAR_CURSOR; else if (strcmp(word, "noblock") == 0) type |= CONS_CHAR_CURSOR; else if (strcmp(word, "hidden") == 0) type |= CONS_HIDDEN_CURSOR; else if (strcmp(word, "nohidden") == 0) type &= ~CONS_HIDDEN_CURSOR; else if (strncmp(word, "base=", 5) == 0) shape->shape[1] = strtol(word + 5, NULL, 0); else if (strncmp(word, "height=", 7) == 0) shape->shape[2] = strtol(word + 7, NULL, 0); else if (strcmp(word, "charcolors") == 0) type |= CONS_CHARCURSOR_COLORS; else if (strcmp(word, "mousecolors") == 0) type |= CONS_MOUSECURSOR_COLORS; else if (strcmp(word, "default") == 0) type |= CONS_DEFAULT_CURSOR; else if (strcmp(word, "shapeonly") == 0) type |= CONS_SHAPEONLY_CURSOR; else if (strcmp(word, "local") == 0) type |= CONS_LOCAL_CURSOR; else if (strcmp(word, "reset") == 0) type |= CONS_RESET_CURSOR; else if (strcmp(word, "show") == 0) printf("flags %#x, base %d, height %d\n", type, shape->shape[1], shape->shape[2]); else { revert(); errx(1, "invalid parameters for -c starting at '%s%s%s'", word, param != NULL ? "," : "", param != NULL ? param : ""); } } free(dupparam); shape->shape[0] = type; } /* * Set the cursor's shape/type. */ static void set_cursor_type(char *param) { struct cshape shape; /* Dry run to determine color, default and local flags. */ shape.shape[0] = 0; shape.shape[1] = -1; shape.shape[2] = -1; parse_cursor_params(param, &shape); /* Get the relevant old setting. */ if (ioctl(0, CONS_GETCURSORSHAPE, &shape) != 0) { revert(); err(1, "ioctl(CONS_GETCURSORSHAPE)"); } parse_cursor_params(param, &shape); if (ioctl(0, CONS_SETCURSORSHAPE, &shape) != 0) { revert(); err(1, "ioctl(CONS_SETCURSORSHAPE)"); } } /* * Set the video mode. */ static void video_mode(int argc, char **argv, int *mode_index) { static struct { const char *name; unsigned long mode; unsigned long mode_num; } modes[] = { { "80x25", SW_TEXT_80x25, M_TEXT_80x25 }, { "80x30", SW_TEXT_80x30, M_TEXT_80x30 }, { "80x43", SW_TEXT_80x43, M_TEXT_80x43 }, { "80x50", SW_TEXT_80x50, M_TEXT_80x50 }, { "80x60", SW_TEXT_80x60, M_TEXT_80x60 }, { "132x25", SW_TEXT_132x25, M_TEXT_132x25 }, { "132x30", SW_TEXT_132x30, M_TEXT_132x30 }, { "132x43", SW_TEXT_132x43, M_TEXT_132x43 }, { "132x50", SW_TEXT_132x50, M_TEXT_132x50 }, { "132x60", SW_TEXT_132x60, M_TEXT_132x60 }, { "VGA_40x25", SW_VGA_C40x25, M_VGA_C40x25 }, { "VGA_80x25", SW_VGA_C80x25, M_VGA_C80x25 }, { "VGA_80x30", SW_VGA_C80x30, M_VGA_C80x30 }, { "VGA_80x50", SW_VGA_C80x50, M_VGA_C80x50 }, { "VGA_80x60", SW_VGA_C80x60, M_VGA_C80x60 }, #ifdef SW_VGA_C90x25 { "VGA_90x25", SW_VGA_C90x25, M_VGA_C90x25 }, { "VGA_90x30", SW_VGA_C90x30, M_VGA_C90x30 }, { "VGA_90x43", SW_VGA_C90x43, M_VGA_C90x43 }, { "VGA_90x50", SW_VGA_C90x50, M_VGA_C90x50 }, { "VGA_90x60", SW_VGA_C90x60, M_VGA_C90x60 }, #endif { "VGA_320x200", SW_VGA_CG320, M_CG320 }, { "EGA_80x25", SW_ENH_C80x25, M_ENH_C80x25 }, { "EGA_80x43", SW_ENH_C80x43, M_ENH_C80x43 }, { "VESA_132x25", SW_VESA_C132x25,M_VESA_C132x25 }, { "VESA_132x43", SW_VESA_C132x43,M_VESA_C132x43 }, { "VESA_132x50", SW_VESA_C132x50,M_VESA_C132x50 }, { "VESA_132x60", SW_VESA_C132x60,M_VESA_C132x60 }, { "VESA_800x600", SW_VESA_800x600,M_VESA_800x600 }, { NULL, 0, 0 }, }; int new_mode_num = 0; unsigned long mode = 0; int cur_mode; int save_errno; int size[3]; int i; if (ioctl(0, CONS_GET, &cur_mode) < 0) err(1, "cannot get the current video mode"); /* * Parse the video mode argument... */ if (*mode_index < argc) { if (!strncmp(argv[*mode_index], "MODE_", 5)) { if (!isdigit(argv[*mode_index][5])) errx(1, "invalid video mode number"); new_mode_num = atoi(&argv[*mode_index][5]); } else { for (i = 0; modes[i].name != NULL; ++i) { if (!strcmp(argv[*mode_index], modes[i].name)) { mode = modes[i].mode; new_mode_num = modes[i].mode_num; break; } } if (modes[i].name == NULL) return; if (ioctl(0, mode, NULL) < 0) { revert(); err(1, "cannot set videomode"); } video_mode_changed = 1; } /* * Collect enough information about the new video mode... */ new_mode_info.vi_mode = new_mode_num; if (ioctl(0, CONS_MODEINFO, &new_mode_info) == -1) { revert(); err(1, "obtaining new video mode parameters"); } if (mode == 0) { if (new_mode_num >= M_VESA_BASE) mode = _IO('V', new_mode_num - M_VESA_BASE); else mode = _IO('S', new_mode_num); } /* * Try setting the new mode. */ if (ioctl(0, mode, NULL) == -1) { revert(); err(1, "setting video mode"); } video_mode_changed = 1; /* * For raster modes it's not enough to just set the mode. * We also need to explicitly set the raster mode. */ if (new_mode_info.vi_flags & V_INFO_GRAPHICS) { /* font size */ if (font_height == 0) font_height = cur_info.console_info.font_size; size[2] = font_height; /* adjust columns */ if ((vesa_cols * 8 > new_mode_info.vi_width) || (vesa_cols <= 0)) { size[0] = new_mode_info.vi_width / 8; } else { size[0] = vesa_cols; } /* adjust rows */ if ((vesa_rows * font_height > new_mode_info.vi_height) || (vesa_rows <= 0)) { size[1] = new_mode_info.vi_height / font_height; } else { size[1] = vesa_rows; } /* set raster mode */ if (ioctl(0, KDRASTER, size)) { save_errno = errno; if (cur_mode >= M_VESA_BASE) ioctl(0, _IO('V', cur_mode - M_VESA_BASE), NULL); else ioctl(0, _IO('S', cur_mode), NULL); revert(); errno = save_errno; err(1, "cannot activate raster display"); } } /* Recover from mode setting forgetting colors. */ fprintf(stderr, "\033[=%dF", cur_info.console_info.mv_norm.fore); fprintf(stderr, "\033[=%dG", cur_info.console_info.mv_norm.back); (*mode_index)++; } } /* * Return the number for a specified color name. */ static int get_color_number(char *color) { int i; for (i=0; i<16; i++) { if (!strcmp(color, legal_colors[i])) return i; } return -1; } /* * Set normal text and background colors. */ static void set_normal_colors(int argc, char **argv, int *_index) { int color; if (*_index < argc && (color = get_color_number(argv[*_index])) != -1) { (*_index)++; fprintf(stderr, "\033[=%dF", color); if (*_index < argc && (color = get_color_number(argv[*_index])) != -1) { (*_index)++; fprintf(stderr, "\033[=%dG", color); } } } /* * Set reverse text and background colors. */ static void set_reverse_colors(int argc, char **argv, int *_index) { int color; if ((color = get_color_number(argv[*(_index)-1])) != -1) { fprintf(stderr, "\033[=%dH", color); if (*_index < argc && (color = get_color_number(argv[*_index])) != -1) { (*_index)++; fprintf(stderr, "\033[=%dI", color); } } } /* * Switch to virtual terminal #arg. */ static void set_console(char *arg) { int n; if(!arg || strspn(arg,"0123456789") != strlen(arg)) { revert(); errx(1, "bad console number"); } n = atoi(arg); if (n < 1 || n > 16) { revert(); errx(1, "console number out of range"); } else if (ioctl(0, VT_ACTIVATE, n) == -1) { revert(); err(1, "switching vty"); } } /* * Sets the border color. */ static void set_border_color(char *arg) { int color; color = get_color_number(arg); if (color == -1) { revert(); errx(1, "invalid color '%s'", arg); } if (ioctl(0, KDSBORDER, color) != 0) { revert(); err(1, "ioctl(KD_SBORDER)"); } } static void set_mouse_char(char *arg) { struct mouse_info mouse; long l; l = strtol(arg, NULL, 0); if ((l < 0) || (l > UCHAR_MAX - 3)) { revert(); warnx("argument to -M must be 0 through %d", UCHAR_MAX - 3); return; } mouse.operation = MOUSE_MOUSECHAR; mouse.u.mouse_char = (int)l; if (ioctl(0, CONS_MOUSECTL, &mouse) == -1) { revert(); err(1, "setting mouse character"); } } /* * Show/hide the mouse. */ static void set_mouse(char *arg) { struct mouse_info mouse; if (!strcmp(arg, "on")) { mouse.operation = MOUSE_SHOW; } else if (!strcmp(arg, "off")) { mouse.operation = MOUSE_HIDE; } else { revert(); errx(1, "argument to -m must be either on or off"); } if (ioctl(0, CONS_MOUSECTL, &mouse) == -1) { revert(); err(1, "%sing the mouse", mouse.operation == MOUSE_SHOW ? "show" : "hid"); } } static void set_lockswitch(char *arg) { int data; if (!strcmp(arg, "off")) { data = 0x01; } else if (!strcmp(arg, "on")) { data = 0x02; } else { revert(); errx(1, "argument to -S must be either on or off"); } if (ioctl(0, VT_LOCKSWITCH, &data) == -1) { revert(); err(1, "turning %s vty switching", data == 0x01 ? "off" : "on"); } } /* * Return the adapter name for a specified type. */ static const char *adapter_name(int type) { static struct { int type; const char *name; } names[] = { { KD_MONO, "MDA" }, { KD_HERCULES, "Hercules" }, { KD_CGA, "CGA" }, { KD_EGA, "EGA" }, { KD_VGA, "VGA" }, { KD_TGA, "TGA" }, { -1, "Unknown" }, }; int i; for (i = 0; names[i].type != -1; ++i) if (names[i].type == type) break; return names[i].name; } /* * Show active VTY, ie current console number. */ static void show_active_info(void) { printf("%d\n", cur_info.active_vty); } /* * Show graphics adapter information. */ static void show_adapter_info(void) { struct video_adapter_info ad; ad.va_index = 0; if (ioctl(0, CONS_ADPINFO, &ad) == -1) { revert(); err(1, "obtaining adapter information"); } printf("fb%d:\n", ad.va_index); printf(" %.*s%d, type:%s%s (%d), flags:0x%x\n", (int)sizeof(ad.va_name), ad.va_name, ad.va_unit, (ad.va_flags & V_ADP_VESA) ? "VESA " : "", adapter_name(ad.va_type), ad.va_type, ad.va_flags); printf(" initial mode:%d, current mode:%d, BIOS mode:%d\n", ad.va_initial_mode, ad.va_mode, ad.va_initial_bios_mode); printf(" frame buffer window:0x%zx, buffer size:0x%zx\n", ad.va_window, ad.va_buffer_size); printf(" window size:0x%zx, origin:0x%x\n", ad.va_window_size, ad.va_window_orig); printf(" display start address (%d, %d), scan line width:%d\n", ad.va_disp_start.x, ad.va_disp_start.y, ad.va_line_width); printf(" reserved:0x%zx\n", ad.va_unused0); } /* * Show video mode information. */ static void show_mode_info(void) { char buf[80]; struct video_info info; int c; int mm; int mode; printf(" mode# flags type size " "font window linear buffer\n"); printf("---------------------------------------" "---------------------------------------\n"); memset(&info, 0, sizeof(info)); for (mode = 0; mode <= M_VESA_MODE_MAX; ++mode) { info.vi_mode = mode; if (ioctl(0, CONS_MODEINFO, &info)) continue; if (info.vi_mode != mode) continue; if (info.vi_width == 0 && info.vi_height == 0 && info.vi_cwidth == 0 && info.vi_cheight == 0) continue; printf("%3d (0x%03x)", mode, mode); printf(" 0x%08x", info.vi_flags); if (info.vi_flags & V_INFO_GRAPHICS) { c = 'G'; if (info.vi_mem_model == V_INFO_MM_PLANAR) snprintf(buf, sizeof(buf), "%dx%dx%d %d", info.vi_width, info.vi_height, info.vi_depth, info.vi_planes); else { switch (info.vi_mem_model) { case V_INFO_MM_PACKED: mm = 'P'; break; case V_INFO_MM_DIRECT: mm = 'D'; break; case V_INFO_MM_CGA: mm = 'C'; break; case V_INFO_MM_HGC: mm = 'H'; break; case V_INFO_MM_VGAX: mm = 'V'; break; default: mm = ' '; break; } snprintf(buf, sizeof(buf), "%dx%dx%d %c", info.vi_width, info.vi_height, info.vi_depth, mm); } } else { c = 'T'; snprintf(buf, sizeof(buf), "%dx%d", info.vi_width, info.vi_height); } printf(" %c %-15s", c, buf); snprintf(buf, sizeof(buf), "%dx%d", info.vi_cwidth, info.vi_cheight); printf(" %-5s", buf); printf(" 0x%05zx %2dk %2dk", info.vi_window, (int)info.vi_window_size/1024, (int)info.vi_window_gran/1024); printf(" 0x%08zx %dk\n", info.vi_buffer, (int)info.vi_buffer_size/1024); } } static void show_info(char *arg) { if (!strcmp(arg, "active")) { show_active_info(); } else if (!strcmp(arg, "adapter")) { show_adapter_info(); } else if (!strcmp(arg, "mode")) { show_mode_info(); } else { revert(); errx(1, "argument to -i must be active, adapter, or mode"); } } static void test_frame(void) { vid_info_t info; const char *bg, *sep; int i, fore; info.size = sizeof(info); if (ioctl(0, CONS_GETINFO, &info) == -1) err(1, "getting console information"); fore = 15; if (info.mv_csz < 80) { bg = "BG"; sep = " "; } else { bg = "BACKGROUND"; sep = " "; } fprintf(stdout, "\033[=0G\n\n"); for (i=0; i<8; i++) { fprintf(stdout, "\033[=%dF\033[=0G%2d \033[=%dF%-7s%s" "\033[=%dF\033[=0G%2d \033[=%dF%-12s%s" "\033[=%dF%2d \033[=%dG%s\033[=0G%s" "\033[=%dF%2d \033[=%dG%s\033[=0G\n", fore, i, i, legal_colors[i], sep, fore, i + 8, i + 8, legal_colors[i + 8], sep, fore, i, i, bg, sep, fore, i + 8, i + 8, bg); } fprintf(stdout, "\033[=%dF\033[=%dG\033[=%dH\033[=%dI\n", info.mv_norm.fore, info.mv_norm.back, info.mv_rev.fore, info.mv_rev.back); } /* * Snapshot the video memory of that terminal, using the CONS_SCRSHOT * ioctl, and writes the results to stdout either in the special * binary format (see manual page for details), or in the plain * text format. */ static void dump_screen(int mode, int opt) { scrshot_t shot; vid_info_t info; info.size = sizeof(info); if (ioctl(0, CONS_GETINFO, &info) == -1) { revert(); err(1, "getting console information"); } shot.x = shot.y = 0; shot.xsize = info.mv_csz; shot.ysize = info.mv_rsz; if (opt == DUMP_ALL) shot.ysize += info.mv_hsz; shot.buf = alloca(shot.xsize * shot.ysize * sizeof(u_int16_t)); if (shot.buf == NULL) { revert(); errx(1, "failed to allocate memory for dump"); } if (ioctl(0, CONS_SCRSHOT, &shot) == -1) { revert(); err(1, "dumping screen"); } if (mode == DUMP_FMT_RAW) { printf("SCRSHOT_%c%c%c%c", DUMP_FMT_REV, 2, shot.xsize, shot.ysize); fflush(stdout); write(STDOUT_FILENO, shot.buf, shot.xsize * shot.ysize * sizeof(u_int16_t)); } else { char *line; int x, y; u_int16_t ch; line = alloca(shot.xsize + 1); if (line == NULL) { revert(); errx(1, "failed to allocate memory for line buffer"); } for (y = 0; y < shot.ysize; y++) { for (x = 0; x < shot.xsize; x++) { ch = shot.buf[x + (y * shot.xsize)]; ch &= 0xff; if (isprint(ch) == 0) ch = ' '; line[x] = (char)ch; } /* Trim trailing spaces */ do { line[x--] = '\0'; } while (line[x] == ' ' && x != 0); puts(line); } fflush(stdout); } } /* * Set the console history buffer size. */ static void set_history(char *opt) { int size; size = atoi(opt); if ((*opt == '\0') || size < 0) { revert(); errx(1, "argument must not be less than zero"); } if (ioctl(0, CONS_HISTORY, &size) == -1) { revert(); err(1, "setting history buffer size"); } } /* * Clear the console history buffer. */ static void clear_history(void) { if (ioctl(0, CONS_CLRHIST) == -1) { revert(); err(1, "clearing history buffer"); } } static void set_terminal_mode(char *arg) { if (strcmp(arg, "xterm") == 0) fprintf(stderr, "\033[=T"); else if (strcmp(arg, "cons25") == 0) fprintf(stderr, "\033[=1T"); } int main(int argc, char **argv) { char *font, *type, *termmode; const char *opts; int dumpmod, dumpopt, opt; vt4_mode = is_vt4(); init(); dumpmod = 0; dumpopt = DUMP_FBF; termmode = NULL; if (vt4_mode) - opts = "b:Cc:fg:h:Hi:M:m:pPr:S:s:T:t:x"; + opts = "b:Cc:fg:h:i:M:m:r:S:s:T:t:x"; else opts = "b:Cc:dfg:h:Hi:l:LM:m:pPr:S:s:T:t:x"; while ((opt = getopt(argc, argv, opts)) != -1) switch(opt) { case 'b': set_border_color(optarg); break; case 'C': clear_history(); break; case 'c': set_cursor_type(optarg); break; case 'd': if (vt4_mode) break; print_scrnmap(); break; case 'f': optarg = nextarg(argc, argv, &optind, 'f', 0); if (optarg != NULL) { font = nextarg(argc, argv, &optind, 'f', 0); if (font == NULL) { type = NULL; font = optarg; } else type = optarg; load_font(type, font); } else { if (!vt4_mode) usage(); /* Switch syscons to ROM? */ load_default_vt4font(); } break; case 'g': if (sscanf(optarg, "%dx%d", &vesa_cols, &vesa_rows) != 2) { revert(); warnx("incorrect geometry: %s", optarg); usage(); } break; case 'h': set_history(optarg); break; case 'H': dumpopt = DUMP_ALL; break; case 'i': show_info(optarg); break; case 'l': if (vt4_mode) break; load_scrnmap(optarg); break; case 'L': if (vt4_mode) break; load_default_scrnmap(); break; case 'M': set_mouse_char(optarg); break; case 'm': set_mouse(optarg); break; case 'p': dumpmod = DUMP_FMT_RAW; break; case 'P': dumpmod = DUMP_FMT_TXT; break; case 'r': set_reverse_colors(argc, argv, &optind); break; case 'S': set_lockswitch(optarg); break; case 's': set_console(optarg); break; case 'T': if (strcmp(optarg, "xterm") != 0 && strcmp(optarg, "cons25") != 0) usage(); termmode = optarg; break; case 't': set_screensaver_timeout(optarg); break; case 'x': hex = 1; break; default: usage(); } if (dumpmod != 0) dump_screen(dumpmod, dumpopt); video_mode(argc, argv, &optind); set_normal_colors(argc, argv, &optind); if (optind < argc && !strcmp(argv[optind], "show")) { test_frame(); optind++; } if (termmode != NULL) set_terminal_mode(termmode); if ((optind != argc) || (argc == 1)) usage(); return (0); }