Package: man-db
Version: 2.8.2-1
Severity: minor
Tags: patch

Dear Maintainer,

Input file is apropos.1

Test nr. 1:
Remove space at end of lines to simplify other automatic tests to
improve typesetting.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".

6:.\" License as specified in the file COPYING that comes with the 
9:.\" Sat Oct 29 13:09:31 GMT 1994  Wilf. (g.wilf...@ee.surrey.ac.uk) 
10:.\" 
16:.B apropos 
33:Each manual page has a short description available within it. 
39:is usually a regular expression, as if 
124:.B \-m 
125:.I system\c 
127:.BI \-\-systems= system\c 
131:descriptions, they can be searched using this option. 
136:The 
139:To include a search of the native operating system's 
142:.B man 
152:By default, 
154:uses the 
156:environment variable, unless it is empty or unset, in which case it will 
157:determine an appropriate manpath based on your 
211:argument to the 
234:If 
236:is set, even to a null value, the default 
237:.B apropos 
238:search will be as an extended regex 
255:A traditional 

#####

Test nr. 2:
Enable and fix warnings from 'test-groff'.

Input file is /tmp/apropos.1

<standard input>:187 (macro BR): only 1 argument, but more are expected

chk_manuals: Output is from: test-groff -Tutf8 -b -e -mandoc -rF0 -t -w w -z 

Test nr. 15:
Change the name of a macro for two fonts (e.g., BR and IR) to one letter,
if there is only one argument.
Add the second argument if needed.  It is sometimes part of the first one.

187:.BR \-\-usage

#####

Test nr. 8:
Protect a full stop (.) with "\&", if it has a blank (white-space) in
front of or (ignoring transparent characters to the full stop) after
it, and it does not mean an end of a sentence.

9:.\" Sat Oct 29 13:09:31 GMT 1994  Wilf. (g.wilf...@ee.surrey.ac.uk) 
264:Wilf. (g.wilf...@ee.surrey.ac.uk).

#####

Test nr. 19:
Use '\e' to print the escape character instead of '\\'  (which gets
interpretet in copy mode).

48:or escape (\\) the special characters to stop the shell from interpreting

#####

Test nr. 20:
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.
[1] man-pages(7)

104:\fB\-s\fP \fIlist\fP, \fB\-\-sections\fP \fIlist\fP, \fB\-\-section\fP 
\fIlist\fP

#####

Test nr. 30:
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 lenght of lines.

NO PATCH

1:.\" Man page for apropos
2:.\"
3:.\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.)
4:.\"
5:.\" You may distribute under the terms of the GNU General Public
6:.\" License as specified in the file COPYING that comes with the 
7:.\" man-db distribution.
8:.\"
9:.\" Sat Oct 29 13:09:31 GMT 1994  Wilf. (g.wilf...@ee.surrey.ac.uk) 
10:.\" 
116:.\"
117:.\" Due to the rather silly limit of 6 args per request in some `native'
118:.\" *roff compilers, we have do the following to get the two-line
119:.\" hanging tag on one line. .PP to begin a new paragraph, then the
120:.\" tag, then .RS (start relative indent), the text, finally .RE
121:.\" (end relative indent).
122:.\"

#####

Test nr. 35:
Add a space around "|" to increase readability.

243:.I /usr/share/man/index.(bt|db|dir|pag)
248:.I /var/cache/man/index.(bt|db|dir|pag)

#####


The patch is in the attachment.

-- 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.80-2 (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 man-db depends on:
ii  bsdmainutils           11.1.2
ii  debconf [debconf-2.0]  1.5.66
ii  dpkg                   1.19.0.5
ii  groff-base             1.22.3-10
ii  libc6                  2.27-1
ii  libgdbm5               1.14.1-4
ii  libpipeline1           1.5.0-1
ii  libseccomp2            2.3.1-2.1
ii  zlib1g                 1:1.2.8.dfsg-5

man-db recommends no packages.

Versions of packages man-db suggests:
pn  apparmor                   <none>
ii  firefox-esr [www-browser]  52.6.0esr-2+b1
ii  groff                      1.22.3-10
ii  less                       487-0.1
ii  lynx [www-browser]         2.8.9dev16-3
ii  w3m [www-browser]          0.5.3-36

-- debconf information:
  man-db/auto-update: true
  man-db/install-setuid: false

-- 
Bjarni I. Gislason
--- apropos.1   2018-02-28 15:04:14.000000000 +0000
+++ apropos.1.new       2018-03-08 12:40:33.000000000 +0000
@@ -3,17 +3,17 @@
 .\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.)
 .\"
 .\" You may distribute under the terms of the GNU General Public
-.\" License as specified in the file COPYING that comes with the 
+.\" License as specified in the file COPYING that comes with the
 .\" man-db distribution.
 .\"
-.\" Sat Oct 29 13:09:31 GMT 1994  Wilf. (g.wilf...@ee.surrey.ac.uk) 
-.\" 
+.\" Sat Oct 29 13:09:31 GMT 1994  Wilf. (g.wilf...@ee.surrey.ac.uk)
+.\"
 .pc
 .TH APROPOS 1 "2018-02-28" "2.8.2" "Manual pager utils"
 .SH NAME
 apropos \- search the manual page names and descriptions
 .SH SYNOPSIS
-.B apropos 
+.B apropos
 .RB [\| \-dalv?V  \|]
 .RB [\| \-e \||\| \-w \||\| \-r\c
 \|]
@@ -30,13 +30,13 @@ apropos \- search the manual page names
 .I keyword
 \&.\|.\|.
 .SH DESCRIPTION
-Each manual page has a short description available within it. 
+Each manual page has a short description available within it.
 .B apropos
 searches the descriptions for instances of
 .IR keyword .
 
 .I keyword
-is usually a regular expression, as if 
+is usually a regular expression, as if
 .RB ( \-r )
 was used, or
 may contain wildcards
@@ -45,7 +45,7 @@ or match the exact keyword
 .RB ( \-e ).
 Using these options, it may be necessary to quote the
 .I keyword
-or escape (\\) the special characters to stop the shell from interpreting
+or escape (\e) the special characters to stop the shell from interpreting
 them.
 
 The standard matching rules allow matches to be made against the page name
@@ -100,8 +100,15 @@ Normally, output will be truncated to th
 results from poorly-written
 .B NAME
 sections.
+.\" Use macros instead of escapes, they have the italic corrections,
+.\" but '\c' removes them.
 .TP
-\fB\-s\fP \fIlist\fP, \fB\-\-sections\fP \fIlist\fP, \fB\-\-section\fP 
\fIlist\fP
+.\"\fB\-s\fP \fIlist\fP, \fB\-\-sections\fP \fIlist\fP, \fB\-\-section\fP 
\fIlist\fP
+\!.BI \-s " list" \/\c
+\!\fR, \c
+\!.BI \-\-sections " list" \/\c
+\!\fR, \c
+.BI \-\-section " list"
 Search only the given manual sections.
 .I list
 is a colon- or comma-separated list of sections.
@@ -119,27 +126,36 @@ pages in that exact part of the manual s
 .\" hanging tag on one line. .PP to begin a new paragraph, then the
 .\" tag, then .RS (start relative indent), the text, finally .RE
 .\" (end relative indent).
+.ig
+Or use
+.\" Last line must be longer than the indent used by .TP
+.TP
+\!.BI \-m " system\/\c
+\!\|[\|,.\|.\|.\|]\|, \c
+\!.BI \-\-systems= system\/\c
+\|[\|,.\|.\|.\|]\ \ \ \ 
+..
 .\"
 .PP
-.B \-m 
-.I system\c 
+.B \-m
+.I system\/\c
 \|[\|,.\|.\|.\|]\|,
-.BI \-\-systems= system\c 
+.BI \-\-systems= system\/\c
 \|[\|,.\|.\|.\|]
 .RS
 If this system has access to other operating system's manual page
-descriptions, they can be searched using this option. 
+descriptions, they can be searched using this option.
 To search NewOS's manual page descriptions, use the option
 .B \-m
 .BR NewOS .
 
-The 
+The
 .I system
 specified can be a combination of comma-delimited operating system names.
-To include a search of the native operating system's 
+To include a search of the native operating system's
 .B whatis
 descriptions, include the system name
-.B man 
+.B man
 in the argument string.
 This option will override the
 .RB $ SYSTEM
@@ -149,12 +165,12 @@ environment variable.
 .BI \-M\  path \fR,\ \fB\-\-manpath= path
 Specify an alternate set of colon-delimited manual page hierarchies to
 search.
-By default, 
+By default,
 .B apropos
-uses the 
+uses the
 .RB $ MANPATH
-environment variable, unless it is empty or unset, in which case it will 
-determine an appropriate manpath based on your 
+environment variable, unless it is empty or unset, in which case it will
+determine an appropriate manpath based on your
 .RB $ PATH
 environment variable.
 This option overrides the contents of
@@ -184,7 +200,7 @@ Use this user configuration file rather
 .BR \-? ", " \-\-help
 Print a help message and exit.
 .TP
-.BR \-\-usage
+.B \-\-usage
 Print a short usage message and exit.
 .TP
 .BR \-V ", " \-\-version
@@ -208,7 +224,7 @@ Nothing was found that matched the crite
 If
 .RB $ SYSTEM
 is set, it will have the same effect as if it had been specified as the
-argument to the 
+argument to the
 .B \-m
 option.
 .TP
@@ -231,28 +247,28 @@ an
 if available, or falling back to 80 characters if all else fails.
 .TP
 .B POSIXLY_CORRECT
-If 
+If
 .RB $ POSIXLY_CORRECT
-is set, even to a null value, the default 
-.B apropos 
-search will be as an extended regex 
+is set, even to a null value, the default
+.B apropos
+search will be as an extended regex
 .RB ( \-r ).
 Nowadays, this is the default behaviour anyway.
 .SH FILES
 .TP
-.I /usr/share/man/index.(bt|db|dir|pag)
+.I /usr/share/man/index.(bt\^|\^db\^|\^dir\^|\^pag)
 A traditional global
 .I index
 database cache.
 .TP
-.I /var/cache/man/index.(bt|db|dir|pag)
+.I /var/cache/man/index.(bt\^|\^db\^|\^dir\^|\^pag)
 An FHS
 compliant global
 .I index
 database cache.
 .TP
 .I /usr/share/man/\|.\|.\|.\|/whatis
-A traditional 
+A traditional
 .B whatis
 text database.
 .SH "SEE ALSO"
@@ -261,7 +277,7 @@ text database.
 .BR mandb (8)
 .SH AUTHOR
 .nf
-Wilf. (g.wilf...@ee.surrey.ac.uk).
+Wilf.\& (g.wilf...@ee.surrey.ac.uk).
 Fabrizio Polacco (fpola...@debian.org).
 Colin Watson (cjwat...@debian.org).
 .fi

Reply via email to