Date: Tue, 7 Aug 2001 11:22:49 +0300 From: Ruslan Ermilov <ru@FreeBSD.org> To: Greg Lehey <grog@FreeBSD.org> Cc: Sheldon Hearn <sheldonh@starjuice.net>, John Baldwin <jhb@FreeBSD.org>, Mike Pritchard <mpp@mppsystems.com>, cvs-committers@FreeBSD.org, cvs-all@FreeBSD.org, doc@FreeBSD.org Subject: Re: Which OS does a man page come from? (was: cvs commit: src/bi Message-ID: <20010807112249.A45963@sunbay.com> In-Reply-To: <20010807172430.M1565@wantadilla.lemis.com>; from grog@FreeBSD.org on Tue, Aug 07, 2001 at 05:24:30PM %2B0930 References: <20010807170342.J1565@wantadilla.lemis.com> <29137.997170775@axl.seasidesoftware.co.za> <20010807172430.M1565@wantadilla.lemis.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On Tue, Aug 07, 2001 at 05:24:30PM +0930, Greg Lehey wrote:
> On Tuesday, 7 August 2001 at 9:52:55 +0200, Sheldon Hearn wrote:
> >
> >
> > On Tue, 07 Aug 2001 17:03:42 +0930, Greg Lehey wrote:
> >
> >> As I said: we add the .Os and .Dd when installing.
> >
> > I don't agree on .Dd, which shouldn't bump for cosmetic changes.
>
> We can discuss that matter.
>
> > However, I can't see how your idea of populating .Os at install time
> > could hurt.
> >
> > Until the work to implement your idea is done, argument-less .Os macros
> > are the most sensible solution, since they work to some degree now and
> > will require no changes later when your idea is implemented.
>
> I don't see any reason to make any change at the moment. My main
> objection was to removing the .Os macros.
>
Again, I did NOT remove the .Os macro(s), I cleaned up the manpages
that had obsolete information in their arguments to the .Os call.
I.e., where the manual page had ``.Os BSD 4.2'', it now has an empty
.Os call, which becomes ``FreeBSD X.Y'', as defined in the FreeBSD
mdoc(7) setup file, src/gnu/usr.bin/groff/tmac/mdoc.local.
To see the FreeBSD manual page using its source on a different OS,
you will need the following:
1. Groff version 1.17.1 or later, which includes the "compatible"
mdoc(7) macro package.
2. FreeBSD-specific mdoc.local file that is compatible with this
manpage (obtained from the same source as the manpage), that
does the FreeBSD specific mdoc(7) package setup. You should
then put this file to the tmac/ directory, and rename it to
doc-FreeBSD.tmac.
Then you can browse the FreeBSD manpage on a non-FreeBSD OS, using
the following command:
$ nroff -mdoc -mdoc-FreeBSD <manpage>
This should give you exactly the same output as you would get on
a FreeBSD box this manpage was developed for. You can emulate
this scenario by renaming the stock mdoc.local file to mdoc-FreeBSD.tmac,
and creating the empty mdoc.local file as follows:
# cd /usr/share/tmac
# mv mdoc.local doc-FreeBSD.tmac
# touch mdoc.local
Then try to browse the manpage using the following commands:
$ nroff -mdoc <manpage>
$ nroff -mdoc -mdoc-FreeBSD <manpage>
Note the difference.
Cheers,
--
Ruslan Ermilov Oracle Developer/DBA,
ru@sunbay.com Sunbay Software AG,
ru@FreeBSD.org FreeBSD committer,
+380.652.512.251 Simferopol, Ukraine
http://www.FreeBSD.org The Power To Serve
http://www.oracle.com Enabling The Information Age
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20010807112249.A45963>