Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 17 Sep 1999 14:01:19 +0400 (MSD)
From:      Alex Kapranoff <alex@kapran.bitmcnit.bryansk.su>
To:        Nik Clayton <nik@FreeBSD.ORG>
Cc:        freebsd-doc@FreeBSD.ORG, freebsd-ports@FreeBSD.ORG
Subject:   Re: Building a page of installed software docs
Message-ID:  <199909171001.OAA01405@kapran.bitmcnit.bryansk.su>
In-Reply-To: <19990915231305.A31588@kilt.nothing-going-on.org>

next in thread | previous in thread | raw e-mail | index | archive | help
In article <19990915231305.A31588@kilt.nothing-going-on.org> you wrote:
> 
> Does anyone else think it would be useful if 'the system' could 
> automatically maintain an index page on behalf of the user (say, 
> /usr/local/share/doc/index.html).  This file wouldn't be part of any one

  Just like the /usr/share/info/dir file. Those programs which use info as
there documentation format add their entries to this file so that when I run
just "info" it shows me the index of all intalled docs in appropriate
format.

> port, but it would include links to all the HTML manuals that have been
> installed so far -- it could also include links to the HTML documentation
> that's been installed from the FDP.
> 
> Some as yet unwritten program could sit in /usr/local/etc/rc.d and rebuild
> this file automatically at boot time, or perhaps make it a part of 
> /etc/periodic/daily*, or something like that?  So that the user can just

  Lots of problems with figuring out where are the docs for a particular
program, what's the display name and so far.
 
> I think this is probably a good idea, but I'm not sure as to the best way to
> implement it.  This hypothetical rebuild-index.html-from-scratch script
> needs to know which files form the 'root' of the documentation for a 
> particular package.  Unfortunately, you can't just say "Anything that's
> called 'index.html'", as not all apps follow this convention.  For example,
> bzip2's manual root is called manual_toc.html, tidy's root is Overview.html,
> and so on.

  Yes, that's the problem.

> 
> I thought about suggesting an additional Makefile variable, that could list
> the name of the installed root file -- that fails for things that aren't
> built from the ports tree, such as doc/*, so that's probably out.

  What do you mean? Why not a variable for a port, one for an item from doc
and so on? 

  BTW, variables are too limited so your suggestion with pkg/ONE_MORE_FILE
is better, to my simple mind.

-- 
Alex Kapranoff,
Voice: +7(0832)791845,       <--- !!!! Сменился телефон !!!!


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?199909171001.OAA01405>