Bug#1039978: axohelp.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 some notes and a patch for the manual.
-.-.
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 axohelp.1":
mandoc: axohelp.1:4:10: STYLE: whitespace at end of input line
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
31:.B -h, --help
35:.B -v, --version
-.-.
Increase type size of ~ (tilde) to make it more visible
in the output of "troff".
48:<https://www.nikhef.nl/~form/maindir/others/axodraw2/axodraw2.html>.
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
31:.B -h, --help
35:.B -v, --version
39:.B -V
-.-.
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.
22:and the output file is file.ax2. If the filename on the command line
27:Options can be introduced by single or double hyphen characters. The
-.-.
Use \(en for a dash (en-dash) between space characters, not a minus
(\-) or a hyphen (-), except in the NAME section.
axohelp.1:3:axohelp - helper program for use of LaTeX package axodraw2 with
-.-.
--- axohelp.1 2023-06-29 23:48:04.000000000 +0000
+++ axohelp.1.new 2023-06-29 23:56:06.000000000 +0000
@@ -1,7 +1,7 @@
.TH "axohelp" 1 "5 Mar 2021" ""
.SH NAME
-axohelp - helper program for use of LaTeX package axodraw2 with
-pdflatex.
+axohelp \- helper program for use of LaTeX package axodraw2 with
+pdflatex.
.SH SYNOPSIS
.B axohelp [options] [filename]
.SH DESCRIPTION
@@ -19,24 +19,25 @@ draw the desired graphics.
The files processed are specified as follows: When the filename on the
command line is of the form file.ax1, then the input file is file.ax1
-and the output file is file.ax2. If the filename on the command line
-does not have extension .ax1, then this extension is appended.
+and the output file is file.ax2.
+If the filename on the command line does not have extension .ax1,
+then this extension is appended.
.SH OPTIONS
-Options can be introduced by single or double hyphen characters. The
-possible options are:
+Options can be introduced by single or double hyphen characters.
+The possible options are:
.TP
-.B -h, --help
+.B \-h, \-\-help
Gives usage information
.TP
-.B -v, --version
+.B \-v, \-\-version
Gives version information
.TP
-.B -V
+.B \-V
NOT CURRENTLY IMPLEMENTED: Give information on each function used.
.SH AUTHOR
@@ -45,4 +46,4 @@ Jos Vermaseren (username t68 at nikhef d
The released version can be obtained from CTAN:
<http://www.ctan.org/pkg/axodraw2/>, and an author's website
-<https://www.nikhef.nl/~form/maindir/others/axodraw2/axodraw2.html>.
+<https://www.nikhef.nl/\s+3~\s-3form/maindir/others/axodraw2/axodraw2.html>.
-- 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: