[Pkg-kbd-devel] Bug#900224: fgconsole.1: Some formatting and textual fixes in the manual

[Bjarni Ingi Gislason]

Package: kbd
Version: 2.0.4-2
Severity: minor
Tags: patch

Dear Maintainer,

   * What led up to the situation?

  Warnings from "groff":

<fgconsole.1>:8 (macro BI): only 1 argument, but more are expected
<fgconsole.1>:42 (macro IR): 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" ]

###

  Summary of changes:

Fix spelling of "Feburary"

Fix formatting in the SYNOPSIS line

Remove space at end of lines.

Add missing "--n" in the description

Begin a sentence in a new line

Change a two-fonts macro to an one-font macro.

  The patch is in the attachment.

###

  Details:

Input file is fgconsole.1

mandoc: fgconsole.1:22:41: STYLE: whitespace at end of input line
mandoc: fgconsole.1:23:9: STYLE: whitespace at end of input line
mandoc: fgconsole.1:38:6: STYLE: whitespace at end of input line
mandoc: fgconsole.1:40:20: STYLE: whitespace at end of input line

#######

Test nr. 1:

Remove space characters at the end of lines.

Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".

22:If the console is a serial console, then 
23:"serial" 
38:Under 
40:the consoles are in 

#####

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

8:.BI [
42:.IR devfsd

#####

Input file is fgconsole.1
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" (.!?).

33:Will show the next unallocated virtual terminal. Normally 6 virtual

#####


-- 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 --------------
--- fgconsole.1	2017-09-15 08:33:29.000000000 +0000
+++ fgconsole.1.new	2018-05-27 00:09:31.000000000 +0000
@@ -1,17 +1,12 @@
-.TH FGCONSOLE 1 "14 Feburary 2002" "" "Linux User's Manual"
+.TH FGCONSOLE 1 "14 February 2002" "" "Linux User's Manual"
 
 .SH NAME
 fgconsole \- print the number of the active VT.
 
 .SH SYNOPSIS
 .B fgconsole
-.BI [
-\-h \-\-help
-|
-\-V \-\-version
-|
-\-n \-\-next-available
-]
+.RB "[ " "\-h \-\-help" " | " "\-V \-\-version" " | " \
+"\-n \-\-next-available" " ]"
 .SH DESCRIPTION
 If the active Virtual Terminal is
 .IR /dev/ttyN ,
@@ -19,8 +14,8 @@ then prints
 .I N
 on standard output.
 
-If the console is a serial console, then 
-"serial" 
+If the console is a serial console, then
+"serial"
 is printed instead.
 .TP
 .I \-h \-\-help
@@ -29,17 +24,18 @@ Prints short usage message and exits.
 .I \-V \-\-version
 Prints version number and exits.
 .TP
-.I \-\-next\-available
-Will show the next unallocated virtual terminal. Normally 6 virtual
+.I \-n \-\-next\-available
+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.
 
 .SH NOTES
-Under 
+Under
 .IR devfs ,
-the consoles are in 
+the consoles are in
 .IR /dev/vc/N .
-.IR devfsd
+.I devfsd
 may maintain symlinks for compatibility.
 .SH "SEE ALSO"
 .BR chvt (1).