rdoff: add man pages from the Debian project.

Add man pages for some of the rdoff programs, from the Debian project.
This commit is contained in:
H. Peter Anvin 2007-12-18 16:12:13 -08:00
parent bebf220ba9
commit c79262a61e
7 changed files with 160 additions and 0 deletions

View file

@ -86,6 +86,7 @@ spotless: clean
distclean: spotless
install: all
$(MKDIR) -p $(INSTALLROOT)$(bindir)
$(INSTALL_PROGRAM) rdfdump$(X) $(INSTALLROOT)$(bindir)/rdfdump$(X)
$(INSTALL_PROGRAM) ldrdf$(X) $(INSTALLROOT)$(bindir)/ldrdf$(X)
$(INSTALL_PROGRAM) rdx$(X) $(INSTALLROOT)$(bindir)/rdx$(X)
@ -93,3 +94,5 @@ install: all
$(INSTALL_PROGRAM) rdf2bin$(X) $(INSTALLROOT)$(bindir)/rdf2bin$(X)
$(INSTALL_PROGRAM) rdf2ihx$(X) $(INSTALLROOT)$(bindir)/rdf2ihx$(X)
cd $(INSTALLROOT)$(bindir) && rm -f rdf2com$(X) && $(LN_S) rdf2bin$(X) rdf2com$(X)
$(MKDIR) -p $(INSTALLROOT)$(mandir)/man1
$(INSTALL_DATA) $(srcdir)/*.1 $(INSTALLROOT)$(mandir)/man1/

41
rdoff/ldrdf.1 Normal file
View file

@ -0,0 +1,41 @@
.TH LDRDF 1 "September 6, 1999" "Debian Project" "Debian Manual"
.SH NAME
ldrdf \- link RDOFF objects and libraries produced by rdflib(1)
.SH SYNOPSIS
.B ldrdf
.RI "[-o " output-file ]
.I object-file\c
.RI "... [-l" library "...]"
.SH DESCRIPTION
.B ldrdf
is a version of unix
.BR ld (1)
(or DOS LINK) for use with RDOFF files. It is capable of linking RDOFF
objects, and libraries produced with the
.BR rdflib (1)
utility.
.PP
Libraries must be specified with their path as no search is performed.
Modules in libraries are not linked to the program unless they are
referred to.
.SH OPTIONS
.TP
.RI "-o " output-file
Specify an output file. The default output filename is
.RI ' aout.rdx '.
.TP
-v
Increase verbosity level. Currently 4 verbosity levels are available:
default (which only prints error information), normal (which prints
information about the produced object, -v), medium (which prints information
about what the program is doing, -v -v) and high (which prints all available
information, -v -v -v).
.TP
-p
Change alignment value to which multiple segments combigned into a single
segment should be aligned (must be either 1, 2, 4, 8, 16, 32 or 256; default
is 16).
.SH AUTHORS
Julian Hall <jules@earthcorp.com>.
.PP
This manual page was written by Matej Vela <vela@debian.org>.

31
rdoff/rdf2bin.1 Normal file
View file

@ -0,0 +1,31 @@
.TH RDF2BIN 1 "September 6, 1999" "Debian Project" "Debian Manual"
.SH NAME
rdf2bin, rdf2com \- convert an RDOFF object file to flat binary
.SH SYNOPSIS
.B rdf2bin
.RI "[-o " relocation-origin ]
.RI "[-p " segment-alignment ]
.I input-file
.I output-file
.br
.B rdf2com
.RI "[-p " segment-alignment ]
.I input-file
.I output-file
.SH OPTIONS
.TP
.RI "-o " relocation-origin
Relocate at origin
.IR relocation-origin .
If invoked as
.BR rdf2com ,
the default relocation origin will be 0x100. Else, the default origin is 0.
.TP
.RI "-p " segment-alignment
Pad segments until their size is a multiple of
.IR segment-alignment .
By default, 16 is used.
.SH AUTHORS
Julian Hall <jules@earthcorp.com>.
.PP
This manual page was written by Matej Vela <vela@debian.org>.

1
rdoff/rdf2com.1 Normal file
View file

@ -0,0 +1 @@
.so man1/rdf2bin.1

24
rdoff/rdfdump.1 Normal file
View file

@ -0,0 +1,24 @@
.TH RDFDUMP 1 "September 6, 1999" "Debian Project" "Debian Manual"
.SH NAME
rdfdump \- dumps an RDOFF object in human-readable form
.SH SYNOPSIS
.B rdfdump
[-v]
.RI < filename >
.SH DESCRIPTION
.B rdfdump
prints a list of the header records in an RDOFF object in human-readable
form, and optionally prints a hex dump of the contents of the segments.
.PP
.B rdfdump
supports both version 1 and 2 of RDOFF. It will give warnings if the RDOFF2
format is violated (it looks for incorrect lengths for header records, and
checks the overall length count at the start of the file).
.SH OPTIONS
.TP
-v
Print a hex dump of the contents of the segments.
.SH AUTHORS
Julian Hall <jules@earthcorp.com>.
.PP
This manual page was written by Matej Vela <vela@debian.org>.

39
rdoff/rdflib.1 Normal file
View file

@ -0,0 +1,39 @@
.TH RDFLIB 1 "September 6, 1999" "Debian Project" "Debian Manual"
.SH NAME
rdflib \- manage a library file for use with ldrdf(1)
.SH SYNOPSIS
.B rdflib
.I command
.I arguments
.SH DESCRIPTION
.B rdflib
manages a library file which can be used by
.BR ldrdf (1).
It is supplied with a shell script
.B makelib
which should probably be used to create libraries.
.SH COMMANDS
.TP
.BI c " library-file"
Create (or truncate) a library.
.TP
.BI a " library-file object-file module"
Add the
.I object-file
to the library under the name
.IR module .
.TP
.BI x " library-file module object-file"
Extract a
.I module
from the library to the file
.IR object-file .
.TP
.B t " library-file"
Display a list of modules in the library.
.SH NOTES
A remove command will be added soon.
.SH AUTHORS
Julian Hall <jules@earthcorp.com>.
.PP
This manual page was written by Matej Vela <vela@debian.org>.

21
rdoff/rdx.1 Normal file
View file

@ -0,0 +1,21 @@
.TH RDX 1 "September 6, 1999" "Debian Project" "Debian Manual"
.SH NAME
rdx \- load and execute an RDOFF object
.SH SYNOPSIS
.B rdx
.I object
.SH DESCRIPTION
.B rdx
loads an RDOFF
.IR object ,
and then calls
.RB ` _main ',
which it expects to be a C-style function, accepting two parameters,
.I argc
and
.I argv
in normal C style.
.SH AUTHORS
Julian Hall <jules@earthcorp.com>.
.PP
This manual page was written by Matej Vela <vela@debian.org>.