Package: bin86
Version: 0.16.17-3.9
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
[test-][g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
["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?
<stdin>:2: Content of macro 'BY' is Bruce Evans
troff: backtrace: file '<stdin>':132
troff:<stdin>:132: warning: trailing space in the line
troff: backtrace: file '<stdin>':339
troff:<stdin>:339: warning: trailing space in the line
* 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.11.2-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 bin86 depends on:
ii libc6 2.40-3
bin86 recommends no packages.
bin86 suggests no packages.
-- no debconf information
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 outputs 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 bcc.1": (possibly shortened list)
mandoc: bcc.1:2:2: ERROR: skipping unknown macro: .BY Bruce Evans
mandoc: bcc.1:132:56: STYLE: whitespace at end of input line
mandoc: bcc.1:209:4: STYLE: whitespace at end of input line
mandoc: bcc.1:212:4: STYLE: whitespace at end of input line
mandoc: bcc.1:215:4: STYLE: whitespace at end of input line
mandoc: bcc.1:218:4: STYLE: whitespace at end of input line
mandoc: bcc.1:221:4: STYLE: whitespace at end of input line
mandoc: bcc.1:224:4: STYLE: whitespace at end of input line
mandoc: bcc.1:227:4: STYLE: whitespace at end of input line
mandoc: bcc.1:230:4: STYLE: whitespace at end of input line
mandoc: bcc.1:233:4: STYLE: whitespace at end of input line
mandoc: bcc.1:236:4: STYLE: whitespace at end of input line
mandoc: bcc.1:240:4: STYLE: whitespace at end of input line
mandoc: bcc.1:243:4: STYLE: whitespace at end of input line
mandoc: bcc.1:246:4: STYLE: whitespace at end of input line
mandoc: bcc.1:249:4: STYLE: whitespace at end of input line
mandoc: bcc.1:268:4: STYLE: whitespace at end of input line
mandoc: bcc.1:271:4: STYLE: whitespace at end of input line
mandoc: bcc.1:274:4: STYLE: whitespace at end of input line
mandoc: bcc.1:279:4: STYLE: whitespace at end of input line
mandoc: bcc.1:284:4: STYLE: whitespace at end of input line
mandoc: bcc.1:291:4: STYLE: whitespace at end of input line
mandoc: bcc.1:300:4: STYLE: whitespace at end of input line
mandoc: bcc.1:305:4: STYLE: whitespace at end of input line
mandoc: bcc.1:308:4: STYLE: whitespace at end of input line
mandoc: bcc.1:313:4: STYLE: whitespace at end of input line
mandoc: bcc.1:316:2: WARNING: skipping paragraph macro: PP empty
mandoc: bcc.1:324:2: WARNING: skipping paragraph macro: PP empty
mandoc: bcc.1:339:4: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
132:to optimize 8086 code. Specifiers to choose which rules
209:.TP
212:.TP
215:.TP
218:.TP
221:.TP
224:.TP
227:.TP
230:.TP
233:.TP
236:.TP
240:.TP
243:.TP
246:.TP
249:.TP
268:.TP
271:.TP
274:.TP
279:.TP
284:.TP
291:.TP
300:.TP
305:.TP
308:.TP
313:.TP
339:The
-.-.
Change - to \- if it shall be printed as a minus sign.
bcc.1:8:.RB [ -03EGNOPSVcegvwxW ]
bcc.1:47:.B -0
bcc.1:50:.B -3
bcc.1:127:with -3 the executable will run under Linux-i386.
bcc.1:210:.B -0
bcc.1:213:.B -3
-.-.
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, groff \[u2010] or \[hy]) in the output.
8:.RB [ -03EGNOPSVcegvwxW ]
9:.RB [ -Aas_option ]
10:.RB [ -Bexecutable_prefix ]
11:.RB [ -Ddefine ]
12:.RB [ -Uundef ]
13:.RB [ -Mc_mode ]
14:.RB [ -o\ outfile ]
15:.RB [ -ansi ]
16:.RB [ -Ccc1_option ]
17:.RB [ -Pcpp_option ]
18:.RB [ -Iinclude_dir ]
19:.RB [ -Lld_option ]
20:.RB [ -Ttmpdir ]
21:.RB [ -Qc386_option ]
22:.RB [ -ttext_segno ]
38:.B -ansi
47:.B -0
50:.B -3
53:.B -A
54:pass remainder of option to assembler (e.g. -A-l -Alistfile for a listing)
56:.B -B
59:.BR -B ,
65:.B -C
68:.B -D
71:.B -E
74:.B -G
75:produce GCC objects (Same as -Mg)
77:.B -Ixyz
80:.B -I
83:.B -Lxyz
86:.B -L
89:.B -Md
92:.B -i
95:.B -Mf
97:.B -c
99:.B -f
104:.B -Mc
106:.B -c
110:.B -Ms
114:.B -Ml
117:.B -z
120:.B -Mg
125:.B -N
127:with -3 the executable will run under Linux-i386.
129:.B -O
135:.B -O
138:.B -P
141:.B -Q
144:.B -S
147:.B -T
151:.B -U
154:.B -V
157:.B -X
158:pass remainder of option to linker (e.g. -X-Ofile is passed to the linker
159:as -Ofile)
161:.B -c
164:.B -f
168:.B -g
171:.B -o
174:.B -p
177:.B -t1
180:.B -v
181:print names and args of subprocesses being run. Two or more -v's print
182:names of files being unlinked. Three or more -v's print names of paths
185:.B -w
188:.B -W
193:.B -x
196:.B -i
198:.B -i
201:Other options are passed to the linker, in particular -lx, -M, -m, -s, -H.
207:.B -C
210:.B -0
213:.B -3
216:.B -D
219:.B -E
222:.B -I
225:.B -P
228:.B -c
231:.B -d
234:.B -f
237:.B -l
241:.B -o
244:.B -p
247:.B -t
250:.B -w
253:All the options except -D, -I and -o may be turned off by following the
254:option letter by a '-'. Options are processed left to right so the last
354:.B -r
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
54:pass remainder of option to assembler (e.g. -A-l -Alistfile for a listing)
158:pass remainder of option to linker (e.g. -X-Ofile is passed to the linker
-.-.
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.
28:compile time options allow 80386 or 6809 versions. The compiler understands
41:after preprocessing and before code generation. This will allow
54:pass remainder of option to assembler (e.g. -A-l -Alistfile for a listing)
100:arguments to the code generator for smaller faster code. Note this code is
107:argument to the code generator for smaller faster code. Note the standard
132:to optimize 8086 code. Specifiers to choose which rules
158:pass remainder of option to linker (e.g. -X-Ofile is passed to the linker
331:be moved there. The configuration for this is in the
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
348:as86(1), ld86(1), elksemu(1)
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(\-, minus) if it matches "[[:alph:]]-[[:alpha:]]" in the name of an
option).
Facilitates the copy and paste of
a) an option in UTF-8 text
b) web addresses (URL).
Is not needed in ordinary words like "mother-in-law", that are not
copied and pasted to a command line (which needs ASCII code)
54:pass remainder of option to assembler (e.g. -A-l -Alistfile for a listing)
158:pass remainder of option to linker (e.g. -X-Ofile is passed to the linker
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
<stdin>:2: Content of macro 'BY' is Bruce Evans
troff: backtrace: file '<stdin>':132
troff:<stdin>:132: warning: trailing space in the line
troff: backtrace: file '<stdin>':339
troff:<stdin>:339: warning: trailing space in the line
-.-
Spelling (from "codespell"):
Supress ==> Suppress
definitly ==> definitely
seach ==> search, each, reach, teach, beach
unfortunatly ==> unfortunately
-.-
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!
Table headers, that are wider than any data in the corresponding column,
do not need to be centered, so left adjustment is sufficient.
--- bcc.1 2024-10-21 14:26:07.376388141 +0000
+++ bcc.1.new 2024-10-21 14:58:40.172698437 +0000
@@ -1,3 +1,6 @@
+.de BY\" Guessed content
+Written by \\$*
+..
.TH bcc 1 "Nov, 1997"
.BY Bruce Evans
.nh
@@ -5,27 +8,28 @@
bcc \- Bruce's C compiler
.SH SYNOPSIS
.B bcc
-.RB [ -03EGNOPSVcegvwxW ]
-.RB [ -Aas_option ]
-.RB [ -Bexecutable_prefix ]
-.RB [ -Ddefine ]
-.RB [ -Uundef ]
-.RB [ -Mc_mode ]
-.RB [ -o\ outfile ]
-.RB [ -ansi ]
-.RB [ -Ccc1_option ]
-.RB [ -Pcpp_option ]
-.RB [ -Iinclude_dir ]
-.RB [ -Lld_option ]
-.RB [ -Ttmpdir ]
-.RB [ -Qc386_option ]
-.RB [ -ttext_segno ]
+.RB [ \-03EGNOPSVcegvwxW ]
+.RB [ \-Aas_option ]
+.RB [ \-Bexecutable_prefix ]
+.RB [ \-Ddefine ]
+.RB [ \-Uundef ]
+.RB [ \-Mc_mode ]
+.RB [ \-o\ outfile ]
+.RB [ \-ansi ]
+.RB [ \-Ccc1_option ]
+.RB [ \-Pcpp_option ]
+.RB [ \-Iinclude_dir ]
+.RB [ \-Lld_option ]
+.RB [ \-Ttmpdir ]
+.RB [ \-Qc386_option ]
+.RB [ \-ttext_segno ]
.RB [ ld_options ]
.RB [ infiles ]
.SH DESCRIPTION
.B Bcc
-is a simple C compiler that produces 8086 assembler, in addition compiler
-compile time options allow 80386 or 6809 versions. The compiler understands
+is a simple C compiler that produces 8086 assembler,
+in addition compiler compile time options allow 80386 or 6809 versions.
+The compiler understands
traditional K&R C with just the restriction that bit fields are mapped to
one of the other integer types.
@@ -35,223 +39,227 @@ from the source file.
.SH OPTIONS
.TP
-.B -ansi
+.B \-ansi
Pass the C source through
.B unprotoize
-after preprocessing and before code generation. This will allow
+after preprocessing and before code generation.
+This will allow
.I some
-ansi C to be compiled but it is definitly
+ansi C to be compiled but it is definitely
.B NOT
a true ansi-C compiler.
.TP
-.B -0
+.B \-0
8086 target (works on 80386 host, but not 6809)
.TP
-.B -3
+.B \-3
80386 target (may work on 8086 host, but not 6809)
.TP
-.B -A
-pass remainder of option to assembler (e.g. -A-l -Alistfile for a listing)
+.B \-A
+pass remainder of option to assembler
+(e.g., \-A\-l \-Alistfile for a listing)
.TP
-.B -B
+.B \-B
prefix for executable search path (as usual; the search order is all paths
specified using
-.BR -B ,
+.BR \-B ,
in order, then the path given in the environment variable
.B BCC_EXEC_PREFIX
if that is set, then the compiled-in defaults
(something like /usr/lib/bcc/ followed by /usr/bin/)
.TP
-.B -C
+.B \-C
pass remainder of option to bcc-cc1, see code generation options.
.TP
-.B -D
+.B \-D
preprocessor define
.TP
-.B -E
+.B \-E
produce preprocessor output to standard out.
.TP
-.B -G
-produce GCC objects (Same as -Mg)
+.B \-G
+produce GCC objects (Same as \-Mg)
.TP
-.B -Ixyz
+.B \-Ixyz
include search 'xyz' path
.TP
-.B -I
+.B \-I
don't add default include to search list
.TP
-.B -Lxyz
+.B \-Lxyz
add directory name 'xyz' to the head of the list of library directories
searched
.TP
-.B -L
+.B \-L
don't add default library to search list
.TP
-.B -Md
+.B \-Md
alters the arguments for all passes to produce MSDOS executable COM files.
These are small model executables, use
-.B -i
+.B \-i
to get tiny model.
.TP
-.B -Mf
+.B \-Mf
sets bcc to pass the
-.B -c
+.B \-c
and
-.B -f
-arguments to the code generator for smaller faster code. Note this code is
-not compatible with the standard calling conventions so a different version
-of the C library is linked too.
+.B \-f
+arguments to the code generator for smaller faster code.
+Note this code is not compatible with the standard calling conventions
+so a different version of the C library is linked too.
.TP
-.B -Mc
+.B \-Mc
sets bcc to pass the
-.B -c
-argument to the code generator for smaller faster code. Note the standard
-libc is normally transparent to this, but there are exceptions.
+.B \-c
+argument to the code generator for smaller faster code.
+Note the standard libc is normally transparent to this,
+but there are exceptions.
.TP
-.B -Ms
+.B \-Ms
alters the arguments for all passes and selects C-library
to produce standalone Linux-86 executables
.TP
-.B -Ml
+.B \-Ml
switches to i386-Linux code generator and library.
This configuration accepts the
-.B -z
+.B \-z
flag to generate QMAGIC a.out files instead of the normal OMAGIC.
.TP
-.B -Mg
+.B \-Mg
switches to i386-Linux code generator and generates OMAGIC object files
-that can be linked with some versions of gcc; unfortunatly the most recent
+that can be linked with some versions of gcc; unfortunately the most recent
versions use 'collect2' to link and this crashes.
.TP
-.B -N
+.B \-N
makes the linker produce a native a.out file (Linux OMAGIC) if combined
-with -3 the executable will run under Linux-i386.
+with \-3 the executable will run under Linux-i386.
.TP
-.B -O
+.B \-O
optimize, call
.BR copt ( 1 )
-to optimize 8086 code. Specifiers to choose which rules
+to optimize 8086 code.
+Specifiers to choose which rules
.B copt
should use can be appended to the
-.B -O
+.B \-O
and the option can be repeated.
.TP
-.B -P
+.B \-P
produce preprocessor output with no line numbers to standard output.
.TP
-.B -Q
+.B \-Q
pass full option to c386 (Only for c386 version)
.TP
-.B -S
+.B \-S
produce assembler file
.TP
-.B -T
+.B \-T
temporary directory (overrides previous value and default; default is
from the environment variable TMPDIR if that is set, otherwise /tmp)
.TP
-.B -U
+.B \-U
preprocessor undefine
.TP
-.B -V
+.B \-V
print names of files being compiled
.TP
-.B -X
-pass remainder of option to linker (e.g. -X-Ofile is passed to the linker
-as -Ofile)
+.B \-X
+pass remainder of option to linker
+(e.g., \-X\-Ofile is passed to the linker as \-Ofile)
.TP
-.B -c
+.B \-c
produce object file
.TP
-.B -f
+.B \-f
turn on floating point support, no effect with i386, changes libc library
with 8086 code.
.TP
-.B -g
+.B \-g
produce debugging info (ignored.)
.TP
-.B -o
+.B \-o
output file name follows (assembler, object or executable) (as usual)
.TP
-.B -p
+.B \-p
produce profiling info (ignored.)
.TP
-.B -t1
+.B \-t1
pass to the assembler to renumber the text segment for multi-segment programs.
.TP
-.B -v
-print names and args of subprocesses being run. Two or more -v's print
-names of files being unlinked. Three or more -v's print names of paths
+.B \-v
+print names and args of subprocesses being run. Two or more \-v's print
+names of files being unlinked. Three or more \-v's print names of paths
being searched.
.TP
-.B -w
-Supress any warning diagnostics.
+.B \-w
+Suppress any warning diagnostics.
.TP
-.B -W
+.B \-W
Turn
.B on
assembler warning messages.
.TP
-.B -x
+.B \-x
don't include crt0.o in the link.
.TP
-.B -i
+.B \-i
don't pass
-.B -i
+.B \-i
to the linker so that it will create an impure executable.
.P
-Other options are passed to the linker, in particular -lx, -M, -m, -s, -H.
+Other options are passed to the linker, in particular \-lx, \-M, \-m, \-s, \-H.
.SH CODE GENERATOR OPTIONS
These are all options that the code generator pass
.B bcc-cc1
understands, only some will be useful for the
-.B -C
+.B \-C
option of bcc.
-.TP
-.B -0
+.TP
+.B \-0
8086 target (works even on 80386 host, not on 6809)
-.TP
-.B -3
+.TP
+.B \-3
80386 target (may work even on 8086 host, not on 6809)
-.TP
-.B -D
+.TP
+.B \-D
define (as usual)
-.TP
-.B -E
+.TP
+.B \-E
produce preprocessor output (as usual)
-.TP
-.B -I
+.TP
+.B \-I
include search path (as usual)
-.TP
-.B -P
+.TP
+.B \-P
produce preprocessor output with no line numbers (as usual)
-.TP
-.B -c
+.TP
+.B \-c
produce code with caller saving regs before function calls
-.TP
-.B -d
+.TP
+.B \-d
print debugging information in assembly output
-.TP
-.B -f
+.TP
+.B \-f
produce code with 1st argument passed in a register (AX, EAX or X)
-.TP
-.B -l
+.TP
+.B \-l
produce code for 2 3 1 0 long byte order (only works in 16-bit code),
a special library of compiler helper functions is needed for this mode.
-.TP
-.B -o
+.TP
+.B \-o
assembler output file name follows
-.TP
-.B -p
+.TP
+.B \-p
produce (almost) position-independent code (only for the 6809)
-.TP
-.B -t
+.TP
+.B \-t
print source code in assembly output
-.TP
-.B -w
+.TP
+.B \-w
print what cc1 thinks is the location counter in assembly output
.P
-All the options except -D, -I and -o may be turned off by following the
-option letter by a '-'. Options are processed left to right so the last
+All the options except \-D, \-I and \-o may be turned off by following the
+option letter by a '\-'. Options are processed left to right so the last
setting has precedence.
.SH PREPROCESSOR DEFINES
@@ -265,30 +273,30 @@ stringized name of current input file
.TP
.B __LINE__
current line number
-.TP
+.TP
.B __MSDOS__ 1
compiler is configured for generating MSDOS executable COM files.
-.TP
+.TP
.B __STANDALONE__ 1
compiler is configured for generating standalone executables.
-.TP
+.TP
.B __AS386_16__ 1
compiler is generating 16 bit 8086 assembler and the
.B #asm
keyword is available for including 8086 code.
-.TP
+.TP
.B __AS386_32__ 1
compiler is generating 32 bit 80386 assembler and the
.B #asm
keyword is available for including 80386 code.
-.TP
+.TP
.B __CALLER_SAVES__ 1
compiler calling conventions are altered so the calling function must save the
.I SI
and
.I DI
registers if they are in use (ESI and EDI on the 80386)
-.TP
+.TP
.B __FIRST_ARG_IN_AX__ 1
compiler calling conventions are altered so the calling function is passing
the first argument to the function in the
@@ -297,38 +305,37 @@ the first argument to the function in th
.I EAX
)
register.
-.TP
+.TP
.B __LONG_BIG_ENDIAN__ 1
alters the word order of code generated by the 8086 compiler.
.P
These defines only occur in the 6809 version of the compiler.
-.TP
+.TP
.B __AS09__ 1
compiler is generating 6809 code
-.TP
+.TP
.B __FIRST_ARG_IN_X__ 1
the first argument to functions is passed in the
.I X
register.
-.TP
+.TP
.B __POS_INDEPENDENT__ 1
the code generated is (almost) position independent.
-.P
.SH ENVIRONMENT
.TP
.B BCC_EXEC_PREFIX
-default directory to seach for compiler passes
+default directory to search for compiler passes
.TP
.B TMPDIR
directory to place temporary files (default /tmp)
-.P
.SH DIRECTORIES
All the include, library and compiler components are stored under the
.I /usr/lib/bcc
directory under Linux-i386, this is laid out the same as a
.I /usr
filesystem and if bcc is to be the primary compiler on a system it should
-be moved there. The configuration for this is in the
+be moved there.
+The configuration for this is in the
.B bcc.c
source file only, all other executables are independent of location.
@@ -336,20 +343,19 @@ The library installation also creates th
.BR /usr/lib/liberror.txt ,
this path is hardcoded into the C library.
-The
+The
.B bcc
executable itself,
.B as86
and
.B ld86
are in /usr/bin.
-
.SH SEE ALSO
-as86(1), ld86(1), elksemu(1)
+.BR as86 "(1), " ld86 "(1), " elksemu (1)
.SH BUGS
The bcc.c compiler driver source is very untidy.
The linker, ld86, produces a broken a.out object file if given one input and
the
-.B -r
+.B \-r
option this is so it is compatible with pre-dev86 versions.
