Package: libpodofo-utils
Version: 0.9.8+dfsg-3.1+b2
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man
page"
[Use "groff -e ' $' <file>" to find trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
troff:<stdin>:99: warning: trailing space in the line
an-end-check:<stdin>: Warning: Different number of .RS and .RE calls,
an-RS-open=2 at end of file
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.6-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages libpodofo-utils depends on:
ii libc6 2.40-4
ii libgcc-s1 14.2.0-8
ii liblua5.1-0 5.1.5-10
ii libpodofo0.9.8t64 0.9.8+dfsg-3.1+b2
ii libssl3t64 3.3.2-2
ii libstdc++6 14.2.0-8
libpodofo-utils recommends no packages.
libpodofo-utils suggests no packages.
-- no debconf information
Input file is podofoencrypt.1
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
Not beginning each input sentence on a new line.
Lines should thus be shorter.
See man-pages(7), item 'semantic newline'.
-.-
The difference between the formatted output of the original and patched file
can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - "
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output of 'diff -u' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint podofoencrypt.1": (shortened list)
2 input text line longer than 80 bytes
7 skipping paragraph macro
-.-.
Output from "test-groff -mandoc -t -ww -z podofoencrypt.1": (shortened list)
1 trailing space in the line
-.-.
Wrong distance between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
12:useful operations to work with PDF files\. It can encrypt PDF files using RC4
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 7, length 119
\fBpodofoencrypt\fR [\-\-rc4v1] [\-\-rc4v2] [\-\-aes] [\-u <userpassword>] \-o
<ownerpassword> <inputfile> <outputfile>
Line 66, length 85
Allow modification of the document besides annotations, form fields or changing
pages
Line 78, length 149
Add or modify text annotations or form fields (if ePdfPermissions_Edit is set
also allow the creation of interactive form fields including signature)
-.-.
Remove reverse slash (\) in front of a period (.) that is to be printed
as such, and can not come a control character in the first column of a line.
Use "\&" to protect the period to avoid that.
This is a sign, that the man page was transformed from another source
file with a program, whose name is NOT mentioned in a comment.
12:useful operations to work with PDF files\. It can encrypt PDF files using RC4
13:or AES encoding and can set PDF security settings\.
124:PoDoFo is written by Dominik Seichter <domseichter@web\.de> and others\.
126:This manual page was written by Oleksandr Moskalenko <malex@debian\.org> for
127:the Debian Project (but may be used by others)\.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
podofoencrypt.1:36:Use aes encryption (currently not supported)
podofoencrypt.1:78:Add or modify text annotations or form fields (if
ePdfPermissions_Edit is set also allow the creation of interactive form fields
including signature)
-.-.
Put a subordinate sentence (after a comma) on a new line.
66:Allow modification of the document besides annotations, form fields or
changing pages
96:Assemble the document: insert, create, rotate delete pages or add bookmarks
-.-.
Remove quotes when there is no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
1:.TH "PODOFOENCRYPT" "1" "2010-12-09" "PoDoFo" "podofoencrypt"
15:.SH "OPTIONS"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:99: warning: trailing space in the line
an-end-check:<stdin>: Warning: Different number of .RS and .RE calls,
an-RS-open=2 at end of file
-.-.
Spelling:
disabillities -> disabilities
-.-
Additionally (general):
Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.
There is no need to add a '\&' before a full stop (.) if it has a character
before it!
'\&' is only needed at the beginning of a line, if it otherwise starts with
a control character "." or "'".
--- podofoencrypt.1 2025-01-04 09:48:13.632029356 +0000
+++ podofoencrypt.1.new 2025-01-04 10:26:41.887368028 +0000
@@ -1,18 +1,17 @@
-.TH "PODOFOENCRYPT" "1" "2010-12-09" "PoDoFo" "podofoencrypt"
-.PP
+.TH PODOFOENCRYPT 1 2010-12-09 PoDoFo podofoencrypt
.SH NAME
podofoencrypt \- encrypt PDF files and set PDF security settings
-.PP
.SH SYNOPSIS
-\fBpodofoencrypt\fR [\-\-rc4v1] [\-\-rc4v2] [\-\-aes] [\-u <userpassword>] \-o
<ownerpassword> <inputfile> <outputfile>
-.PP
+\fBpodofoencrypt\fR [\-\-rc4v1] [\-\-rc4v2] [\-\-aes] [\-u <userpassword>]
+\-o <ownerpassword> <inputfile> <outputfile>
.SH DESCRIPTION
.B podofoencrypt
is one of the command line tools from the PoDoFo library that provide several
-useful operations to work with PDF files\. It can encrypt PDF files using RC4
-or AES encoding and can set PDF security settings\.
-.PP
-.SH "OPTIONS"
+useful operations to work with PDF files.
+It can encrypt PDF files using RC4
+or AES encoding
+and can set PDF security settings.
+.SH OPTIONS
\fB\-\-help\fR
.RS
Display the help text
@@ -63,7 +62,8 @@ Allow printing the document
\fB\-\-edit\fR
.RS
.PP
-Allow modification of the document besides annotations, form fields or
changing pages
+Allow modification of the document besides annotations,
+form fields or changing pages.
.RE
.PP
\fB\-\-copy\fR
@@ -75,7 +75,10 @@ Allow extraction of text and graphics
\fB\-\-editnotes\fR
.RS
.PP
-Add or modify text annotations or form fields (if ePdfPermissions_Edit is set
also allow the creation of interactive form fields including signature)
+Add or modify text annotations
+or form fields
+(if ePdfPermissions_Edit is set
+also allow the creation of interactive form fields including signature).
.RE
.PP
\fB\-\-fillandsign\fR
@@ -87,20 +90,22 @@ Fill in existing form or signature field
\fB\-\-accessible\fR
.RS
.PP
-Extract text and graphics to support user with disabillities
+Extract text and graphics to support user with disabilities
.RE
.PP
\fB\-\-assemble\fR
.RS
.PP
-Assemble the document: insert, create, rotate delete pages or add bookmarks
+Assemble the document:
+insert, create, rotate, delete pages or add bookmarks
.RE
.PP
-\fB\-\-highprint \fR
+\fB\-\-highprint\fR
.RS
.PP
Print a high resolution version of the document
-.PP
+.RE
+.RE
.SH SEE ALSO
.BR podofobox (1),
.BR podofocolor (1),
@@ -118,10 +123,8 @@ Print a high resolution version of the d
.BR podofotxtextract (1),
.BR podofouncompress (1),
.BR podofoxmp (1)
-.PP
.SH AUTHORS
+PoDoFo is written by Dominik Seichter <domseich...@web.de> and others.
.PP
-PoDoFo is written by Dominik Seichter <domseichter@web\.de> and others\.
-.PP
-This manual page was written by Oleksandr Moskalenko <malex@debian\.org> for
-the Debian Project (but may be used by others)\.
+This manual page was written by Oleksandr Moskalenko <ma...@debian.org> for
+the Debian Project (but may be used by others).
