Bug#1065094: pdftex.1: some remarks and editorial changes for this man page

2024-03-02 Thread Hilmar Preuße

Control: tags -1 + fixed-upstream

On 29.02.24 19:33, Bjarni Ingi Gislason wrote:

Hi,


Dear Maintainer,

   here are some notes and editorial fixes for the manual.



Karl Berry told me "I installed the pdftex.man patch, with a few minor 
adjustments for the current source." I tag as fixed in upstream.


H.
--
--
Testmail



OpenPGP_signature.asc
Description: OpenPGP digital signature


Bug#1065094: pdftex.1: some remarks and editorial changes for this man page

2024-02-29 Thread Preuße

Control: forwarded -1 https://tug.org/pipermail/tldistro/2024q1/000474.html

On 29.02.2024 19:33, Bjarni Ingi Gislason wrote:

Hello,


   here are some notes and editorial fixes for the manual.

The patch is in the attachment.



I've forwarded to tldistro for now.

Hilmar
--
sigfault



OpenPGP_signature.asc
Description: OpenPGP digital signature


Bug#1065094: pdftex.1: some remarks and editorial changes for this man page

2024-02-29 Thread Bjarni Ingi Gislason
Package: texlive-binaries
Version: 2023.20230311.66589-9
Severity: minor
Tags: patch

Dear Maintainer,

  here are some notes and editorial fixes for the manual.

The patch is in the attachment.

-.-.

The difference between the formatted outputs can be seen with:

  nroff -man  > 
  nroff -man  > 
  diff -u  

and for groff, using

"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "

instead of "nroff -man"

  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 -z"

export MAN_KEEP_STDERR=yes (or any non-empty value)

-.-.

Output from "mandoc -T lint pdftex.1":

mandoc: pdftex.1:35:70: STYLE: whitespace at end of input line
mandoc: pdftex.1:38:7: STYLE: whitespace at end of input line
mandoc: pdftex.1:84:65: STYLE: whitespace at end of input line
mandoc: pdftex.1:92:55: STYLE: whitespace at end of input line
mandoc: pdftex.1:329:2: WARNING: skipping paragraph macro: PP empty
mandoc: pdftex.1:417:34: STYLE: whitespace at end of input line
mandoc: pdftex.1:432:61: STYLE: whitespace at end of input line

-.-.

Input file is pdftex.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".

35:If the file argument has no extension, ".tex" will be appended to it. 
38:With a 
84:PostScript (EPS) graphics files; first convert them to PDF using 
92:extensions, and pdfe\*(TX is just a copy of pdf\*(TX.  See 
417:DVI or PDF file will be invalid.  
432:documentation for this version of pdf\*(TX can be found in the 

-.-.

Use the correct macro for the font change of a single argument or
split the argument into two.

433:.IR "pdf\*(TX user manual"

-.-.

Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, u[2010]) in the output.

44:.B -fmt
61:.B -ini
98:.BI -cnf-line \ string
105:.B -draftmode
109:.B -enc
112:.BR -ini .
116:.B -etex
119:.BR -ini .
123:.B -file-line-error
128:.B -no-file-line-error
133:.B -file-line-error-style
135:.B -file-line-error
138:.BI -fmt \ format
146:.B -halt-on-error
149:.B -help
152:.B -ini
160:.BI -interaction \ mode
170:.B -ipc
174:.B -ipc-start
176:.BR -ipc ,
180:.BI -jobname \ name
185:.BI -kpathsea-debug \ bitmask
190:.BI -mktex \ fmt
200:.B -mltex
202:.BR -ini .
204:.BI -no-mktex \ fmt
214:.BI -output-comment \ string
220:.BI -output-directory \ directory
227:.BI -output-format \ format
236:.B -parse-first-line
240:.B -translate-file
243:.B -no-parse-first-line
246:.BI -progname \ name
251:.B -recorder
257:.B -shell-escape
265:.B -no-shell-escape
272:.B -shell-restricted
276:.B -src-specials
280:.BI -src-specials \ where
294:.BI -synctex \ NUMBER
299:.BI -translate-file \ tcxname
305:.BI -default-translate-file \ tcxname
307:.B -translate-file
312:.B -version
315:.B -8bit

-.-.

Find a repeated word

! 87 --> of

-.-.

Wrong distance between sentences.

  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.

217:for the DVI file comment instead of the date. This option is ignored in
277:In DVI mode, insert source specials into the DVI file. This option is
281:In DVI mode, insert source specials in certain places of the DVI file. The
295:generate SyncTeX data for previewers according to bits of NUMBER. See the
327:and hence is expanded, not taken as part of the filename. Other
453:\*(TX was designed by Donald E. Knuth,

-.-.

Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z 
-rCHECKSTYLE=0":

Bad use of \s0 in a string definition, the string could be resized.

10:.if t .ds BX \fRB\s-2IB\s0\fP\*(TX
13:.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
20:.if t .ds WB W\s-2EB\s0

-- System Information:
Debian Release: trixie/sid
  APT prefers testing
  APT policy: (990, 'testing'), (500, 'stable-security')
Architecture: amd64 (x86_64)

Kernel: Linux 6.7.6-1