James wrote:
The biggest problem is I'm looking for a tool, gui, or automated
approach to discover documents (html, xml, doc-book etc) that
go with the myriad of software pacakges. I do not need a
tool to parse my directories, I'm looking for a tool that saves
me time by producing a unified deliver mechanism for ellusive
documentation.
Like man pages for ascii text, but which covers all of the various types
and locations for docs. Collectively, a lot of time is wasted since
each individual has to search ebuilds, lib, share, wikis, web sites
and googling to find these documents, which sometimes exist and sometimes
do not exist, in a menagerie of forms.
Playing around I have a little script that does part of what I think you
are looking for.
Here's a sample output when asking about two terms: "portage" and "lex":
$ about portage lex
checking if lex belongs to a package
lex belongs to flex
sys-apps/portage [http://www.gentoo.org/proj/en/portage/index.xml]
Installed: 2.1.1_pre2-r7
/usr/share/man/man5
/usr/doc/portage-2.1.1_pre2-r7
/usr/share/doc/portage-2.1.1_pre2-r7
/usr/portage/sys-apps/portage/portage-2.1.1_pre2-r7.ebuild
lex
/usr/share/man/man1p
lex belongs to sys-devel/flex [http://lex.sourceforge.net/] Installed:
2.5.33-r1
/usr/share/man/man1
/usr/share/info
/usr/doc/flex-2.5.33-r1
/usr/share/doc/flex-2.5.33-r1
/usr/portage/sys-devel/flex/flex-2.5.33-r1.ebuild
This basically just harvests:
* URL from portage by running `eix --exact --format "<homepage>" #{name}`
* if a homepage is not found, then try to find the parent with an
`equery belongs`
* the directory of any man pages
* the directory of any info pages
* any doc directories for the package
Now it doesn't attempt to harvest any info from the documentation, nor does
it search the web. I'm playing with harvesting portage elog info next.
If you want to play with it, you will need the following installed:
app-portage/eix
app-portage/gentoolkit
dev-lang/ruby
The script is temporary available at: http://roy.wright.org/about.rb
Installation is simply to copy it to your ~/bin directory and chmod +x
it.
Have fun,
Roy
--
gentoo-user@gentoo.org mailing list
