Bug#1065094: pdftex.1: some remarks and editorial changes for this man page
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 <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
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 (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 texlive-binaries depends on:
ii libc6 2.37-15
ii libcairo2 1.18.0-1+b1
ii libfontconfig1 2.15.0-1
ii libfreetype6 2.13.2+dfsg-1+b1
ii libgcc-s1 14-20240201-3
ii libgraphite2-3 1.3.14-2
ii libharfbuzz0b 8.3.0-2
ii libicu72 72.1-4+b1
ii libkpathsea6 2023.20230311.66589-9
ii libmpfr6 4.2.1-1+b1
ii libpaper1 1.1.29
ii libpixman-1-0 0.42.2-1+b1
ii libpng16-16 1.6.43-1
ii libpotrace0 1.16-2+b1
ii libptexenc1 2023.20230311.66589-9
ii libstdc++6 14-20240201-3
ii libsynctex2 2023.20230311.66589-9
ii libteckit0 2.5.12+ds1-1
ii libtexlua53-5 2023.20230311.66589-9
ii libx11-6 2:1.8.7-1
ii libxaw7 2:1.0.14-1
ii libxi6 2:1.8.1-1
ii libxmu6 2:1.1.3-3
ii libxpm4 1:3.5.17-1
ii libxt6 1:1.2.1-1.1
ii libzzip-0-13 0.13.72+dfsg.1-1.1+b1
ii perl 5.38.2-3
ii t1utils 1.41-4
ii tex-common 6.18
ii zlib1g 1:1.3.dfsg-3+b1
Versions of packages texlive-binaries recommends:
pn dvisvgm <none>
ii texlive-base 2023.20240207-1
Versions of packages texlive-binaries suggests:
pn hintview <none>
pn texlive-binaries-sse2 <none>
Versions of packages tex-common depends on:
ii ucf 3.0043+nmu1
Versions of packages tex-common suggests:
pn debhelper <none>
Versions of packages texlive-binaries is related to:
ii tex-common 6.18
ii texlive-base 2023.20240207-1
-- no debconf information
--- pdftex.1 2024-02-29 12:02:20.000000000 +0000
+++ pdftex.1.new 2024-02-29 18:04:22.000000000 +0000
@@ -7,17 +7,17 @@
.ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP
.el .ds OX TeX
.\" BX definition must follow TX so BX can use TX
-.if t .ds BX \fRB\s-2IB\s0\fP\*(TX
+.if t .ds BX \fRB\s-2IB\s+2\fP\*(TX
.if n .ds BX BibTeX
.\" LX definition must follow TX so LX can use TX
-.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
+.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s+2\\h'-0.15m'\\v'0.15v'\fP\*(TX
.if n .ds LX LaTeX
.if t .ds AX \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(TX
.if n .ds AX AmSTeX
.if t .ds AY \fRA\\h'-0.1667m'\\v'0.20v'M\\v'-0.20v'\\h'-0.125m'S\fP\*(LX
.if n .ds AY AmSLaTeX
.if n .ds WB Web
-.if t .ds WB W\s-2EB\s0
+.if t .ds WB W\s-2EB\s+2
.\"=====================================================================
.SH NAME
pdftex \- PDF output from TeX
@@ -32,16 +32,16 @@ Run the pdf\*(TX typesetter on
.IR file ,
usually creating
.IR file.pdf .
-If the file argument has no extension, ".tex" will be appended to it.
+If the file argument has no extension, ".tex" will be appended to it.
Instead of a filename, a set of pdf\*(TX commands can be given, the first
of which must start with a backslash.
-With a
+With a
.BI & format
argument pdf\*(TX uses a different set of precompiled commands,
contained in
.IR format\fB.fmt\fP ;
it is usually better to use the
-.B -fmt
+.B \-fmt
.I format
option instead.
.PP
@@ -58,7 +58,7 @@ command uses the equivalent of the plain
.B pdflatex
command uses the equivalent of the \*(LX format.
To generate formats, use the
-.B -ini
+.B \-ini
switch.
.PP
The
@@ -81,61 +81,61 @@ In PDF mode, pdf\*(TX can natively handl
and
.I PNG
graphics formats. pdf\*(TX cannot include PostScript or Encapsulated
-PostScript (EPS) graphics files; first convert them to PDF using
+PostScript (EPS) graphics files; first convert them to PDF using
.BR epstopdf (1).
pdf\*(TX's handling of its command-line arguments is similar to that of
-of the other \*(TX programs in the
+the other \*(TX programs in the
.I web2c
implementation.
.PP
Starting with version 1.40, pdf\*(TX incorporates the e-\*(TX
-extensions, and pdfe\*(TX is just a copy of pdf\*(TX. See
+extensions, and pdfe\*(TX is just a copy of pdf\*(TX. See
.BR etex (1).
.\"=====================================================================
.SH OPTIONS
This version of pdf\*(TX understands the following command line options.
.TP
-.BI -cnf-line \ string
+.BI \-cnf-line \ string
Parse
.I string
as a
.I texmf.cnf
configuration line. See the Kpathsea manual.
.TP
-.B -draftmode
+.B \-draftmode
Sets \epdfdraftmode so pdf\*(TX doesn't write a PDF and doesn't read any
included images, thus speeding up execution.
.TP
-.B -enc
+.B \-enc
Enable the enc\*(TX extensions. This option is only effective in
combination with
-.BR -ini .
+.BR \-ini .
For documentation of the enc\*(TX extensions see
http://www.olsak.net/enctex.html.
.TP
-.B -etex
+.B \-etex
Enable the e-\*(TX extensions. This option is only effective in
combination with
-.BR -ini .
+.BR \-ini .
See
.BR etex (1).
.TP
-.B -file-line-error
+.B \-file-line-error
Print error messages in the form
.I file:line:error
which is similar to the way many compilers format them.
.TP
-.B -no-file-line-error
+.B \-no-file-line-error
Disable printing error messages in the
.I file:line:error
style.
.TP
-.B -file-line-error-style
+.B \-file-line-error-style
This is the old name of the
-.B -file-line-error
+.B \-file-line-error
option.
.TP
-.BI -fmt \ format
+.BI \-fmt \ format
Use
.I format
as the name of the format to be used, instead of the name by which
@@ -143,13 +143,13 @@ pdf\*(TX was called or a
.I %&
line.
.TP
-.B -halt-on-error
+.B \-halt-on-error
Exit with an error code when an error is encountered during processing.
.TP
-.B -help
+.B \-help
Print help message and exit.
.TP
-.B -ini
+.B \-ini
Start in
.I INI
mode, which is used to dump formats. The
@@ -157,7 +157,7 @@ mode, which is used to dump formats. Th
mode can be used for typesetting, but no format is preloaded, and
basic initializations like setting catcodes may be required.
.TP
-.BI -interaction \ mode
+.BI \-interaction \ mode
Sets the interaction mode. The mode can be either
.IR batchmode ,
.IR nonstopmode ,
@@ -167,27 +167,27 @@ and
The meaning of these modes is the same as that of the corresponding
\ecommands.
.TP
-.B -ipc
+.B \-ipc
Send DVI or PDF output to a socket as well as the usual output file.
Whether this option is available is the choice of the installer.
.TP
-.B -ipc-start
+.B \-ipc-start
As
-.BR -ipc ,
+.BR \-ipc ,
and starts the server at the other end as well. Whether this option
is available is the choice of the installer.
.TP
-.BI -jobname \ name
+.BI \-jobname \ name
Use
.I name
for the job name, instead of deriving it from the name of the input file.
.TP
-.BI -kpathsea-debug \ bitmask
+.BI \-kpathsea-debug \ bitmask
Sets path searching debugging flags according to the bitmask. See the
.I Kpathsea
manual for details.
.TP
-.BI -mktex \ fmt
+.BI \-mktex \ fmt
Enable
.RI mktex fmt ,
where
@@ -197,11 +197,11 @@ must be either
or
.IR tfm .
.TP
-.B -mltex
+.B \-mltex
Enable ML\*(TX extensions. Only effective in combination with
-.BR -ini .
+.BR \-ini .
.TP
-.BI -no-mktex \ fmt
+.BI \-no-mktex \ fmt
Disable
.RI mktex fmt ,
where
@@ -211,20 +211,20 @@ must be either
or
.IR tfm .
.TP
-.BI -output-comment \ string
+.BI \-output-comment \ string
In DVI mode, use
.I string
-for the DVI file comment instead of the date. This option is ignored in
-PDF mode.
+for the DVI file comment instead of the date.
+This option is ignored in PDF mode.
.TP
-.BI -output-directory \ directory
+.BI \-output-directory \ directory
Write output files in
.I directory
instead of the current directory. Look up input files in
.I directory
first, the along the normal search path.
.TP
-.BI -output-format \ format
+.BI \-output-format \ format
Set the output format mode, where
.I format
must be either
@@ -233,28 +233,28 @@ or
.IR dvi .
This also influences the set of graphics formats understood by pdf\*(TX.
.TP
-.B -parse-first-line
+.B \-parse-first-line
If the first line of the main input file begins with
.I %&
parse it to look for a dump name or a
-.B -translate-file
+.B \-translate-file
option.
.TP
-.B -no-parse-first-line
+.B \-no-parse-first-line
Disable parsing of the first line of the main input file.
.TP
-.BI -progname \ name
+.BI \-progname \ name
Pretend to be program
.IR name .
This affects both the format used and the search paths.
.TP
-.B -recorder
+.B \-recorder
Enable the filename recorder.
This leaves a trace of the files opened for input and output
in a file with extension
.IR .fls .
.TP
-.B -shell-escape
+.B \-shell-escape
Enable the
.RI \ewrite18{ command }
construct. The
@@ -262,23 +262,24 @@ construct. The
can be any shell command. This construct is normally
disallowed for security reasons.
.TP
-.B -no-shell-escape
+.B \-no-shell-escape
Disable the
.RI \ewrite18{ command }
construct, even if it is enabled in the
.I texmf.cnf
file.
.TP
-.B -shell-restricted
+.B \-shell-restricted
Enable restricted \ewrite18{}, as explained in the ``Shell escapes''
section of the Web2c Texinfo manual.
.TP
-.B -src-specials
-In DVI mode, insert source specials into the DVI file. This option is
-ignored in PDF mode.
+.B \-src-specials
+In DVI mode, insert source specials into the DVI file.
+This option is ignored in PDF mode.
.TP
-.BI -src-specials \ where
-In DVI mode, insert source specials in certain places of the DVI file. The
+.BI \-src-specials \ where
+In DVI mode, insert source specials in certain places of the DVI file.
+The
.I where
argument is a comma-separated value list:
.IR cr ,
@@ -291,28 +292,29 @@ or
.IR vbox .
This option is ignored in PDF mode.
.TP
-.BI -synctex \ NUMBER
-generate SyncTeX data for previewers according to bits of NUMBER. See the
+.BI \-synctex \ NUMBER
+generate SyncTeX data for previewers according to bits of NUMBER.
+See the
.I synctex
manual page for details.
.TP
-.BI -translate-file \ tcxname
+.BI \-translate-file \ tcxname
Use the
.I tcxname
translation table to set the mapping of input characters and
re-mapping of output characters.
.TP
-.BI -default-translate-file \ tcxname
+.BI \-default-translate-file \ tcxname
Like
-.B -translate-file
+.B \-translate-file
except that a
.I %&
line can overrule this setting.
.TP
-.B -version
+.B \-version
Print version information and exit.
.TP
-.B -8bit
+.B \-8bit
make all characters printable by default.
.\"=====================================================================
.SH ENVIRONMENT
@@ -324,9 +326,8 @@ utility can be used to query the values
.PP
One caveat: In most pdf\*(TX formats, you cannot use ~ in a filename you
give directly to pdf\*(TX, because ~ is an active character in \*(TX,
-and hence is expanded, not taken as part of the filename. Other
-programs, such as \*(MF, do not have this problem.
-.PP
+and hence is expanded, not taken as part of the filename.
+Other programs, such as \*(MF, do not have this problem.
.TP
.B TEXMFOUTPUT
Normally, pdf\*(TX puts its output files in the current directory. If
@@ -414,7 +415,7 @@ Predigested pdf\*(TX format (.\|fmt) fil
This version of pdf\*(TX fails to trap arithmetic overflow when
dimensions are added or subtracted. Cases where this occurs are rare,
but when it does the generated
-DVI or PDF file will be invalid.
+DVI or PDF file will be invalid.
.\"=====================================================================
.SH AVAILABILITY
pdf\*(TX is available for a large variety of machine architectures
@@ -429,8 +430,8 @@ pdf\*(TX mailing list for all discussion
.\"=====================================================================
.SH "SEE ALSO"
This manual page is not meant to be exhaustive. The complete
-documentation for this version of pdf\*(TX can be found in the
-.IR "pdf\*(TX user manual"
+documentation for this version of pdf\*(TX can be found in the
+.I "pdf\*(TX user manual"
and the Texinfo manuals
.IR "Kpathsea library" ,
.IR "Web2C: A TeX implementation" .
@@ -450,7 +451,7 @@ Some related programs:
The primary authors of pdf\*(TX are Han The Thanh, Petr Sojka,
Jiri Zlatuska, and Peter Breitenlohner (e\*(TX).
.PP
-\*(TX was designed by Donald E. Knuth,
+\*(TX was designed by Donald E.\& Knuth,
who implemented it using his \*(WB system for Pascal programs.
It was ported to Unix at Stanford by Howard Trickey, and
at Cornell by Pavel Curtis.
Reply to: