Update man pages

The man-pages of the utilities do not contain supported options. We need to add new options and document the missing ones in the man-page. Signed-off-by: Alexey Gladkov <[email protected]>
legionus · Oct 24, 2024 · 69675a2 · 69675a2
1 parent f027566
commit 69675a2
Show file tree

Hide file tree

Showing 16 changed files with 162 additions and 88 deletions.
diff --git a/docs/man/man1/chvt.1 b/docs/man/man1/chvt.1
@@ -1,11 +1,11 @@
 .\" @(#)chvt.1 1.0 970126 aeb
-.TH CHVT 1 "26 January 1997" "kbd"
+.TH CHVT 1 "24 October 2024" "kbd"
 .SH NAME
 chvt \- change foreground virtual terminal
 .SH SYNOPSIS
 .B chvt
 [\fI\,option\/\fR...]
-.I N
+[\fI\,N\/\fR]
 .SH DESCRIPTION
 The command
 .B chvt
@@ -24,8 +24,11 @@ The key combination
 in the range 1-12) usually has a similar effect.
 .SH OPTIONS
 .TP
-.I "\-V, \-\-version"
-print program version and exit.
+\fB\-V\fR, \fB\-\-version\fR
+print version number.
 .TP
-.I "\-h, \-\-help"
-show this text and exit.
+\fB\-h\fR, \fB\-\-help\fR
+print this usage message.
+.SH "SEE ALSO"
+.BR deallocvt (1),
+.BR openvt (1)
diff --git a/docs/man/man1/deallocvt.1 b/docs/man/man1/deallocvt.1
@@ -1,5 +1,5 @@
 .\" @(#)deallocvt.1 1.0 970317 aeb
-.TH DEALLOCVT 1 "17 Mar 1997" "kbd"
+.TH DEALLOCVT 1 "24 October 2024" "kbd"
 .SH NAME
 deallocvt \- deallocate unused virtual consoles
 .SH SYNOPSIS
@@ -23,11 +23,11 @@ and no process has it open for reading or writing, and no text
 has been selected on its screen.
 .SH OPTIONS
 .TP
-.I "\-V, \-\-version"
-print program version and exit.
+\fB\-V\fR, \fB\-\-version\fR
+print version number.
 .TP
-.I "\-h, \-\-help"
-show this text and exit.
+\fB\-h\fR, \fB\-\-help\fR
+print this usage message.
 .SH "SEE ALSO"
 .BR chvt (1),
 .BR openvt (1)

diff --git a/docs/man/man1/fgconsole.1 b/docs/man/man1/fgconsole.1
@@ -1,17 +1,11 @@
-.TH FGCONSOLE 1 "14 February 2002" "kbd"
+.TH FGCONSOLE 1 "24 October 2024" "kbd"
 
 .SH NAME
 fgconsole \- print the number of the active VT.
 
 .SH SYNOPSIS
 .B fgconsole
-[
-.B \-h \-\-help
-|
-.B \-V \-\-version
-|
-.B \-n \-\-next-available
-]
+[\fI\,options\/\fR]
 .SH DESCRIPTION
 If the active Virtual Terminal is
 .IR /dev/ttyN ,
@@ -22,17 +16,22 @@ on standard output.
 If the console is a serial console, then
 "serial"
 is printed instead.
+
+.SH OPTIONS
 .TP
-.I \-h \-\-help
-Prints short usage message and exits.
-.TP
-.I \-V \-\-version
-Prints version number and exits.
-.TP
-.I \-\-next\-available
+\fB\-n\fR, \fB\-\-next\-available\fR
 Will show the next unallocated virtual terminal. Normally 6 virtual
 terminals are allocated, with number 7 used for X; this will return
 "8" in this case.
+.TP
+\fB\-C\fR, \fB\-\-console\fR=\fI\,DEV\/\fR
+the console device to be used.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+print version number.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print this usage message.
 
 .SH NOTES
 Under

diff --git a/docs/man/man1/kbdinfo.1 b/docs/man/man1/kbdinfo.1
@@ -76,10 +76,10 @@ The caps lock is down.
 .SH OPTIONS
 .TP
 \fB\-C\fR, \fB\-\-console\fR=\fI\,DEV\/\fR
-the console device to be used;
+the console device to be used.
 .TP
 \fB\-V\fR, \fB\-\-version\fR
-print version number;
+print version number.
 .TP
 \fB\-h\fR, \fB\-\-help\fR
 print this usage message.

diff --git a/docs/man/man1/setmetamode.1 b/docs/man/man1/setmetamode.1
@@ -48,10 +48,10 @@ The Meta key sets the high order bit of the character.
 .SH OPTIONS
 .TP
 \fB\-C\fR, \fB\-\-console\fR=\fI\,DEV\/\fR
-the console device to be used;
+the console device to be used.
 .TP
 \fB\-V\fR, \fB\-\-version\fR
-print version number;
+print version number.
 .TP
 \fB\-h\fR, \fB\-\-help\fR
 print this usage message.

diff --git a/docs/man/man1misc/screendump.1 b/docs/man/man1misc/screendump.1
@@ -4,10 +4,9 @@
 screendump \- dump the contents of a virtual console to stdout
 
 .SH SYNOPSIS
-.B screendump 
-[
-.I N
-]
+.B screendump
+[\fI\,options\/\fR]
+[\fI\,N\/\fR]
 
 .SH DESCRIPTION
 The
@@ -23,6 +22,14 @@ cat /dev/vcsN
 .RE
 has a similar effect.
 
+.SH OPTIONS
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+print version number.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print this usage message.
+
 .SH NOTES
 For security reasons,
 .B screendump

diff --git a/docs/man/man8/getkeycodes.8 b/docs/man/man8/getkeycodes.8
@@ -4,12 +4,18 @@
 getkeycodes \- print kernel scancode-to-keycode mapping table
 .SH SYNOPSIS
 .B getkeycodes
+[\fI\,options\/\fR]
 .SH DESCRIPTION
 The
 .I getkeycodes
 command prints the kernel scancode-to-keycode mapping table.
 .SH OPTIONS
-None.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+print version number;
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print this usage message.
 .SH "SEE ALSO"
 .BR setkeycodes (8)
 

diff --git a/docs/man/man8/loadunimap.8.gen b/docs/man/man8/loadunimap.8.gen
@@ -1,18 +1,11 @@
 .\" @(#)loadunimap.8 1.0 970317 aeb
-.TH LOADUNIMAP 8 "2004-01-01" "kbd"
+.TH LOADUNIMAP 8 "24 October 2024" "kbd"
 .SH NAME
 loadunimap \- load the kernel unicode-to-font mapping table
 .SH SYNOPSIS
 .B loadunimap
-[
-.B \-C
-.I console
-] [
-.B \-o
-.I oldmap
-] [
-.I map
-]
+[\fI\,options\/\fR]
+[\fI\,map\/\fR]
 .SH DESCRIPTION
 The
 .B loadunimap
@@ -30,11 +23,6 @@ mapping table is assumed.
 The default extension (that can be omitted) is
 .IR .uni .
 .LP
-If the
-.B -o
-.I oldmap
-option is given, the old map is saved in the file specified.
-.LP
 On Linux 2.6.1 and later one can specify the console device using the
 .B \-C
 option.
@@ -43,6 +31,19 @@ Usually one does not call
 .B loadunimap
 directly - its function is also built into
 .BR setfont (8).
+.SH OPTIONS
+.TP
+\fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
+save the old map to the \fBFILE\fR.
+.TP
+\fB\-C\fR, \fB\-\-console\fR=\fI\,DEV\/\fR
+the console device to be used.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+print version number.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print this usage message.
 .SH FILES
 .TP
 .I @DATADIR@/@UNIMAPDIR@

diff --git a/docs/man/man8/mapscrn.8.gen b/docs/man/man8/mapscrn.8.gen
@@ -1,10 +1,10 @@
 .\" @(#)man/man8/mapscrn.8	1.0 3/19/93 17:04:00
-.TH MAPSCRN 8 "20 March 1993" "kbd"
+.TH MAPSCRN 8 "24 October 2024" "kbd"
 .SH NAME
 mapscrn \- load screen output mapping table
 .SH SYNOPSIS
-.BR mapscrn " [" -V "] [" -v "] [" -o
-.IR map.orig ]
+.BR mapscrn
+[\fI\,options\/\fR]
 .I mapfile
 .SH DESCRIPTION
 The
