d0p1/ack
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Tweak man syntax in aelflod.1 and aslod.1

Browse source 
Put end of sentence at end of line.  This is roff(7) syntax so the
formatter can make spacing between sentences.

Use the macro .PP to break paragraphs.  Use bold for the command name
in SYNOPSIS, to match other ack manuals.
This commit is contained in:
George Koehler 2016-12-13 15:54:38 -05:00
parent bf2e0be69a
commit 2874806048
2 changed files with 19 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
util/amisc/aelflod.1
View file

@ -1,25 +1,27 @@
.TH ASLOD 1 "$Revision$" .TH AELFLOD 1 "$Revision$"
.SH NAME .SH NAME
aelflod \- ACK ELF loader aelflod \- ACK ELF loader
.SH SYNOPSIS .SH SYNOPSIS
aelflod [-h] [-v] inputfile outputfile .B aelflod
[-h] [-v] inputfile outputfile
.SH DESCRIPTION .SH DESCRIPTION
.I aelflod .I aelflod
converts an absolute ack.out file into a simple binary memory converts an absolute ack.out file into a simple binary memory
dump wrapped up in an ELF executable. It is suitable for producing dump wrapped up in an ELF executable.
executables for operating systems such as Linux. It is suitable for producing executables for operating systems
such as Linux.
.PP
The input file must contain exactly four segments: TEXT, ROM, The input file must contain exactly four segments: TEXT, ROM,
DATA and BSS, in that order, all occupying contiguous memory. DATA and BSS, in that order, all occupying contiguous memory.
The file must have all references resolved and be linked to a The file must have all references resolved and be linked to a
fixed address. The fixed address must be at least 0x54 bytes fixed address.
greater than a page boundary, in order to make room for the ELF The fixed address must be at least 0x54 bytes greater than a
header itself. page boundary, in order to make room for the ELF header itself.
.PP
aelflod will write out an ELF header followed by each segment, in aelflod will write out an ELF header followed by each segment, in
order, ensuring that enough padding is inserted between each segment order, ensuring that enough padding is inserted between each segment
to keep the offsets correct. The created executable will contain just to keep the offsets correct.
one rwx segment, and no sections. The created executable will contain just one rwx segment, and no
sections.
.SH "SEE ALSO" .SH "SEE ALSO"
ack.out(5) ack.out(5)

10
util/amisc/aslod.1
View file

@ -2,19 +2,19 @@
.SH NAME .SH NAME
aslod \- ACK simple loader aslod \- ACK simple loader
.SH SYNOPSIS .SH SYNOPSIS
aslod [-h] [-v] inputfile outputfile .B aslod
[-h] [-v] inputfile outputfile
.SH DESCRIPTION .SH DESCRIPTION
.I aslod .I aslod
converts an absolute ack.out file into a simple binary memory converts an absolute ack.out file into a simple binary memory dump.
dump. It is suitable for producing RAM images, executables for It is suitable for producing RAM images, executables for
simple operating systems such as CP/M, DOS, etc. simple operating systems such as CP/M, DOS, etc.
.PP
The input file must contain exactly four segments: TEXT, ROM, The input file must contain exactly four segments: TEXT, ROM,
DATA and BSS, in that order, all occupying contiguous memory. DATA and BSS, in that order, all occupying contiguous memory.
The file must have all references resolved and be linked to a The file must have all references resolved and be linked to a
fixed address. aslod will dump the segments, in order, such fixed address. aslod will dump the segments, in order, such
that the first byte of TEXT is at offset 0 in the file that the first byte of TEXT is at offset 0 in the file
(regardless of where it is in memory). (regardless of where it is in memory).
.SH "SEE ALSO" .SH "SEE ALSO"
ack.out(5) ack.out(5)