Bug 105194

Summary:	pdffonts.1: Minor formatting changes in the manual
Product:	poppler	Reporter:	bjarniig
Component:	utils	Assignee:	poppler-bugs <poppler-bugs>
Status:	RESOLVED FIXED	QA Contact:
Severity:	minor
Priority:	medium	CC:	bjarniig
Version:	unspecified
Hardware:	x86-64 (AMD64)
OS:	Linux (All)
Whiteboard:
i915 platform:		i915 features:
Attachments:	Minor corrections to the manual

Description bjarniig 2018-02-21 15:05:32 UTC

Package: poppler-utils
Version: 0.61.1-2
Severity: minor
Tags: patch

Dear Maintainer,

Input file is pdffonts.1

Test nr. 2: Fix warning from man/groff
Test nr. 14: Change a two-fonts macro to an one-font macro.

72:.BI \-subst

Input file is /tmp/pdffonts.1

<standard input>:72 (macro BI): 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. 5: Change <number>-<number> to <number>\(en<number> if it is
a numeric range

pdffonts.1:109:The pdffonts software and documentation are copyright 1996-2011 Glyph

#####

Test nr. 6: Change " -- " to " \(en ", if it is an en-dash, otherwise to "\(em".

22:the font type -- see below for details
47:Type 1C -- aka Compact Font Format (CFF)
56:CID Type 0 -- 16-bit font with no specified type
59:CID Type 0C -- 16-bit PostScript CFF font
62:CID TrueType -- 16-bit TrueType font

#####

  Additionally:

  Add a comma and

  add a nohypenation and left adjustment in section "SEE ALSO".


  The patch:

--- pdffonts.1	2018-02-20 22:14:14.000000000 +0000
+++ pdffonts.1.new	2018-02-20 23:15:59.000000000 +0000
@@ -19,7 +19,7 @@ the font name, exactly as given in the P
 a subset prefix)
 .TP
 .B type
-the font type -- see below for details
+the font type \(en see below for details
 .TP
 .B encoding
 the font encoding
@@ -44,7 +44,7 @@ PDF files can contain the following type
 Type 1
 .RE
 .RS
-Type 1C -- aka Compact Font Format (CFF)
+Type 1C \(en aka Compact Font Format (CFF)
 .RE
 .RS
 Type 3
@@ -53,13 +53,13 @@ Type 3
 TrueType
 .RE
 .RS
-CID Type 0 -- 16-bit font with no specified type
+CID Type 0 \(en 16-bit font with no specified type
 .RE
 .RS
-CID Type 0C -- 16-bit PostScript CFF font
+CID Type 0C \(en 16-bit PostScript CFF font
 .RE
 .RS
-CID TrueType -- 16-bit TrueType font
+CID TrueType \(en 16-bit TrueType font
 .RE
 .SH OPTIONS
 .TP
@@ -69,7 +69,7 @@ Specifies the first page to analyze.
 .BI \-l " number"
 Specifies the last page to analyze.
 .TP
-.BI \-subst
+.B \-subst
 List the substitute fonts that poppler will use for non embedded fonts.
 .TP
 .BI \-opw " password"
@@ -106,9 +106,11 @@ Error related to PDF permissions.
 99
 Other error.
 .SH AUTHOR
-The pdffonts software and documentation are copyright 1996-2011 Glyph
+The pdffonts software and documentation are copyright 1996\(en2011 Glyph
 & Cog, LLC.
 .SH "SEE ALSO"
+.nh
+.ad l
 .BR pdfdetach (1),
 .BR pdfimages (1),
 .BR pdfinfo (1),
@@ -116,7 +118,7 @@ The pdffonts software and documentation
 .BR pdftohtml (1),
 .BR pdftoppm (1),
 .BR pdftops (1),
-.BR pdftotext (1)
+.BR pdftotext (1),
 .BR pdfseparate (1),
 .BR pdfsig (1),
 .BR pdfunite (1)


-- 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 poppler-utils depends on:
ii  libc6         2.26-6
ii  libcairo2     1.15.10-1
ii  libfreetype6  2.8.1-2
ii  liblcms2-2    2.9-1
ii  libpoppler72  0.61.1-2
ii  libstdc++6    8-20180207-2

poppler-utils recommends no packages.

poppler-utils suggests no packages.

-- no debconf information

Comment 1 Albert Astals Cid 2018-02-21 20:38:13 UTC

Can you please attach the patch as a diff file instead of as text in the description?

Comment 2 bjarniig 2018-02-23 02:13:56 UTC

Created attachment 137551 [details] [review]
Minor corrections to the manual

Was asked to add the patch as an attachment

Comment 3 Albert Astals Cid 2018-02-25 11:43:43 UTC

I've no idea about manpages, so this question may be silly

  add a nohypenation and left adjustment in section "SEE ALSO".

Why is this needed? we don't have any hyphen and isn't left adjustment the default?

Comment 4 bjarniig 2018-05-03 14:15:29 UTC

  The additional ".nh" is better, so readers do not think the hyphen is a part of a name.  Also to avoid wrong hyphenation.

  The ".ad l" is mainly for cosmetic (better) look (line not stretched), especially when there is no hyphenated word.

  The default by "man" (Debian) is to hyphenate and adjust on both sides.

  I see a worse formatting when I produce a pdf-version of the manual, so a better change is

.if t \{\
.  nh
.  ad l
.\}

Comment 5 Albert Astals Cid 2018-05-04 13:29:49 UTC

I've commited the patch from comment #2

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.