@@ -96,13 +96,22 @@ Single (possibly multi-byte) UTF-8 character, enclosed in single quotes.
 Note that control characters (with codes < 32) cannot be re-mapped with
 .I mapscrn
 because they have special meaning for the driver.
-.SH OTHER OPTIONS
+.SH OPTIONS
 .TP
-.B \-V
-Prints version number and exits.
+\fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR
+save the old map to the \fI\,FILE\/\fR.
 .TP
-.B \-v
-Be verbose.
+\fB\-C\fR, \fB\-\-console\fR=\fI\,DEV\/\fR
+the console device to be used.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+be more verbose.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+print version number.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print this usage message.
 .SH FILES
 .TP
 .I @DATADIR@/@TRANSDIR@

diff --git a/docs/man/man8/setfont.8.gen b/docs/man/man8/setfont.8.gen
@@ -1,4 +1,4 @@
-.TH SETFONT 8 "11 Feb 2001" "kbd"
+.TH SETFONT 8 "24 October 2024" "kbd"
 .SH NAME
 setfont \- load EGA/VGA console screen font
 .SH SYNOPSIS

diff --git a/docs/man/man8/setkeycodes.8 b/docs/man/man8/setkeycodes.8
@@ -1,9 +1,10 @@
 .\" @(#)man/man8/setkeycodes.8	1.0 Nov  8 22:30:48 MET 1994
-.TH SETKEYCODES 8 "8 Nov 1994" "kbd"
+.TH SETKEYCODES 8 "24 October 2024" "kbd"
 .SH NAME
 setkeycodes \- load kernel scancode-to-keycode mapping table entries
 .SH SYNOPSIS
 .B setkeycodes
+[\fI\,options\/\fR]
 .I "scancode keycode ..."
 .SH DESCRIPTION
 The
@@ -56,7 +57,15 @@ The code returned by showkey \-s will change after use of setkeycodes.
 A kernel bug. See also
 .BR showkey (1).
 .SH OPTIONS
-None.
+.TP
+\fB\-C\fR, \fB\-\-console\fR=\fI\,DEV\/\fR
+the console device to be used.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+print version number.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print this usage message.
 .SH BUGS
 The keycodes of X have nothing to do with those of Linux.
 Unusual keys can be made visible under Linux, but not under X.

diff --git a/docs/man/man8/setvtrgb.8 b/docs/man/man8/setvtrgb.8
@@ -60,7 +60,7 @@ prefixed with a number sign (#). For example:
 .SH OPTIONS
 .TP
 \fB\-C\fR, \fB\-\-console\fR=\fI\,DEV\/\fR
-the console device to be used;
+the console device to be used.
 .TP
 \fB\-h\fR, \fB\-\-help\fR
 Prints usage message and exits.

diff --git a/docs/man/man8/showconsolefont.8 b/docs/man/man8/showconsolefont.8
@@ -1,34 +1,36 @@
-.TH  SHOWCONSOLEFONT 8 "2002-02-22" "kbd"
+.TH  SHOWCONSOLEFONT 8 "24 October 2024" "kbd"
 
 .SH NAME
 showconsolefont \- Show the current EGA/VGA console screen font
 
 .SH SYNOPSIS
 .B showconsolefont
-[
-.B \-V | \-\-version
-] [
-.B \-v
-] [
-.B \-i
-] [
-.B \-C
-.I console
-]
+[\fI\,options\/\fR]
 
 .SH DESCRIPTION
 The
 .B showconsolefont
-command outputs the current console font to stdout. The option
-.B \-v
-prints additional information, while the option
-.B \-V
-prints the program version number. The option
-.B \-i
-doesn't print out the font table, just shows ROWSxCOLSxCOUNT and exits.
+command outputs the current console font to stdout.
 On Linux 2.6.1 and later, the option
 .B \-C
 allows one to indicate the console involved. Its argument is a pathname.
 
+.SH OPTIONS
+.TP
+\fB\-i\fR, \fB\-\-info\fR
+don't print out the font table, just show: ROWSxCOLSxCOUNT and exit.
+.TP
+\fB\-C\fR, \fB\-\-console\fR=\fI\,DEV\/\fR
+the console device to be used.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+be more verbose.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+print version number.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print this usage message.
+
 .SH "SEE ALSO"
 .BR setfont (8)