Bug#902236: catchsegv.1: Some corrections to the manual
Package: libc-bin
Version: 2.27-3
Severity: minor
Tags: patch
Summary:
Remove space at end of lines.
Add a backslash if line ends in '\{'.
Define the macro "IX" also for F=0.
Use the italic font for names of variable content.
Begin a sentence in a new line when only one space character is between
sentences.
Details:
Input file is catchsegv.1
mandoc: catchsegv.1:85:14: STYLE: whitespace at end of input line
mandoc: catchsegv.1:87:19: 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".
85:.\" TH Title
87:.\" Sh Subsection
#####
Input file is catchsegv.1
Test nr. 2:
Enable and fix warnings from 'test-groff'.
troff: <catchsegv.1>:208: warning: macro 'IX' not defined
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. 17:
Add a backslash, if it is missing after \{ at the end of a line.
92:.if \nF \{
#####
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"]
202:\fIcatchsegv\fR was written by Ulrich Drepper for the GNU C Library
#####
Input file is catchsegv.1
Test nr. 29:
Surround a block of comments with the macros ".ig" and "..".
The .\" (\#) at the beginning of each line is then not needed.
Makes it easier to add and remove text and adjust length of lines.
NO PATCH
2:.\" $RCSfile: catchsegv.1,v $$Revision: 1.1.2.1 $$Date: 2003/09/22 21:33:35 $
3:.\"
4:.\" $Log: catchsegv.1,v $
5:.\" Revision 1.1.2.1 2003/09/22 21:33:35 jbailey
6:.\" New directory for things we add to the package
7:.\"
8:.\"
37:.\"
38:.\"
39:.\" Set up \*(-- to give an unbreakable dash;
40:.\" string Tr holds user defined translation string.
41:.\" Bell System Logo is used as a dummy character.
42:.\"
51:.\" \*(M", \*(S", \*(N" and \*(T" are the equivalent of
52:.\" \*(L" and \*(R", except that they are used on ".xx" lines,
53:.\" such as .IP and .SH, which do another additional levels of
54:.\" double-quote interpretation
83:.\" If the F register is turned on, we'll generate
84:.\" index entries out stderr for the following things:
85:.\" TH Title
86:.\" SH Header
87:.\" Sh Subsection
88:.\" Ip Item
89:.\" X<> Xref (embedded
90:.\" Of course, you have to process the output yourself
91:.\" in some meaningful fashion.
#####
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" (.!?).
198:Used to debug segmentation faults in programs. The output is the
199:content of registers, plus a backtrace. Basically you call your
#####
Patch:
--- catchsegv.1 2018-03-29 19:47:29.000000000 +0000
+++ catchsegv.1.new 2018-06-22 18:21:18.000000000 +0000
@@ -82,17 +82,22 @@
'br\}
.\" If the F register is turned on, we'll generate
.\" index entries out stderr for the following things:
-.\" TH Title
+.\" TH Title
.\" SH Header
-.\" Sh Subsection
+.\" Sh Subsection
.\" Ip Item
.\" X<> Xref (embedded
.\" Of course, you have to process the output yourself
.\" in some meaningful fashion.
-.if \nF \{
+.ie \nF \{\
.de IX
.tm Index:\\$1\t\\n%\t"\\$2"
..
+.\}
+.el \{\
+.de IX
+..
+.\}
.nr % 0
.rr F
.\}
@@ -193,10 +198,12 @@
.SH "NAME"
catchsegv \- Catch segmentation faults in programs
.SH "SYNOPSIS"
-\fBcatchsegv\fR \fBprogram\fR [\fBargs\fR]
+\fBcatchsegv\fR \fIprogram\fR [\,\fIargs\fR\/]
.SH "DESCRIPTION"
-Used to debug segmentation faults in programs. The output is the
-content of registers, plus a backtrace. Basically you call your
+Used to debug segmentation faults in programs.
+The output is the
+content of registers, plus a backtrace.
+Basically you call your
program and its arguments as the arguments to catchsegv.
.SH "AUTHOR"
\fIcatchsegv\fR was written by Ulrich Drepper for the GNU C Library
-- 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 libc-bin depends on:
ii libc6 2.27-3
Versions of packages libc-bin recommends:
ii manpages 4.16-1
libc-bin suggests no packages.
-- no debconf information
--
Bjarni I. Gislason
Reply to: