Skip to content

Commit

Permalink
Update man pages
Browse files Browse the repository at this point in the history
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.

Also added the AUTHORS section to man-pages.

Signed-off-by: Alexey Gladkov <[email protected]>
  • Loading branch information
legionus committed Oct 25, 2024
1 parent ba28482 commit f126e60
Show file tree
Hide file tree
Showing 28 changed files with 243 additions and 131 deletions.
20 changes: 14 additions & 6 deletions docs/man/man1/chvt.1
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -24,8 +24,16 @@ 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\-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
.I "\-h, \-\-help"
show this text and exit.
\fB\-h\fR, \fB\-\-help\fR
print this usage message.
.SH AUTHORS
Andries Brouwer <[email protected]>
.SH "SEE ALSO"
.BR deallocvt (1),
.BR openvt (1)
15 changes: 10 additions & 5 deletions docs/man/man1/deallocvt.1
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -23,11 +23,16 @@ 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\-C\fR, \fB\-\-console\fR=\fI\,DEV\/\fR
the console device to be used.
.TP
.I "\-h, \-\-help"
show this text and exit.
\fB\-V\fR, \fB\-\-version\fR
print version number.
.TP
\fB\-h\fR, \fB\-\-help\fR
print this usage message.
.SH AUTHORS
Andries Brouwer <[email protected]>
.SH "SEE ALSO"
.BR chvt (1),
.BR openvt (1)
Expand Down
42 changes: 21 additions & 21 deletions docs/man/man1/fgconsole.1
Original file line number Diff line number Diff line change
@@ -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 ,
Expand All @@ -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
Expand All @@ -41,10 +40,11 @@ the consoles are in
.IR /dev/vc/N .
.I devfsd
may maintain symlinks for compatibility.
.SH AUTHORS
Andries Brouwer <[email protected]>
.br
Manpage by Alastair McKinstry <[email protected]>
.SH "SEE ALSO"
.BR chvt (1).
.\" .SH "AUTHORS"
.\" Andries Brouwer
.\" .br
.\" Manpage by Alastair McKinstry <[email protected]>

.BR chvt (1),
.BR deallocvt (1),
.BR openvt (1)
2 changes: 2 additions & 0 deletions docs/man/man1/kbd_mode.1
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ when some program left your keyboard in the wrong state.
Note that in some obsolete versions of this program the "\-u"
option was a synonym for "\-s" and older versions of this program may
not recognize the "\-f" option.
.SH AUTHORS
Andries Brouwer <[email protected]>
.SH "SEE ALSO"
.BR loadkeys (1)

4 changes: 2 additions & 2 deletions docs/man/man1/kbdinfo.1
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
26 changes: 14 additions & 12 deletions docs/man/man1/openvt.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Copyright 1994-95 Jon Tombs ([email protected], [email protected])
.\" May be distributed under the GNU General Public License
.TH OPENVT 1 "19 Jul 1996" "kbd"
.TH OPENVT 1 "24 October 2024" "kbd"
.SH NAME
openvt \- start a program on a new virtual terminal (VT).
.SH SYNOPSIS
Expand All @@ -17,45 +17,45 @@ search path ($PATH) is used to find the requested command. If no command is
specified then the environment variable $SHELL is used.
.SS OPTIONS
.TP
.I "\-c, \-\-console=VTNUMBER"
\fB\-c\fR, \fB\-\-console\fR=\fI\,VTNUMBER\/\fR
Use the given VT number and not the first available. Note you
must have write access to the supplied VT for this to work.
.TP
.I "\-f, \-\-force"
\fB\-f\fR, \fB\-\-force\fR
Force opening a VT without checking whether it is already in use.
.TP
.I "\-e, \-\-exec"
\fB\-e\fR, \fB\-\-exec\fR
Directly execute the given command, without forking.
This option is meant for use in
.IR /etc/inittab .
.TP
.I "\-s, \-\-switch"
\fB\-s\fR, \fB\-\-switch\fR
Switch to the new VT when starting the command. The VT of the new command
will be made the new current VT.
.TP
.I "\-u, \-\-user"
\fB\-u\fR, \fB\-\-user\fR
Figure out the owner of the current VT, and run login as that user.
Suitable to be called by init. Shouldn't be used with \fI\-c\fR or \fI\-l\fR.
.TP
.I "\-l, \-\-login"
\fB\-l\fR, \fB\-\-login\fR
Make the command a login shell. A \- is prepended to the name of the command
to be executed.
.TP
.I "\-v, \-\-verbose"
\fB\-v\fR, \fB\-\-verbose\fR
Be a bit more verbose.
.TP
.I "\-w, \-\-wait"
\fB\-w\fR, \fB\-\-wait\fR
wait for command to complete. If \-w and \-s are used together then
.B openvt
will switch back to the controlling terminal when the command completes.
.TP
.I "\-V, \-\-version"
\fB\-V\fR, \fB\-\-version\fR
print program version and exit.
.TP
.I "\-h, \-\-help"
\fB\-h\fR, \fB\-\-help\fR
show this text and exit.
.TP
.I "\-\-"
\fB\-\-\fR
end of options to
.BR openvt .
.SH NOTE
Expand Down Expand Up @@ -89,4 +89,6 @@ The \fI\-w\fR idea is from "sam".

.SH "SEE ALSO"
.BR chvt (1),
.BR deallocvt (1),
.BR vlock (1),
.BR login (1)
2 changes: 2 additions & 0 deletions docs/man/man1/setleds.1
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ console output.)
.SH "BUGS"
In keyboard application mode the NumLock key does not
influence the NumLock flag setting.
.SH AUTHORS
Andries Brouwer <[email protected]>
.SH "SEE ALSO"
.BR loadkeys (1)

6 changes: 4 additions & 2 deletions docs/man/man1/setmetamode.1
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,15 @@ 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.
.SH AUTHORS
Andries Brouwer <[email protected]>
.SH "SEE ALSO"
.BR loadkeys (1),
.BR kbdinfo (1)
Expand Down
2 changes: 2 additions & 0 deletions docs/man/man1/showkey.1
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ corresponds to what the keyboard hardware did send. So, if you want
to know the scan codes sent by various keys it is better to boot a
2.4 kernel. Since 2.6.9 there also is the boot option atkbd.softraw=0
that tells the 2.6 kernel to return the actual scan codes.
.SH AUTHORS
Andries Brouwer <[email protected]>
.SH "SEE ALSO"
.BR loadkeys (1),
.BR dumpkeys (1),
Expand Down
2 changes: 2 additions & 0 deletions docs/man/man1/unicode_start.1
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ When no font was specified, the current font is kept.
.SH NOTE
Unicode mode is a parameter with a value per virtual console.
However, usually the font and keymap is common to all consoles.
.SH AUTHORS
Andries Brouwer <[email protected]>
.SH "SEE ALSO"
.BR dumpkeys (1),
.BR kbd_mode (1),
Expand Down
2 changes: 2 additions & 0 deletions docs/man/man1/unicode_stop.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ command will more-or-less undo the effect of
.BR unicode_start .
It puts the keyboard in ASCII (XLATE) mode, and clears
the console UTF-8 mode.
.SH AUTHORS
Andries Brouwer <[email protected]>
.SH "SEE ALSO"
.BR kbd_mode (1),
.BR unicode_start (1),
Expand Down
6 changes: 5 additions & 1 deletion docs/man/man1/vlock.1
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,9 @@ Print a brief help message.
.IP
Print the version number of \fBvlock\fR.
.PP
.SH AUTHOR
.SH AUTHORS
Michael K. Johnson <[email protected]>
.SH "SEE ALSO"
.BR chvt (1),
.BR deallocvt (1),
.BR openvt (1)
12 changes: 6 additions & 6 deletions docs/man/man1misc/codepage.1
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ ega.cpi, execute:
codepage ega.cpi 850
.RE

.\" .SH AUTHORS
.\" Ahmed M. Naas <[email protected]>
.\" .br
.\" Andries Brouwer <[email protected]>
.\" .br
.\" Manpage by Alastair McKinstry <[email protected]>
.SH AUTHORS
Ahmed M. Naas <[email protected]>
.br
Andries Brouwer <[email protected]>
.br
Manpage by Alastair McKinstry <[email protected]>

25 changes: 16 additions & 9 deletions docs/man/man1misc/screendump.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -47,10 +54,10 @@ permissions, or run
.B screendump
as root.

.SH AUTHORS
Andries Brouwer <[email protected]>
.BR
Manpage by Alastair McKinstry <[email protected]>

.SH SEE ALSO
.BR setterm (1)

.\" .SH AUTHORS
.\" Andries Brouwer <[email protected]>
.\" .br
.\" Manpage by Alastair McKinstry <[email protected]>
3 changes: 3 additions & 0 deletions docs/man/man5/keymaps.5
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,9 @@ altgr keycode 32 = F100
string F100 = "du\\ndf\\n"
.RE
.LP
.SH AUTHORS
Andries Brouwer <[email protected]>
.LP
.SH "SEE ALSO"
.BR loadkeys (1),
.BR dumpkeys (1),
Expand Down
8 changes: 7 additions & 1 deletion docs/man/man8/getkeycodes.8
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
Loading

0 comments on commit f126e60

Please sign in to comment.