ack/util/ack
George Koehler f91bc2804d Tune the installed manual pages.
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.
2017-01-18 23:02:30 -05:00
..
ack.1.X Tune the installed manual pages. 2017-01-18 23:02:30 -05:00
ack.h Let ack(1) compile files with non-ASCII names. 2016-11-15 11:33:35 -05:00
build.lua Don't build mktables.c in the ack binary. 2016-11-11 17:06:25 -05:00
data.c Header --> Id 1994-06-24 11:31:16 +00:00
data.h In util/ack, add prototypes and static to functions. 2016-11-12 21:12:45 -05:00
dmach.h Header --> Id 1994-06-24 11:31:16 +00:00
files.c In util/ack, add prototypes and static to functions. 2016-11-12 21:12:45 -05:00
grows.c In util/ack, add prototypes and static to functions. 2016-11-12 21:12:45 -05:00
grows.h In util/ack, add prototypes and static to functions. 2016-11-12 21:12:45 -05:00
list.c In util/ack, add prototypes and static to functions. 2016-11-12 21:12:45 -05:00
list.h In util/ack, add prototypes and static to functions. 2016-11-12 21:12:45 -05:00
main.c Don't print source file names during compilation (gcc stopped doing it years 2017-01-08 00:16:35 +01:00
mktables.c Add enough return types to the K&R C that the ACK builds (on Linux) using clang 2016-11-10 22:04:18 +01:00
rmach.c Let ack(1) compile files with non-ASCII names. 2016-11-15 11:33:35 -05:00
run.c Stop trying to remove core dumps. 2016-11-15 11:58:13 -05:00
scan.c In util/ack, add prototypes and static to functions. 2016-11-12 21:12:45 -05:00
svars.c Don't print a string after possibly freeing it. 2016-11-13 12:02:35 -05:00
trans.c Let ack(1) compile files with non-ASCII names. 2016-11-15 11:33:35 -05:00
trans.h In util/ack, add prototypes and static to functions. 2016-11-12 21:12:45 -05:00
util.c Let ack(1) compile files with non-ASCII names. 2016-11-15 11:33:35 -05:00