Bug#892230: man.1: Some minor typographic changes in the manual

2019-09-08 Thread Colin Watson
tag 892230 fixed-upstream
tag 892421 fixed-upstream
tag 927452 fixed-upstream
thanks

Thanks for this and for your related reports #892421 and #927452.  I've
dealt with these all in one go, as they cover largely similar ground,
and the fact that these pages are translated means that it's better to
apply the same changes to everything at once where possible in order
that translators have less work to do.

On Wed, Mar 07, 2018 at 01:10:18AM +, Bjarni Ingi Gislason wrote:
> Test nr. 1: Remove space at end of lines to simplify other automatic tests to 
> improve
> typesetting.

I applied this to all man-db's manual pages in one go.

  
https://git.savannah.gnu.org/cgit/man-db.git/commit/?id=44ec6b98ebfc8f667d3c4f75992544021d733fc0

> Test nr. 24: 
> Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
> name for an option.
> 
> 1110:.I groff -mandoc
> 1167:.I groff -mandoc

Your patch was against the generated page, but this part of the page
comes from values computed by configure, so it required a bit more work:

  
https://git.savannah.gnu.org/cgit/man-db.git/commit/?id=0fdc8e921622d3614c22082a6934548e4a161bbc

> Test nr. 27: Split lines longer than 80 characters into two or more
> lines.
> 
> man.1: line 170   length 108
> man.1: line 1232  length 85

Similarly, this part of the page is generated based on configure output,
so I took a different approach:

  
https://git.savannah.gnu.org/cgit/man-db.git/commit/?id=9d96b22859d7a3f532690bc87b743667be048f5c

> 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

I chose not to bother with this, although I deleted some block comments
as a result of other changes.  Most of the comments in question change
extremely rarely so I've never found it an inconvenience, and of course
it has no effect on the output either way.

I might take this approach for any block comments I add in the future.

On Fri, Mar 09 2018 at 00:22:39AM +, Bjarni Ingi Gislason wrote:
> 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

I had to take a somewhat different approach here and for similar changes
in #927452 to pacify po4a, whose parser doesn't always quite manage to
cope with more complex troff programming techniques; and I took the same
approach for the same options consistently across all man-db's manual
pages:

  
https://git.savannah.gnu.org/cgit/man-db.git/commit/?id=57fcd4f1ea201074aef9437c407efde6b26247fb

I think the extra italic correction after --systems=system is
unnecessary given the following \|, but please let me know if this is
wrong.  I couldn't figure out a formatting pipeline where I could see
any difference.

I applied the remainder of your patches here:

  
https://git.savannah.gnu.org/cgit/man-db.git/commit/?id=d84bb1a3586dfca2389eed428c11bde7225ceb0b
  
https://git.savannah.gnu.org/cgit/man-db.git/commit/?id=f876af69a2b53242a39febdc531c811d60dfa90a
  
https://git.savannah.gnu.org/cgit/man-db.git/commit/?id=7604d2695f86922d9981186d7fc49c4c635aadd4

Thanks,

-- 
Colin Watson   [cjwat...@debian.org]



Bug#892230: man.1: Some minor typographic changes in the manual

2018-03-06 Thread Bjarni Ingi Gislason
Package: man-db
Version: 2.8.2-1
Severity: minor
Tags: patch

Dear Maintainer,

Input file is man.1

Test nr. 1: Remove space at end of lines to simplify other automatic tests to 
improve
typesetting.

173:directive in 

#

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

Input file is /tmp/man.1

:169 (macro IR): only 1 argument, but more are expected
:330 (macro BR): only 1 argument, but more are expected
:916 (macro IR): only 1 argument, but more are expected
:1180 (macro BR): only 1 argument, but more are expected
:1402 (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.

169:.IR sections
330:.BR dvips.
916:.IR x
1180:.BR \-\-usage
1402:.BR FSSTND

#

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.

1409:30th April 1994 \(en 23rd February 2000: Wilf. (g.wilf...@ee.surrey.ac.uk)

#

Test nr. 20: Use a macro to change to the italic font, instead of \fI [1], if
possible.
The macros have the italic corrections.
[1] man-pages(7)

291:from section \fI7\fR.

#

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

1110:.I groff -mandoc
1167:.I groff -mandoc

#

Test nr. 27: Split lines longer than 80 characters into two or more
lines.

man.1: line 170 length 108
man.1: line 1232length 85

#

Test nr. 28: The "indicator" is an "end-of-sentence character" (.!?).

  The space between sentences in "roff" is two spaces.
Better is to begin each sentence on a new line to avoid different
writers' conventions.

  References:

  1) man-pages(7) from package \"man-pages\" or
\"www.kernel.org/doc/man-pages\" section 7 or
\"man7.org/linux/man-pages/man7/man-pages.7.html\":

\"New sentences should be started on new lines.
This makes it easier to see the effect of patches,
which often operate at the level of individual sentences.\"

  2) groff_diff(7) in package \"groff\":

\"In GNU troff, as in UNIX troff, you should always follow a sentence
with either a newline or two spaces.\"

  3) \"info groff\":

  Search for the word \"sentence\" in the output to get more hints about input
conventions.

480:database caches. If the
1409:30th April 1994 \(en 23rd February 2000: Wilf. (g.wilf...@ee.surrey.ac.uk)

#

  NO PATCH

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

2:.\" ** The above line should force tbl to be a preprocessor **
3:.\" Man page for man
4:.\"
5:.\" Copyright (C) 1994, 1995, Graeme W. Wilford. (Wilf.)
6:.\" Copyright (C) 2001, 2002, 2003, 2006, 2007, 2008 Colin Watson.
7:.\"
8:.\" You may distribute under the terms of the GNU General Public
9:.\" License as specified in the file COPYING that comes with the
10:.\" man-db distribution.
11:.\"
12:.\" Sat Oct 29 13:09:31 GMT 1994  Wilf. (g.wilf...@ee.surrey.ac.uk)
13:.\"
19:.\" The general command line
66:.\" The apropos command line
74:.\" The --global-apropos command line
85:.\" The whatis command line
93:.\" The --local command line
126:.\" The --where/--where-cat command line
136:.\" The --catman command line
146:.\" --help and --version
414:.\"`User' manual page hierarchies will have
415:.\".B index
416:.\"caches created `on the fly'.
451:.\"
452:.\" Need a \c to make sure we don't get a space where we don't want one
453:.\"
557:.\" 
635:.\" Compressed nroff source files with a supported compression
636:.\" extension will be decompressed by man prior to being displaying via the
637:.\" usual filters.
688:.\"
689:.\" Due to the rather silly limit of 6 args per request in some `native'
690:.\" *roff compilers, we have do the following to get the two-line
691:.\" hanging tag on one line. .PP to begin a new paragraph, then the
692:.\" tag, then .RS (start relative indent), the text, finally .RE
693:.\" (end relative indent).
694:.\"
918:.\"The default options are
919:.\".BR \-six8 .
923:.\"The actual default will depend on your chosen
924:.\".BR locale .
929:.\"You may need to do this if your
930:.\"version of
931:.\".B less
932:.\"rejects the default options or if you prefer a different prompt.
1202:.\".TP \w'MANROFFSEQ\ \ 'u

#

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

1375:.I /usr/share/man/index.(bt|db|dir|pag)
1380:.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-updat