From: rubikitch@...
Date: 2005-12-02T03:03:20+09:00
Subject: [ANN] langhelp-0.9.0

Hi,

== Abstract

Langhelp creates an index of documents of various programming languages, and enables you to search documents instantly in Emacs.
If you are a programmer, then you may sometimes wonder, what is the usage of this function?
Langhelp answers the question INSTANTLY.

Currently langhelp supports languages below.
  latex
  ratpoisonrc
  lua
  guile
  php
  c++
  c
  octave
  gauche
  python
  tcl
  m4
  sed
  screenrc
  perl
  emacs-lisp
  ruby
  autoconf
  el4r
  awk
  graphviz-dot
  makefile
  sh


Langhelp may be the first tool written in EmacsRuby in the world.
In other words, langhelp is an practical example of EmacsRuby script.


It is available at 
http://www.rubyist.net/~rubikitch/computer/langhelp/index.en.html


== What's new

=== [2005/12/02] 0.9.0 released
Initial release



== Environment

Langhelp depends on some tools.
* ((<Ruby 1.8.2 or upper|URL:http://www.ruby-lang.org/>))
* emacs21 / xemacs21
* ((<el4r 1.0.0 or upper|URL:http://www.rubyist.net/~rubikitch/computer/el4r/>))

I use Debian GNU/Linux and Emacs21.
Langhelp probably works other GNU/Linux or Unices.
Langhelp may work Windows environment (Meadow + Cygwin).

Langhelp does not compete against other document-lookup tools, but langhelp INTEGRATES document-lookup tools.
The more you have tools, the more usefule langhelp is.


=== Langhelp support tools
The following tools are not mandatory but strengthens langhelp.

: various Info documents 
  Langhelp treats Info documents VERY EASY.
: ((<w3m|URL:http://w3m.sourceforge.net/>)), ((<emacs_w3m|URL:http://emacs-w3m.namazu.org/>))
  W3m processes HTML documents.
  Emacs-w3m is a WWW browser in Emacs, uses w3m internally.
: Ri
  Ri looks up Ruby methods. It is bundled in Ruby distribution.
: ((<Ri for (X)Emacs|URL:http://rubyforge.org/projects/ri-emacs/>))
  This tool speeds up `ri' calls.
: ((<luahelp|URL:http://lua-users.org/files/wiki_insecure/users/NormanRamsey/luahelp>))
  Luahelp searches ((<Lua|URL:http://www.lua.org/>)) documents.
: ((<Emacs Lisp List|URL:http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html>))
  There are MANY EmacsLisp programs.
: ((<screenrc.el|URL:http://www.rubyist.net/~rubikitch/computer/screenrc-mode/>))
  Major mode for editing screenrc.
: ratpoison.el
  Major mode for editing ratpoisonrc. It is bundled in ratpoison distribution.
: ((<bm.el|URL:http://savannah.nongnu.org/cgi-bin/viewcvs/*checkout*/bm/bm/bm.el?rev=HEAD&content-type=text/plain>))
  Visible bookmarks in buffer.

== Install
First install el4r to run EmacsRuby scripts.
  ruby -ropen-uri -e 'URI("http://www.rubyist.net/~rubikitch/archive/el4r-1.0.0.tar.gz").read.display' | tar xzf -
  cd el4r-1.0.0
  ruby setup.rb

  ruby -S el4r-rctool -p
  ruby -S el4r-rctool -i


Then install langhelp.
Please execute the following commands.

  ruby -ropen-uri -e 'URI("http://www.rubyist.net/~rubikitch/archive/langhelp-0.9.0.tar.gz").read.display' | tar xzvf -

When you failed, please download it from the next link.

* ((<langhelp-0.9.0.tar.gz|URL:http://www.rubyist.net/~rubikitch/archive/langhelp-0.9.0.tar.gz>))

Then, install it.

  ruby setup.rb


--
rubikitch
http://www.rubyist.net/~rubikitch/index.en.html