Skip site navigation (1)Skip section navigation (2)
Date:      12 Dec 2001 12:21:21 -0800
From:      swear@blarg.net (Gary W. Swearingen)
To:        Ruslan Ermilov <ru@FreeBSD.ORG>
Cc:        freebsd-doc@FreeBSD.ORG
Subject:   Re: docs/32676: file(1) formatting nit
Message-ID:  <rs7krsdwam.krs@localhost.localdomain>
In-Reply-To: <200112120810.fBC8A2S55924@freefall.freebsd.org>
References:  <200112120810.fBC8A2S55924@freefall.freebsd.org>

next in thread | previous in thread | raw e-mail | index | archive | help
>  > 
>  Starting lines with a space is bogus, and causes groff(1)
>  to stop formatting the current line.  There's nothing wrong
>  with some text running of a right margin; manpages display
>  "literal" text exactly as it is shown by a program, and the
>  output of man(1) could be controlled by a pager utility
>  like more(1) or less(1).

There IS something wrong: pager utilities can't know where the
left margin is (without some AI code) with resulting ugly and
hard-to-read line wrapping and occasional trunctation of text
(as I observe in XEmacs's man file(1) with a 80-column X window).

Man pages should have a convention to represent the end(s) of
wrapped literal lines.  Something like "[\]" or "[NL]" or "[wrap]" at
the end or "[+]" or "[cont]" at the beginning.  I've always preferred
the beginning (ala FORTRAN), but on Unix the end is more common.

But there's not enough literal stuff in man pages to spend much time
worrying about it.

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?rs7krsdwam.krs>