https://github.com/evmar/devhelp-index

command line (emacs) interface into devhelp
https://github.com/evmar/devhelp-index

Last synced: 28 days ago
JSON representation

command line (emacs) interface into devhelp

• Host: GitHub
• URL: https://github.com/evmar/devhelp-index
• Owner: evmar
• Created: 2011-09-28T19:25:23.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2012-05-04T17:34:00.000Z (over 12 years ago)
• Last Synced: 2024-04-14T22:17:11.851Z (8 months ago)
• Language: Python
• Homepage:
• Size: 97.7 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
Some useful API documentation is not available as man pages but in

some other format:

* GTK stack, including related libraries like Cairo, uses gtk-doc;

* the excellent C++ reference available at [cppreference.com][] is HTML.

If they were man pages they'd integrate well into emacs (where `M-x

man` shows the man page of the word under the cursor).  But both are

available [Devhelp][] data files, which are for a Windows

help–like system.  Devhelp's GUI provides lists of functions,

keywords, etc.

The Python scripts in this repository index the Devhelp data file to

generate a plain text file mapping keywords to docs.  The elisp

code then provides a `M-x devhelp` command which behaves like `man`,

except that it opens the result in a browser.

[cppreference.com]: http://cppreference.com

[gtk-doc]: http://www.gtk.org/gtk-doc/

[Devhelp]: http://en.wikipedia.org/wiki/Devhelp

## Setup

For gtk-doc based packages like Cairo, `apt-get install libcairo2-doc`.

For the C++ reference, install from the [PPA][].

Now run `./devhelp-index.py`.  It will crawl those documentation

directories and create an index in `~/.cache`.

Finally, symlink `devhelp-query.py` into your PATH somewhere.  You can

now call it:

    $ devhelp-query equal_range

    /usr/share/cppreference/doc/en/html/en.cppreference.com/w/cpp/algorithm/equal_rangehtml.html

In Emacs, install `devhelp.el` and call it via `M-x devhelp`.  (If you

install the appropriate Emacs packages, `(setq

browse-url-browser-function 'w3m-browse-url)` will make Emacs use the

w3m browser within an Emacs buffer, bringing back the `man`

experience.)

[PPA]: https://launchpad.net/~p12/+archive/ppa