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.
90 lines
1.8 KiB
Groff
90 lines
1.8 KiB
Groff
.TH AAL 1 2017-01-18
|
|
.ad
|
|
.SH NAME
|
|
aal \- archive and library maintainer
|
|
.SH SYNOPSIS
|
|
.B aal
|
|
key afile name ...
|
|
.SH DESCRIPTION
|
|
.I Aal
|
|
maintains groups of ACK-object files
|
|
combined into a single archive file.
|
|
An index-table is automatically maintained.
|
|
The link editor
|
|
.IR led (6)
|
|
only understands archives made with
|
|
.IR aal .
|
|
.PP
|
|
.I Key
|
|
is one character from the set
|
|
.BR qdrtx ,
|
|
optionally concatenated with
|
|
one or more of
|
|
.BR vlc .
|
|
.I Afile
|
|
is the archive file.
|
|
The
|
|
.I names
|
|
are constituent files in the archive file.
|
|
The meanings of the
|
|
.I key
|
|
characters are:
|
|
.TP
|
|
.B d
|
|
Delete the named files from the archive file.
|
|
.TP
|
|
.B q
|
|
Append the named files to the archive file.
|
|
.TP
|
|
.B r
|
|
Replace the named files in the archive file.
|
|
New files are placed at the end.
|
|
.TP
|
|
.B t
|
|
Print a table of contents of the archive file.
|
|
If no names are given, all files in the archive are listed.
|
|
If names are given, only those files are listed.
|
|
.TP
|
|
.B x
|
|
Extract the named files.
|
|
If no names are given, all files in the archive are
|
|
extracted.
|
|
In neither case does
|
|
.B x
|
|
alter the archive file.
|
|
.TP
|
|
.B v
|
|
Verbose.
|
|
Under the verbose option,
|
|
.I aal
|
|
gives a file-by-file
|
|
description of the making of a
|
|
new archive file from the old archive and the constituent files.
|
|
When used with
|
|
.B t,
|
|
it gives a long listing of all information about the files.
|
|
.TP
|
|
.B l
|
|
Local.
|
|
Normally
|
|
.I aal
|
|
places its temporary files in the directory /tmp.
|
|
This option causes them to be placed in the local directory.
|
|
.TP
|
|
.B c
|
|
Create. Normally
|
|
.I aal
|
|
will create
|
|
.I afile
|
|
when it needs to.
|
|
The create option supresses the normal message that is produced when
|
|
.I afile
|
|
is created.
|
|
.SH FILES
|
|
.IP /tmp/ar.* 16
|
|
temporaries
|
|
.SH "SEE ALSO"
|
|
led(6), arch(5)
|
|
.SH BUGS
|
|
If the same file is mentioned twice in an argument list,
|
|
it may be put in the archive twice.
|