[1753] in Kerberos_V5_Development
Re: manpage formatting
daemon@ATHENA.MIT.EDU (Jeff Bigler)
Tue Sep 10 12:00:52 1996
Date: Tue, 10 Sep 1996 12:01:08 -0400
To: tlyu@MIT.EDU
Cc: krbcore@MIT.EDU
In-Reply-To: <9609100319.AA26415@tesla-coil.MIT.EDU> (message from Tom Yu on
Mon, 9 Sep 1996 23:19:57 -0400)
Reply-To: jcb@MIT.EDU
From: Jeff Bigler <jcb@MIT.EDU>
> Date: Mon, 9 Sep 1996 23:19:57 -0400
> From: Tom Yu <tlyu@MIT.EDU>
>
> It appears that in many manpages, we're using
>
> .so man1/header.doc
>
> in a bunch of manpages. I'm not convinced that this will work even if
> header.doc is installed. Even man2ps flames about the lack of
> header.doc. It seems the reason this is here is so that we can set
> the header info in the ".TH" man macro as necessary. Nevertheless,
> from a quick survey (OSF/1, Ultrix, and Solaris), only the first two
> arguments to the ".TH" macro are really guaranteed to be consistent
> between operating systems. Might we want to only use the first two
> arguments to ".TH" and punt the others, thus eliminating the problem
> with using header.doc?
Certainly punting them is the easiest solution. My reason for adding
header.doc was to create an abstraction. Previously the .TH lines all
said something like:
.TH KGIMMETICKETS 1 "Kerberos V5" "MIT Project Athena"
Cygnus didn't want all of our manpages to say "MIT Project Athena" on
them, and if we have any customers who will be embedding Kerberos in
their own products, they won't want all of the manpages to say "Cygnus"
either. I used the include file "header.doc" to define the variable "h"
to be whichever header string is appropriate to the installation, so the
installer only has to change one file.
Incidentally, the reason man2ps complains is because there isn't a
"man1" directory containing "header.doc" under the "doc" directory.
This would be easy to fix.
> Also, [minor nit] do we want to upcase all the names given on the
> ".TH" line? I'm of the opinion that they should be not be forced
> uppercase, but that's just me.
That's been the convention, but we don't necessarily need to adhere to
it.
Jeff
