# Langhelp-0.9.2

**URL:** <https://www.ruby-forum.com/t/langhelp-0-9-2/97074>\
**Category:** Ruby\
**Created:** [December 10, 2005, 2:39am UTC](https://www.ruby-forum.com/t/langhelp-0-9-2/97074 "2005-12-10T02:39:10Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![rubikitch](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/0ea827/32.png) [@rubikitch](https://www.ruby-forum.com/u/rubikitch)\
**Post date:** [December 10, 2005, 2:39am UTC](https://www.ruby-forum.com/t/langhelp-0-9-2/97074/1 "2005-12-10T02:39:10Z")

</div>

Hi,

== Abstract

Langhelp creates an index of documents of various programming languages  
and shell commands.  
Languages 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?  
If you use Unices, then you may wonder, what is the usage of this  
command?  
Langhelp answers the question INSTANTLY.

Currently langhelp supports languages and commands below.  
bison  
cvs  
libtool  
latex  
ratpoisonrc  
gengetopt  
wget  
lua  
guile  
php  
texinfo  
c++  
c  
standards  
grep  
gdb  
diff  
octave  
gauche  
python  
flex  
tcl  
m4  
sed  
screenrc  
gzip  
perl  
emacs-lisp  
ruby  
autoconf  
hurd  
el4r  
binutils  
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](http://www.rubyist.net/~rubikitch/computer/langhelp/index.en.html)

== What’s new

=== [2005/12/10] 0.9.2 released

- langhelp full index (((%d%)) in langhelp buffer or ((%C-u C-c s%))).
- New class: HTML; create HTML index.
- More config settings. Not only programming languages but also shell  
commands.

=== [2005/12/03] 0.9.1 released

- Adjust to Ruby1.9.
- Langhelp default key binding (((%C-c s%))).

=== [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/](http://www.ruby-lang.org/)\>))
- emacs21 / xemacs21
- ((\<el4r 1.0.0 or  
upper|URL:[http://www.rubyist.net/~rubikitch/computer/el4r/](http://www.rubyist.net/~rubikitch/computer/el4r/)\>))

I use Debian GNU/Linux and Emacs21.  
Langhelp probably works on other GNU/Linux or Unices.  
Langhelp also works on Windows(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/](http://w3m.sourceforge.net/)\>)),  
((\<emacs\_w3m|URL:[http://emacs-w3m.namazu.org/](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/](http://rubyforge.org/projects/ri-emacs/)\>))  
This tool speeds up `ri’ calls.  
:  
((\<luahelp|URL:[http://lua-users.org/files/wiki\_insecure/users/NormanRamsey/luahelp](http://lua-users.org/files/wiki_insecure/users/NormanRamsey/luahelp)\>))  
Luahelp searches ((\<Lua|URL:[http://www.lua.org/](http://www.lua.org/)\>)) documents.  
: ((\<Emacs Lisp  
List|URL:[http://www.damtp.cam.ac.uk/user/sje30/emacs/ell.html](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/](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](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.1.tar.gz](http://www.rubyist.net/~rubikitch/archive/el4r-1.0.1.tar.gz)”).read.display’

> el4r-1.0.1.tar.gz  
> tar xzf el4r-1.0.1.tar.gz  
> cd el4r-1.0.1  
> 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.2.tar.gz](http://www.rubyist.net/~rubikitch/archive/langhelp-0.9.2.tar.gz)”).read.display’

> langhelp-0.9.2.tar.gz  
> tar xzvf langhelp-0.9.2.tar.gz

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

- 

((\<langhelp-0.9.2.tar.gz|URL:[http://www.rubyist.net/~rubikitch/archive/langhelp-0.9.2.tar.gz](http://www.rubyist.net/~rubikitch/archive/langhelp-0.9.2.tar.gz)\>))

Then, install it.

cd langhelp-0.9.2  
ruby setup.rb
