Bug#677013: RFS: time
Russ Allbery <rra@debian.org> writes:
> * The formatting of the man page isn't great. There are a few places that
> seem to have spurious line breaks (the --append documentation, for
> example), and it's traditional to have a blank line between each option
> documented in OPTIONS. The second problem at least can be fixed by just
> deleting the .PD 0 command (or at least moving it down to the formatting
> section, if it's still desireable for the resource specifiers.
Also, I realize this is a matter of taste, but personally I always use:
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
for all manual pages, for the entire file (not just for SYNOPSIS). Try
this patch and see what you think:
--- debian/time.1.orig 2012-06-17 21:45:39.000000000 -0700
+++ debian/time.1 2012-06-22 23:32:19.000000000 -0700
@@ -2,10 +2,12 @@
.\" Thanks to Herbert Thielen for a patch
.\" Copyright (C) Dirk Eddelbuettel but freely redistributable
.TH TIME 1 "Debian GNU/Linux"
+.\" Always turn off hyphenation; it makes way too many mistakes in
+.\" technical documents.
+.nh
.SH NAME
time \- run programs and summarize system resource usage
.SH SYNOPSIS
-.hy 0
.na
.TP
.B time
@@ -42,8 +44,9 @@
[
.I ARGS
]
-.hy 1
.ad b
+.\" For nroff, turn off justification.
+.if n .ad l
.SH DESCRIPTION
.B time
run the program
--
Russ Allbery (rra@debian.org) <http://www.eyrie.org/~eagle/>
Reply to: