Bug#1039975: bibtex.original.1: some remarks and editorial fixes for the manual
Package: texlive-binaries
Version: 2022.20220321.62855-5.1
Severity: minor
Tags: patch
Dear Maintainer,
here are a few notes and fixes for the man page.
-.-.
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
"groff -man -Z" instead of "nroff -man"
-.-.
Output from "mandoc -T lint bibtex.original.1":
mandoc: bibtex.original.1:67:26: STYLE: whitespace at end of input line
mandoc: bibtex.original.1:71:9: STYLE: whitespace at end of input line
mandoc: bibtex.original.1:85:2: WARNING: skipping paragraph macro: PP empty
-.-.
Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).
43:files specified by the \\bibliography command,
44:the entries specified by the \\cite and \\nocite commands
49:file (specified by the \\bibliographystyle command,
-.-.
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.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
58:files. The `\*(BXing' document describes extensions and details of
91:files. If BSTINPUTS is not set, it uses the system default.
-.-.
Output from "test-nroff -man -b -ww -z -rCHECKSTYLE=3":
[ "test-groff" is a developmental version of "groff" ]
Input file is ./bibtex.original.1
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -rSTYLECHECK=3":
troff: backtrace: file '<stdin>':67
troff:<stdin>:67: warning: trailing space in the line
Bad use of \s0 in a string definition, the string could be resized.
8:.if t .ds BX \fRB\s-2IB\s0\fP\*(TX
11:.if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\\s-2A\\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
-.-.
--- bibtex.original.1 2023-06-30 03:12:16.000000000 +0000
+++ bibtex.original.1.new 2023-06-30 03:20:30.000000000 +0000
@@ -5,10 +5,10 @@
.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
.\"=====================================================================
.SH NAME
@@ -40,13 +40,13 @@ file that will be incorporated into the
.PP
\*(BX looks up, in bibliographic database
.RB ( .bib )
-files specified by the \\bibliography command,
-the entries specified by the \\cite and \\nocite commands
+files specified by the \ebibliography command,
+the entries specified by the \ecite and \enocite commands
in the \*(LX or \*(TX source file.
It formats the information from those entries
according to instructions in a bibliography style
.RB ( .bst )
-file (specified by the \\bibliographystyle command,
+file (specified by the \ebibliographystyle command,
and it outputs the results to the
.B .bbl
file.
@@ -55,7 +55,8 @@ The \*(LX manual
explains what a \*(LX source file must contain to work with \*(BX.
Appendix B of the manual describes the format of the
.B .bib
-files. The `\*(BXing' document describes extensions and details of
+files.
+The `\*(BXing' document describes extensions and details of
this format, and it gives other useful hints for using \*(BX.
.\"=====================================================================
.SH OPTIONS
@@ -64,11 +65,11 @@ The
option defines the minimum number of
.B crossref
required for automatic inclusion of the crossref base entry in the citation
-list; the default is two.
+list; the default is two.
To avoid these automatic inclusions altogether, give this option
a sufficiently large number, and be sure to remove any
previous
-.B .aux
+.B .aux
and
.B .bbl
files. Otherwise the option may
@@ -82,13 +83,14 @@ With the
option, \*(BX operates silently. Without it, a banner and progress
reports are printed on
.IR stdout .
-.PP
+.
.\"=====================================================================
.SH ENVIRONMENT
\*(BX searches the directories in the
path defined by the BSTINPUTS environment variable for
.B .bst
-files. If BSTINPUTS is not set, it uses the system default.
+files.
+If BSTINPUTS is not set, it uses the system default.
For
.B .bib
files, it uses the BIBINPUTS environment variable if that is set,
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.3.7-1 (SMP w/2 CPU threads; PREEMPT)
Kernel taint flags: TAINT_WARN
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.36-9
ii libcairo2 1.16.0-7
ii libfontconfig1 2.14.1-4
ii libfreetype6 2.12.1+dfsg-5
ii libgcc-s1 13.1.0-6
ii libgraphite2-3 1.3.14-1
ii libharfbuzz0b 6.0.0+dfsg-3
ii libicu72 72.1-3
ii libkpathsea6 2022.20220321.62855-5.1
ii libmpfr6 4.2.0-1
ii libpaper1 1.1.29
ii libpixman-1-0 0.42.2-1
ii libpng16-16 1.6.39-2
ii libptexenc1 2022.20220321.62855-5.1
ii libstdc++6 13.1.0-6
ii libsynctex2 2022.20220321.62855-5.1
ii libteckit0 2.5.11+ds1-1+b1
ii libtexlua53-5 2022.20220321.62855-5.1
ii libtexluajit2 2022.20220321.62855-5.1
ii libx11-6 2:1.8.6-1
ii libxaw7 2:1.0.14-1
ii libxi6 2:1.8-1+b1
ii libxmu6 2:1.1.3-3
ii libxpm4 1:3.5.12-1.1
ii libxt6 1:1.2.1-1.1
ii libzzip-0-13 0.13.72+dfsg.1-1.1
ii perl 5.36.0-7
ii t1utils 1.41-4
ii tex-common 6.18
ii zlib1g 1:1.2.13.dfsg-1
Versions of packages texlive-binaries recommends:
pn dvisvgm <none>
ii texlive-base 2022.20230122-3
texlive-binaries suggests no packages.
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 2022.20230122-3
-- no debconf information
Reply to: