From 2874806048fb0d2efb9a0e7383b4de30c3988c1c Mon Sep 17 00:00:00 2001 From: George Koehler Date: Tue, 13 Dec 2016 15:54:38 -0500 Subject: [PATCH] Tweak man syntax in aelflod.1 and aslod.1 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. --- util/amisc/aelflod.1 | 26 ++++++++++++++------------ util/amisc/aslod.1 | 10 +++++----- 2 files changed, 19 insertions(+), 17 deletions(-) diff --git a/util/amisc/aelflod.1 b/util/amisc/aelflod.1 index 24001ba2d..00cd62220 100644 --- a/util/amisc/aelflod.1 +++ b/util/amisc/aelflod.1 @@ -1,25 +1,27 @@ -.TH ASLOD 1 "$Revision$" +.TH AELFLOD 1 "$Revision$" .SH NAME aelflod \- ACK ELF loader .SH SYNOPSIS -aelflod [-h] [-v] inputfile outputfile +.B aelflod +[-h] [-v] inputfile outputfile .SH DESCRIPTION .I aelflod converts an absolute ack.out file into a simple binary memory -dump wrapped up in an ELF executable. It is suitable for producing -executables for operating systems such as Linux. - +dump wrapped up in an ELF executable. +It is suitable for producing executables for operating systems +such as Linux. +.PP The input file must contain exactly four segments: TEXT, ROM, DATA and BSS, in that order, all occupying contiguous memory. The file must have all references resolved and be linked to a -fixed address. The fixed address must be at least 0x54 bytes -greater than a page boundary, in order to make room for the ELF -header itself. - +fixed address. +The fixed address must be at least 0x54 bytes greater than a +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 order, ensuring that enough padding is inserted between each segment -to keep the offsets correct. The created executable will contain just -one rwx segment, and no sections. - +to keep the offsets correct. +The created executable will contain just one rwx segment, and no +sections. .SH "SEE ALSO" ack.out(5) diff --git a/util/amisc/aslod.1 b/util/amisc/aslod.1 index a786b13e6..f81590739 100644 --- a/util/amisc/aslod.1 +++ b/util/amisc/aslod.1 @@ -2,19 +2,19 @@ .SH NAME aslod \- ACK simple loader .SH SYNOPSIS -aslod [-h] [-v] inputfile outputfile +.B aslod +[-h] [-v] inputfile outputfile .SH DESCRIPTION .I aslod -converts an absolute ack.out file into a simple binary memory -dump. It is suitable for producing RAM images, executables for +converts an absolute ack.out file into a simple binary memory dump. +It is suitable for producing RAM images, executables for simple operating systems such as CP/M, DOS, etc. - +.PP The input file must contain exactly four segments: TEXT, ROM, DATA and BSS, in that order, all occupying contiguous memory. The file must have all references resolved and be linked to a fixed address. aslod will dump the segments, in order, such that the first byte of TEXT is at offset 0 in the file (regardless of where it is in memory). - .SH "SEE ALSO" ack.out(5)