[PATCH] Missing references to vt(4) "NEWCONS" in man-pages
Stefan Esser
se at freebsd.org
Thu Aug 21 07:29:58 UTC 2014
Hi,
the attached patch, also available from
http://people.freebsd.org/~se/MAN-VT.diff
contains changes to man pages that reference syscons(4), but so far do
not mention vt(4). This should be fixed for 10.1, where vt(4) is in
the GENERIC kernel.
The following man-pages have been identified to contain references to
syscons(4):
share/man/man4/atkbd.4
share/man/man4/kbdmux.4
share/man/man4/splash.4
share/man/man4/terasic_mtl.4 (does this driver work with vt???)
share/man/man4/ukbd.4
share/man/man4/vga.4
share/man/man4/vkbd.4
share/man/man4/vt.4
share/man/man5/rc.conf.5
share/man/man7/hier.7
share/man/man8/nanobsd.8
sbin/conscontrol/conscontrol.8
usr.bin/lock/lock.1
usr.sbin/bsdconfig/bsdconfig.8
usr.sbin/bsdinstall/bsdinstall.8
usr.sbin/kbdcontrol/kbdcontrol.1
usr.sbin/kbdcontrol/kbdmap.5
usr.sbin/kbdmap/kbdmap.1
usr.sbin/vidcontrol/vidcontrol.1
(Some of the diffs describe changes that are in -STABLE and will be
committed to 10-STABLE in time for 10.1, to 9-STABLE after the release
of 10.1.)
The patch adds "or vt(4)" or mentions changed file paths or conventions.
Please review and report any problems with the patch.
The diff to bsdconfig is not complete, it does just mention places that
need fixing.
But in the case of bsdconfig, it does not suffice to fix the man-page,
since that utility embeds knowledge about details of the system (e.g.
the available fonts) and needs major adjustments.
Please send any remarks also to my address, since I'm not subscribed to
the freebsd-doc list.
I'm including Tim Kienzle (for bsdconfig) and Robert Watson (because of
the question whether terasic_mtl supports vt) in the CC list.
Best regards, STefan
-------------- next part --------------
Index: share/man/man4/atkbd.4
===================================================================
--- share/man/man4/atkbd.4 (revision 270244)
+++ share/man/man4/atkbd.4 (working copy)
@@ -51,7 +51,9 @@
which is connected to the AT keyboard controller.
.Pp
This driver is required for the console driver
-.Xr syscons 4 .
+.Xr syscons 4
+or
+.Xr vt 4 .
.Pp
There can be only one
.Nm
@@ -211,6 +213,7 @@
.Xr atkbdc 4 ,
.Xr psm 4 ,
.Xr syscons 4 ,
+.Xr vt 4 ,
.Xr kbdmap 5 ,
.Xr loader 8
.Sh HISTORY
Index: share/man/man4/kbdmux.4
===================================================================
--- share/man/man4/kbdmux.4 (revision 270244)
+++ share/man/man4/kbdmux.4 (working copy)
@@ -35,6 +35,7 @@
.Xr atkbd 4 ,
.Xr syscons 4 ,
.Xr ukbd 4
+.Xr vt 4 ,
.Sh HISTORY
The
.Nm
Index: share/man/man4/splash.4
===================================================================
--- share/man/man4/splash.4 (revision 270244)
+++ share/man/man4/splash.4 (working copy)
@@ -245,6 +245,7 @@
.Xr vidcontrol 1 ,
.Xr syscons 4 ,
.Xr vga 4 ,
+.\" .Xr vt 4 ,
.Xr loader.conf 5 ,
.Xr rc.conf 5 ,
.Xr kldload 8 ,
@@ -285,6 +286,8 @@
.Sh CAVEATS
Both the splash screen and the screen saver work with
.Xr syscons 4
+.\" or
+.\" .Xr vt 4
only.
.Sh BUGS
If you load a screen saver while another screen saver has already
Index: share/man/man4/terasic_mtl.4
===================================================================
--- share/man/man4/terasic_mtl.4 (revision 270244)
+++ share/man/man4/terasic_mtl.4 (working copy)
@@ -66,6 +66,8 @@
.Nm
devices are also attached to the
.Xr syscons 4
+.\" or
+.\" .Xr vt 4
framework, which implements a VT-compatible terminal connected to the
.Xr tty 4
framework.
@@ -91,6 +93,7 @@
.Xr write 2 ,
.Xr syscons 4 ,
.Xr tty 4 ,
+.\" .Xr vt 4 ,
.Xr ttys 5
.Sh HISTORY
The
@@ -111,6 +114,7 @@
.Sh BUGS
The
.Xr syscons 4
+.\" what about NEWCONS??? .Xr vt 4
attachment does not support the hardware cursor feature.
.Pp
A more structured interface to control registers using the
Index: share/man/man4/ukbd.4
===================================================================
--- share/man/man4/ukbd.4 (revision 270244)
+++ share/man/man4/ukbd.4 (working copy)
@@ -127,7 +127,9 @@
The above lines will put the French ISO keymap in the ukbd driver.
You can specify any keymap in
.Pa /usr/share/syscons/keymaps
-with this option.
+or
+.Pa /usr/share/vt/keymaps
+(depending on the console driver being used) with this option.
.Pp
.D1 Cd "options KBD_DISABLE_KEYMAP_LOADING"
.Pp
@@ -151,6 +153,7 @@
.Xr syscons 4 ,
.Xr uhci 4 ,
.Xr usb 4 ,
+.Xr vt 4 ,
.Xr config 8
.Sh AUTHORS
.An -nosplit
Index: share/man/man4/vga.4
===================================================================
--- share/man/man4/vga.4 (revision 270244)
+++ share/man/man4/vga.4 (working copy)
@@ -51,7 +51,9 @@
driver is a generic video card driver which provides access to
video cards.
This driver is required for the console driver
-.Xr syscons 4 .
+.Xr syscons 4
+or
+.Xr vt 4 .
The console driver will call the
.Nm
driver to manipulate video hardware (changing video modes, loading font, etc).
@@ -124,7 +126,9 @@
.Dv SC_ALT_MOUSE_IMAGE
option.
See
-.Xr syscons 4 .
+.Xr syscons 4
+or
+.Xr vt 4 .
.It Dv VGA_NO_MODE_CHANGE
This option prevents the driver from changing video modes.
.El
@@ -160,6 +164,7 @@
.Sh SEE ALSO
.Xr vgl 3 ,
.Xr syscons 4 ,
+.Xr vt 4 ,
.Xr config 8 ,
.Xr kldload 8 ,
.Xr kldunload 8
Index: share/man/man4/vkbd.4
===================================================================
--- share/man/man4/vkbd.4 (revision 270244)
+++ share/man/man4/vkbd.4 (working copy)
@@ -129,7 +129,8 @@
.Xr kbdcontrol 1 ,
.Xr atkbdc 4 ,
.Xr psm 4 ,
-.Xr syscons 4
+.Xr syscons 4 ,
+.Xr vt 4
.Sh HISTORY
The
.Nm
Index: share/man/man4/vt.4
===================================================================
--- share/man/man4/vt.4 (revision 270244)
+++ share/man/man4/vt.4 (working copy)
@@ -211,7 +211,7 @@
Default is 15, all enabled.
.El
.Sh FILES
-.Bl -tag -width /usr/share/syscons/keymaps/* -compact
+.Bl -tag -width /usr/share/vt/keymaps/* -compact
.It Pa /dev/console
.It Pa /dev/consolectl
.It Pa /dev/ttyv*
Index: share/man/man5/rc.conf.5
===================================================================
--- share/man/man5/rc.conf.5 (revision 270244)
+++ share/man/man5/rc.conf.5 (working copy)
@@ -3111,8 +3111,13 @@
If set to
.Dq Li NO ,
no keymap is installed, otherwise the value is used to install
-the keymap file in
-.Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd .
+the keymap file found in
+.Pa /usr/share/syscons/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
+(if using
+.Xr syscons 4 ) or
+.Pa /usr/share/vt/keymaps/ Ns Ao Ar value Ac Ns Pa .kbd
+(if using
+.Xr vt 4 ) .
.It Va keyrate
.Pq Vt str
The keyboard repeat speed.
@@ -3147,6 +3152,9 @@
no screen map is installed, otherwise the value is used to install
the screen map file in
.Pa /usr/share/syscons/scrnmaps/ Ns Aq Ar value .
+This parameter is ignored when using
+.Xr vt 4
+as the console driver.
.It Va font8x16
.Pq Vt str
If set to
@@ -3154,7 +3162,9 @@
the default 8x16 font value is used for screen size requests, otherwise
the value in
.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
-is used.
+or
+.Pa /usr/share/vt/fonts/ Ns Aq Ar value
+is used (depending on the console driver being used).
.It Va font8x14
.Pq Vt str
If set to
@@ -3162,7 +3172,9 @@
the default 8x14 font value is used for screen size requests, otherwise
the value in
.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
-is used.
+or
+.Pa /usr/share/vt/fonts/ Ns Aq Ar value
+is used (depending on the console driver being used).
.It Va font8x8
.Pq Vt str
If set to
@@ -3170,7 +3182,9 @@
the default 8x8 font value is used for screen size requests, otherwise
the value in
.Pa /usr/share/syscons/fonts/ Ns Aq Ar value
-is used.
+or
+.Pa /usr/share/vt/fonts/ Ns Aq Ar value
+is used (depending on the console driver being used).
.It Va blanktime
.Pq Vt int
If set to
@@ -3377,6 +3391,8 @@
.Dq Fl h Li 200
will set the
.Xr syscons 4
+or
+.Xr vt 4
scrollback (history) buffer to 200 lines.
.It Va cron_enable
.Pq Vt bool
Index: share/man/man7/hier.7
===================================================================
--- share/man/man7/hier.7 (revision 270244)
+++ share/man/man7/hier.7 (working copy)
@@ -633,6 +633,26 @@
see
.Xr tzfile 5
.El
+.It Pa vt/
+files used by vt;
+see
+.Xr vt 4
+.Bl -tag -width ".Pa scrnmaps/" -compact
+.It Pa fonts/
+console fonts;
+see
+.Xr vidcontrol 1
+and
+.Xr vidfont 1
+.It Pa keymaps/
+console keyboard maps;
+see
+.Xr kbdcontrol 1
+and
+.Xr kbdmap 1
+.\" .It Pa scrnmaps/
+.\" console screen maps
+.El
.It Pa src/
.Bx ,
third-party, and/or local source files
Index: share/man/man8/nanobsd.8
===================================================================
--- share/man/man8/nanobsd.8 (revision 270244)
+++ share/man/man8/nanobsd.8 (working copy)
@@ -277,6 +277,8 @@
.Xr getty 8
on the virtual
.Xr syscons 4
+or
+.Xr vt 4
terminals
.Pq Pa /dev/ttyv*
and enables the use of the first serial port as the system
Index: usr.sbin/kbdcontrol/kbdcontrol.1
===================================================================
--- usr.sbin/kbdcontrol/kbdcontrol.1 (revision 270244)
+++ usr.sbin/kbdcontrol/kbdcontrol.1 (working copy)
@@ -1,5 +1,5 @@
.\"
-.\" kbdcontrol - a utility for manipulating the syscons keyboard driver section
+.\" kbdcontrol - a utility for manipulating the syscons or vt keyboard driver section
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@@ -41,6 +41,8 @@
.Nm
command is used to set various keyboard related options for the
.Xr syscons 4
+or
+.Xr vt 4
console driver and the keyboard drivers,
such as key map, keyboard repeat and delay rates, bell
characteristics etc.
@@ -213,6 +215,7 @@
.Sh FILES
.Bl -tag -width /usr/share/syscons/keymaps/foo_bar -compact
.It Pa /usr/share/syscons/keymaps/*
+.It Pa /usr/share/vt/keymaps/*
keyboard map files
.El
.Sh EXAMPLES
@@ -222,9 +225,21 @@
.Dl kbdcontrol -l /usr/share/syscons/keymaps/ru.koi8-r.kbd
.Pp
So long as the keyboard map file resides in
-.Pa /usr/share/syscons/keymaps ,
+.Pa /usr/share/syscons/keymaps
+(if using
+.Xr syscons 4
+) or
+.Pa /usr/share/vt/keymaps
+(if using
+.Xr vt 4 vt
+) ,
you may abbreviate the file name as
.Pa ru.koi8-r .
+Since
+.Xr vt 4
+uses Unicode, the corresponding keyboard file names omit the encoding
+and typically are just a country code, e.g.
+.Pa ru .
.Pp
.Dl kbdcontrol -l ru.koi8-r
.Pp
@@ -268,6 +283,7 @@
.Xr screen 4 ,
.Xr syscons 4 ,
.Xr ukbd 4 ,
+.Xr vt 4 ,
.Xr kbdmap 5 ,
.Xr rc.conf 5
.Sh AUTHORS
Index: usr.sbin/kbdmap/kbdmap.1
===================================================================
--- usr.sbin/kbdmap/kbdmap.1 (revision 270244)
+++ usr.sbin/kbdmap/kbdmap.1 (working copy)
@@ -29,7 +29,7 @@
.Sh NAME
.Nm kbdmap ,
.Nm vidfont
-.Nd front end for syscons
+.Nd front end for syscons and vt
.Sh SYNOPSIS
.Nm
.Op Fl K
@@ -106,8 +106,10 @@
.Sh FILES
.Bl -tag -width ".Pa /usr/share/syscons/keymaps/INDEX.keymaps" -compact
.It Pa /usr/share/syscons/keymaps/INDEX.keymaps
+.It Pa /usr/share/vt/keymaps/INDEX.keymaps
database for keymaps
.It Pa /usr/share/syscons/fonts/INDEX.fonts
+.It Pa /usr/share/vt/fonts/INDEX.fonts
database for fonts
.It Pa /etc/rc.conf
default font
@@ -120,6 +122,8 @@
.Xr dialog 1 ,
.Xr kbdcontrol 1 ,
.Xr vidcontrol 1 ,
+.Xr syscons 4 ,
+.Xr vt 4 ,
.Xr kbdmap 5 ,
.Xr rc.conf 5
.Sh HISTORY
Index: usr.bin/lock/lock.1
===================================================================
--- usr.bin/lock/lock.1 (revision 270244)
+++ usr.bin/lock/lock.1 (working copy)
@@ -69,11 +69,14 @@
and thus has the same restrictions.
It is only available if the terminal in question is a
.Xr syscons 4
+or
+.Xr vt 4
virtual terminal.
.El
.Sh SEE ALSO
.Xr vidcontrol 1 ,
.Xr syscons 4
+.Xr vt 4
.Sh HISTORY
The
.Nm
Index: usr.sbin/vidcontrol/vidcontrol.1
===================================================================
--- usr.sbin/vidcontrol/vidcontrol.1 (revision 270244)
+++ usr.sbin/vidcontrol/vidcontrol.1 (working copy)
@@ -1,5 +1,5 @@
.\"
-.\" vidcontrol - a utility for manipulating the syscons video driver
+.\" 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
@@ -48,6 +48,8 @@
.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.
@@ -158,8 +160,11 @@
.Sx Video Mode Support
and
.Sx EXAMPLES
-below and the man page for
-.Xr syscons 4 .
+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
@@ -185,7 +190,10 @@
Install screen output map file from
.Ar screen_map .
See also
-.Xr syscons 4 .
+.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
@@ -307,6 +315,9 @@
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
@@ -313,6 +324,9 @@
.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.
@@ -453,9 +467,12 @@
.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.
+screen output map files (relevant for
+.Xr syscons 4
+only).
.El
.Sh EXAMPLES
If you want to load
@@ -467,7 +484,10 @@
.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 ,
+.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
@@ -521,6 +541,7 @@
.Xr screen 4 ,
.Xr syscons 4 ,
.Xr vga 4 ,
+.Xr vt 4 ,
.Xr rc.conf 5 ,
.Xr kldload 8 ,
.Xr moused 8 ,
Index: usr.sbin/kbdcontrol/kbdmap.5
===================================================================
--- usr.sbin/kbdcontrol/kbdmap.5 (revision 270244)
+++ usr.sbin/kbdcontrol/kbdmap.5 (working copy)
@@ -313,6 +313,7 @@
.Sh FILES
.Bl -tag -width /usr/share/syscons/keymaps/* -compact
.It Pa /usr/share/syscons/keymaps/*
+.It Pa /usr/share/vt/keymaps/*
standard keyboard map files
.El
.Sh SEE ALSO
@@ -320,6 +321,7 @@
.Xr kbdmap 1 ,
.Xr keyboard 4 ,
.Xr syscons 4 ,
+.Xr vt 4 ,
.Xr ascii 7
.Sh HISTORY
This manual page first appeared in
Index: usr.sbin/bsdconfig/bsdconfig.8
===================================================================
--- usr.sbin/bsdconfig/bsdconfig.8 (revision 270244)
+++ usr.sbin/bsdconfig/bsdconfig.8 (working copy)
@@ -172,16 +172,27 @@
(startup_rcconf) of startup.
.It Cm startup_rcvar
Shortcut to the Toggle Startup Services menu under startup.
+.\" use neutral name, e.g. console_keymap instead of syscons_keymap?
+.\" font (encoding) selection not applicable to vt(4)!
.It Cm syscons_font
Shortcut to the Font menu under console.
+.\" .It Cm console_keymap
+.\" Shortcut to the Keymap menu under console.
.It Cm syscons_keymap
Shortcut to the Keymap menu under console.
+.\" .It Cm vt_repeat
+.\" Shortcut to the Repeat menu under console.
.It Cm syscons_repeat
Shortcut to the Repeat menu under console.
+.\" .It Cm vt_saver
+.\" Shortcut to the Saver menu under console.
.It Cm syscons_saver
Shortcut to the Saver menu under console.
+.\" screenmap (encoding) selection not applicable to vt(4)!
.It Cm syscons_screenmap
Shortcut to the Screenmap menu under console.
+.\" .It Cm vt_syscons_ttys
+.\" Shortcut to the Ttys menu under console.
.It Cm syscons_ttys
Shortcut to the Ttys menu under console.
.It Cm timezone
Index: usr.sbin/bsdinstall/bsdinstall.8
===================================================================
--- usr.sbin/bsdinstall/bsdinstall.8 (revision 270244)
+++ usr.sbin/bsdinstall/bsdinstall.8 (working copy)
@@ -95,6 +95,8 @@
.It Cm keymap
If the current controlling TTY is a
.Xr syscons 4
+or
+.Xr vt 4
console, asks the user to set the current keymap, and saves the result to the
new system's
.Pa rc.conf .
More information about the freebsd-hackers
mailing list