Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 4 Oct 1999 23:49:56 +0100
From:      Mark Ovens <mark@ukug.uk.freebsd.org>
To:        Andrew Boothman <andrew@dogma.freebsd-uk.eu.org>
Cc:        doc@freebsd.org, nik@freebsd.org, wosch@cs.tu-berlin.de, nbm@mithrandr.moira.org
Subject:   Re: Automatic Documentation Index
Message-ID:  <19991004234956.A977@marder-1>
In-Reply-To: <XFMail.991004215148.andrew@ukug.uk.FreeBSD.org>
References:  <XFMail.990929224256.andrew@ukug.uk.FreeBSD.org> <XFMail.991004215148.andrew@ukug.uk.FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On Mon, Oct 04, 1999 at 09:51:48PM +0100, Andrew Boothman wrote:
> 
> On 29-Sep-99 Andrew Boothman wrote:
> > Well, I've been quietly working away on this, and I'd like some opinions on
> > what I've done so far.
> 
> I've been a little disappointed in the response to this. Do we think
> this is a worthwhile project, that we should encourage the Ports
> team to adopt, or should I just drop the idea?
>

Seems like a good thing to me. I've just tried it out (had to change
the paths to the FAQ and Handbook for the DocBook docs). There are
quite a few ports that install docs other than (& sometimes instead
of) manpages but don't advertise the fact.

As a temporary solution, until the +DOC files are added, how about
looking for html files in the +CONTENTS files? Something like

	# cd /var/db/pkg
	# grep '\.html$' */+CONTENTS

and parsing the output in some way (e.g. if there are several .html
files installed including "index.html" then just list the index
and ignore the others). It's not perfect, but it would dig out all
the "hidden" documentation.

I've only ever dabbled with perl so I can't guarantee to make it
work, but I'll have a go at implementing this if you feel that it's
worthwhile.

> I certainly think it's a good idea, but i'll need the support of at
> least somebody else, otherwise it's just a one-man crusade. I need
> the documentation project behind me on this.
>

> Do we think that newbies and busy sysadmins alike would benifit from
> an index page like this or not? If so, how should we move forward
> toward implementing it?
>

> Thanks.
> 
> ---
> Andrew Boothman <andrew@ukug.uk.FreeBSD.org>
> FreeBSD UK User Group
> http://ukug.uk.FreeBSD.org/~andrew/
> http://ukug.uk.FreeBSD.org/
> 
> 
> To Unsubscribe: send mail to majordomo@FreeBSD.org
> with "unsubscribe freebsd-doc" in the body of the message

-- 
STATE-OF-THE-ART: Any computer you can't afford.
OBSOLETE: Any computer you own.
________________________________________________________________
      FreeBSD - The Power To Serve http://www.freebsd.org
      My Webpage http://ukug.uk.freebsd.org/~mark/
mailto:mark@ukug.uk.freebsd.org              http://www.radan.com



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?19991004234956.A977>