[Pkg-sysvinit-devel] Bug#905245: killall5.8: Some formatting fixes in the manual

[Bjarni Ingi Gislason]

Package: sysvinit-utils
Version: 2.88dsf-59.10
Severity: minor
Tags: patch

Fix warnings from test-groff.

Use the correct font macro.

Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(minus) if it matches " -[:alpha:]" or \(aq-[:alpha:] (for options).

Use three periods for an ellipsis.

Begin a sentence on a new line or have two space characters between
sentences.

###

  Details:


Test nr. 2:

Enable and fix warnings from 'test-groff'.

Input file is ./killall5.8

<killall5.8>:23 (macro RB): only 1 argument, but more are expected
<killall5.8>:25 (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" ]

#####

Test nr. 16:

Use the correct macro for the font change of a single argument.

23:.RB -signalnumber

#####

Test nr. 21:

Use a macro to change to the italic font, instead of \fI [1], if
possible.
The macros have the italic corrections, but "\c" removes them.

  Or

add the italic corrections.
[1] man-pages(7) [package "manpages"]

36:Tells \fIkillall5\fP to omit processes with that process id.
38:\fIkillall5\fP can also be invoked as pidof, which is simply a
39:(symbolic) link to the \fIkillall5\fP program.

#####

Test nr. 25:

Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.

23:.RB -signalnumber
35:.IP "-o \fIomitpid\fP"

#####

Test nr. 33:

Three full stops (periods) are used for an ellipsis

25:.IR omitpid[,omitpid..]]
27:.IR omitpid[,omitpid..].. ]

#####

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" (.!?).

30:is the SystemV killall command. It sends a signal to all processes except
32:the shell that is running the script it was called from. Its primary

#####

  Patch:

--- killall5.8	2017-09-08 19:18:37.000000000 +0000
+++ killall5.8.new	2018-08-02 00:30:12.000000000 +0000
@@ -17,22 +17,20 @@
 .\"
 .TH KILLALL5 8 "04 Nov 2003" "" "Linux System Administrator's Manual"
 .SH NAME
-killall5 -- send a signal to all processes.
+killall5 \- send a signal to all processes.
 .SH SYNOPSIS
 .B killall5
-.RB -signalnumber
-.RB [ \-o
-.IR omitpid[,omitpid..]]
+.BI \- signalnumber
 .RB [ \-o
-.IR omitpid[,omitpid..].. ]
+.IR omitpid [, omitpid "]...\&] \&...\&"
 .SH DESCRIPTION
 .B killall5
-is the SystemV killall command. It sends a signal to all processes except
+is the SystemV killall command.  It sends a signal to all processes except
 kernel threads and the processes in its own session, so it won't kill
-the shell that is running the script it was called from. Its primary
+the shell that is running the script it was called from.  Its primary
 (only) use is in the \fBrc\fP scripts found in the /etc/init.d directory.
 .SH OPTIONS
-.IP "-o \fIomitpid\fP"
+.IP "\fB\-o \fIomitpid\fR"
 Tells \fIkillall5\fP to omit processes with that process id.
 .SH NOTES
 \fIkillall5\fP can also be invoked as pidof, which is simply a


-- 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.17.8-3 (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 sysvinit-utils depends on:
ii  init-system-helpers  1.51
ii  libc6                2.27-5
ii  util-linux           2.32-0.1

sysvinit-utils recommends no packages.

sysvinit-utils suggests no packages.

-- no debconf information

-- 
Bjarni I. Gislason