f91bc2804d
This commit slightly improves the formatting of the manuals. My
OpenBSD machine uses mandoc(1) to format manuals. I check the manuals
with `mandoc -T lint` and fix most of the warnings. I also make
other changes where mandoc didn't warn me.
roff(7) says, "Each sentence should terminate at the end of an input
line," but we often forgot this rule. I insert some newlines after
sentences that had ended mid-line.
roff(7) also says that blank lines "are only permitted within literal
contexts." I delete blank lines. This removes some extra blank lines
from mandoc's output. If I do want a blank line in the output, I call
".sp 1" to make it in man(7). If I want a blank line in the source,
but not the output, I put a plain dot "." so roff ignores it.
Hyphens used for command-line options, like \-a, should be escaped by
a backslash. I insert a few missing backslashes.
mandoc warns if the date in .TH doesn't look like a date. Our manuals
had a missing date or the RCS keyword "$Revision$". Git doesn't
expand RCS keywords. I put in today's date, 2017-01-18.
Some manuals used tab characters in filled mode. That doesn't work.
I use .nf to turn off filled mode, or I use .IP in man(7) to make the
indentation without a tab character.
ack(1) defined a macro .SB but never used it, so I delete the
definition. I also remove a call to the missing macro .RF.
mandoc warns about empty paragraphs. I deleted them. mandoc also
warned about these macro pairs in anm(1):
.SM
.B text
The .SM did nothing because the .B text is on a different line. I
changed each pair to .SB for small bold text.
I make a few other small changes.
40 lines
1.2 KiB
Groff
40 lines
1.2 KiB
Groff
.TH EM_DECODE 6 2017-01-18
|
|
.ad
|
|
.SH NAME
|
|
em_decode, em_encode \- compact to readable EM and v.v.
|
|
.SH SYNOPSIS
|
|
.B ~em/lib.bin/em_decode
|
|
[ inputfile [ outputfile ] ]
|
|
.br
|
|
.B ~em/lib.bin/em_encode
|
|
[ inputfile [ outputfile ] ]
|
|
.SH DESCRIPTION
|
|
Most programs involved with the EM project only produce and accept
|
|
EM programs in compact form.
|
|
These files are only machine readable.
|
|
A description of this compact form can be found in [1].
|
|
To inspect the code produced by compilers or to patch them for one reason
|
|
or another, human readable assembly code is needed.
|
|
Em_decode produces human readable assembly code from the compact form.
|
|
.PP
|
|
Em_decode accepts the normal compact form in both optimized and
|
|
unoptimized form.
|
|
.PP
|
|
Em_encode produces the compact form
|
|
out of these human readable assembly code.
|
|
.PP
|
|
The first argument is the input file.
|
|
The second argument is the output file.
|
|
Both programs can act as a filter.
|
|
.SH "SEE ALSO"
|
|
.IP [1]
|
|
A.S.Tanenbaum, Ed Keizer, Hans van Staveren & J.W.Stevenson
|
|
"Description of a machine architecture for use of
|
|
block structured languages" Informatica rapport IR-81.
|
|
.IP [2]
|
|
ack(1)
|
|
.SH DIAGNOSTICS
|
|
Error messages are intended to be self-explanatory.
|
|
.SH AUTHOR
|
|
Ceriel Jacobs, Vrije Universiteit
|