[Pkg-kbd-devel] Bug#900223: dumpkeys.1: Some changes in the manual
Bjarni Ingi Gislason
bjarniig at rhi.hi.is
Sun May 27 19:04:50 BST 2018
Package: kbd
Version: 2.0.4-2
Severity: minor
Tags: patch
Dear Maintainer,
* What led up to the situation?
Warning from "groff":
<dumpkeys.1>:217 (macro BI): only 1 argument, but more are expected
Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z
[ "test-groff" is a developmental version of "groff" ]
The patch is in the attachment.
##
Summary:
Begin a sentence on a new line
Change "ie." to "i.e.,"
Change '--' to '\-\-' to indicate an option.
Remove unneeded '.LP' lines
Change '-' to '\(en' when it means a numeric range
Change a two-fonts macro to an one-font macro for only one argument
Remove an empty line at the end of the file
###
Details:
Input file is dumpkeys.1
mandoc: dumpkeys.1:123:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:123:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:123:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:126:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:138:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:145:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:161:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:164:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:172:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:180:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:187:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:206:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:209:2: WARNING: skipping paragraph macro: LP empty
mandoc: dumpkeys.1:213:2: WARNING: skipping paragraph macro: LP empty
#######
Test nr. 5:
Change '-' (\-) to '\(en' (en-dash) for a numeric range.
dumpkeys.1:198:Where X is a digit in 1-9. If no
#####
Test nr. 8:
Protect a full stop (.) with "\&", if it has a blank (white-space) in
front of or (ignoring characters transparent to it) after it, and it
does not mean an end of a sentence.
68:definition, ie. the
#####
Test nr. 13:
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
95:.B --long-info
121:.B dumpkeys --funcs-only
132:.B --short-info
#####
Test nr. 16:
Use the correct macro for the font change of one argument.
Split a punctuation mark from the only argument if one is there
217:.BI /usr/share/keymaps
#####
Test nr. 41:
Wrong distance between sentences or protect the indicator.
1) Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) [package "manpages"] and "info groff".
Or
2) Adjust space between sentences (two spaces),
3) or protect the indicator by adding "\&" after it.
The "indicator" is an "end-of-sentence character" (.!?).
38:Prints some characteristics of the kernel's keyboard driver. The items
47:keyword in keytable files. See
56:various modifier keys. If the value is 16 for example, you can define up
57:to 16 different actions to a key combined with modifiers. When the value
68:definition, ie. the
87:usually remain the same. However, the list of action code ranges can be
93:program. To see this, you compare the range list with the action symbol
103:strings of characters. These action codes are traditionally bound to
105:to send standard escape sequences. However, you can redefine these to
110:to send some useful strings. See
131:to print a long information listing. The output is the same as with the
152:and output the key bindings in the canonical form. First a keymaps
154:is printed. Then for each key a row with a column for each
155:modifier combination is printed. For
157:every row will have seven action code columns. This format
169:prints only the function key string definitions. Normally
177:prints only the key bindings. Normally
193:set. This affects only the translation of character code values to
194:symbolic names. Valid values for
204:loadkeys how to interpret the keymap. (For example, "division" is
#####
-- System Information:
Debian Release: buster/sid
APT prefers stable-updates
APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500, 'testing'), (500, 'stable')
Architecture: amd64 (x86_64)
Kernel: Linux 4.9.88-1-u1 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages kbd depends on:
ii libc6 2.27-3
Versions of packages kbd recommends:
ii console-data 2:1.12-6
ii console-setup 1.184
kbd suggests no packages.
-- no debconf information
--
Bjarni I. Gislason
-------------- next part --------------
--- dumpkeys.1 2017-09-15 08:33:29.000000000 +0000
+++ dumpkeys.1.new 2018-05-26 01:01:31.000000000 +0000
@@ -35,8 +35,8 @@ Prints the program's version number and
program's standard error output and exits.
.TP
.B \-i \-\-short-info
-Prints some characteristics of the kernel's keyboard driver. The items
-shown are:
+Prints some characteristics of the kernel's keyboard driver.
+The items shown are:
.LP
.RS
Keycode range supported by the kernel
@@ -44,7 +44,8 @@ Keycode range supported by the kernel
.RS
This tells what values can be used after the
.B keycode
-keyword in keytable files. See
+keyword in keytable files.
+See
.BR keymaps (5)
for more information and the syntax of these files.
.RE
@@ -53,8 +54,10 @@ Number of actions bindable to a key
.LP
.RS
This tells how many different actions a single key can output using
-various modifier keys. If the value is 16 for example, you can define up
-to 16 different actions to a key combined with modifiers. When the value
+various modifier keys.
+If the value is 16 for example, you can define up
+to 16 different actions to a key combined with modifiers.
+When the value
is 16, the kernel probably knows about four modifier keys, which you can
press in different combinations with the key to access all the bound
actions.
@@ -65,7 +68,7 @@ Ranges of action codes supported by the
.RS
This item contains a list of action code ranges in hexadecimal notation.
These are the values that can be used in the right hand side of a key
-definition, ie. the
+definition, i.e., the
.IR vv 's
in a line
.LP
@@ -84,15 +87,17 @@ and
.BR loadkeys (1)
support a symbolic notation, which is preferable to the numeric one, as
the action codes may vary from kernel to kernel while the symbolic names
-usually remain the same. However, the list of action code ranges can be
+usually remain the same.
+However, the list of action code ranges can be
used to determine, if the kernel actually supports all the symbols
.BR loadkeys (1)
knows, or are there maybe some actions supported by the kernel that
have no symbolic name in your
.BR loadkeys (1)
-program. To see this, you compare the range list with the action symbol
+program.
+To see this, you compare the range list with the action symbol
list, see option
-.B --long-info
+.B \-\-long-info
below.
.RE
.LP
@@ -100,14 +105,17 @@ Number of function keys supported by ker
.LP
.RS
This tells the number of action codes that can be used to output
-strings of characters. These action codes are traditionally bound to
+strings of characters.
+These action codes are traditionally bound to
the various function and editing keys of the keyboard and are defined
-to send standard escape sequences. However, you can redefine these to
+to send standard escape sequences.
+However, you can redefine these to
send common command lines, email addresses or whatever you like.
Especially if the number of this item is greater than the number of
function and editing keys in your keyboard, you may have some "spare"
action codes that you can bind to AltGr-letter combinations, for example,
-to send some useful strings. See
+to send some useful strings.
+See
.BR loadkeys (1)
for more details.
.RE
@@ -118,106 +126,102 @@ Function strings
You can see you current function key definitions with the command
.LP
.RS
-.B dumpkeys --funcs-only
+.B dumpkeys \-\-funcs-only
.RE
-.LP
.RE
.RE
-.LP
.TP
.B \-l \-s \-\-long-info
This option instructs
.B dumpkeys
-to print a long information listing. The output is the same as with the
-.B --short-info
+to print a long information listing.
+The output is the same as with the
+.B \-\-short-info
appended with the list of action symbols supported by
.BR loadkeys (1)
and
.BR dumpkeys (1),
along with the symbols' numeric values.
-.LP
.TP
.B \-n \-\-numeric
This option causes
.B dumpkeys
to by-pass the conversion of action code values to symbolic notation and
to print the in hexadecimal format instead.
-.LP
.TP
.B \-f \-\-full-table
This makes
.B dumpkeys
skip all the short-hand heuristics (see
.BR keymaps (5))
-and output the key bindings in the canonical form. First a keymaps
+and output the key bindings in the canonical form.
+First a keymaps
line describing the currently defined modifier combinations
-is printed. Then for each key a row with a column for each
-modifier combination is printed. For
-example, if the current keymap in use uses seven modifiers,
-every row will have seven action code columns. This format
+is printed.
+Then for each key a row with a column for each
+modifier combination is printed.
+For example, if the current keymap in use uses seven modifiers,
+every row will have seven action code columns.
+This format
can be useful for example to programs that post-process the
output of
.BR dumpkeys .
-.LP
.TP
.BI \-S shape " " " " \-\-shape= shape
-.LP
.TP
.B \-t \-\-funcs-only
When this option is given,
.B dumpkeys
-prints only the function key string definitions. Normally
+prints only the function key string definitions.
+Normally
.B dumpkeys
prints both the key bindings and the string definitions.
-.LP
.TP
.B \-k \-\-keys-only
When this option is given,
.B dumpkeys
-prints only the key bindings. Normally
+prints only the key bindings.
+Normally
.B dumpkeys
prints both the key bindings and the string definitions.
-.LP
.TP
.B \-d \-\-compose-only
When this option is given,
.B dumpkeys
prints only the compose key combinations.
This option is available only if your kernel has compose key support.
-.LP
.TP
.BI \-c charset " " " " \-\-charset= charset
This instructs
.B dumpkeys
to interpret character code values according to the specified character
-set. This affects only the translation of character code values to
-symbolic names. Valid values for
+set.
+This affects only the translation of character code values to
+symbolic names.
+Valid values for
.I charset
currently are
.BR iso-8859-X ,
-Where X is a digit in 1-9. If no
+Where X is a digit in 1\(en9. If no
.I charset
is specified,
.B iso-8859-1
is used as a default.
This option produces an output line `charset "iso-8859-X"', telling
-loadkeys how to interpret the keymap. (For example, "division" is
+loadkeys how to interpret the keymap.
+(For example, "division" is
0xf7 in iso-8859-1 but 0xba in iso-8859-8.)
-.LP
.TP
.B \-v \-\-verbose
-.LP
.TP
.B \-V \-\-version
Prints version number and exits.
-.LP
.SH FILES
.PD 0
.TP 20
-.BI /usr/share/keymaps
+.B /usr/share/keymaps
recommended directory for keytable files
.PD
.SH "SEE ALSO"
.BR loadkeys (1),
.BR keymaps (5)
-
More information about the Pkg-kbd-devel
mailing list