[English / Japanese]

Emacs-w3m, a simple Emacs interface to w3m.

Emacs/W3 used to be known as the most popular WEB browser on Emacs, but it worked so slowly that we wanted a simple and speedy alternative.

w3m is a pager with WWW capability, developed by Akinori ITO. Although it is a pager, it can be used as a text-mode WWW browser. Then we developed a simple Emacs interface to w3m.

Screenshot of how emacs-w3m works



Anyone wanting to checkout the latest version of emacs-w3m is welcome to use the anonymous CVS server to grab the most current developing code.

% cvs -d :pserver:anonymous@cvs.namazu.org:/storage/cvsroot login
CVS password: # No password is set.  Just hit Enter/Return key.
% cvs -d :pserver:anonymous@cvs.namazu.org:/storage/cvsroot co emacs-w3m

Source code access with ViewCVS is also available.


Emacs-w3m requires the latest version of w3m (version 0.3.1 and later). Since this program is much sensitive to the version of w3m, you should confirm it if you already have w3m installed. And we recommend you visit the official w3m web page to check whether a newer version of w3m has been released:

If you use w3mmee, it has to have been built with the configure option `-lang=many'. Note that you need to have the libmoe package installed in advance. You can verify whether w3mmee that has already been installed is an adequate one by performing:

w3mmee -version

Are items like `moe-VERSION' and `lang=many' present there?

In order to use the shimbun library which is included in the emacs-w3m distribution, FLIM package have to be installed. For more detail about the shimbun library, see Shimbun Library section in Info.

a) Emacs 21.1 and newer

No additional packages are required. If you're using a prerelease version of Emacs 22 (such as versions 21.3.50 or 22.0), make sure it is newer than March 2004.

b) Emacs 20.x

No additional package is required.

When BITMAP-MULE package is installed, you can see monochrome bitmap images inline on an Emacs frame.

c) XEmacs

The APEL package is required. Use the latest one available here.

Note: You must not use the APEL XEmacs package (which is contained in SUMO) of the versions older than 1.32. If you have already installed such a version, you should upgrade it or replace it with APEL which is linked above.

If you are using XEmacs 21.x, you should install the gifsicle program. There is a known bug in all XEmacs 21.x series that it won't let it display optimized animated gifs correctly or may make it crash when some kind of an interlaced gif image is displayed. Emacs-w3m uses the gifsicle program to convert gif data in order to make it possible to be handled by XEmacs 21.x.

d) Mule 2.3 (based on Emacs 19.34)

APEL package, the new custom package, and the regexp-opt.el(c) module are required. For more detail, see carefully the next section about Emacs 19.34.

If you wish to use BITMAP-MULE package to show monochrome images inline on the web pages, we strongly recommend you apply the patch and rebuild Mule. The patch is included in the emacs-w3m distribution. If you don't accept our recommendation, Mule might be stuck. And you wouldn't get out of the difficulty except killing Mule.

e) Emacs 19.34 (without MULE)

APEL package, the new custom package, and the regexp-opt.el(c) module are required.

Emacs-w3m requires the new custom package. If you use Emacs 19.34 or Mule 2.3, you have to install it before installing emacs-w3m. When you use Mule 2.3 especially, see also the README.en file which is included in the APEL distribution.

Emacs-w3m also requires the regexp-opt.el(c) module which might not be provided in the old Emacsen such as Emacs 19.34 and Mule 2.3. If you are using such versions of Emacs, you have to install the regexp-opt.el(c) module before installing emacs-w3m as follows:

% cp attic/regexp-opt.el /usr/local/share/emacs/site-lisp
% cd /usr/local/share/emacs/site-lisp
% emacs -q -no-site-file -batch -f batch-byte-compile regexp-opt.el

(You will likely need to say `mule' instead of `emacs' for the path name and the executable name if you are using Mule.)


Before installing emacs-w3m, you have to check whether your environment meets the requirements.

Installing emacs-w3m on UNIX-like systems

At the first, run the configure script.

% ./configure

If you've installed APEL, FLIM or something in non-standard directories other than the default load-path, you must specify them using the --with-addpath option as follows:

% ./configure --with-addpath=/opt/share/apel:/opt/share/flim

Next, execute the following commands to install emacs-w3m to an appropriate directory.

% make
# make install

If you are using Emacs 21.1 and newer or XEmacs, you had better install icon image files. To do this:

# make install-icons

You can also install emacs-w3m as an XEmacs package using make install-package instead of make install.

% make
# make install-package

In this case, you don't have to execute make install-icons.

Installing on non-UNIX-like systems

If you cannot execute the configure script on your system, or if no make command is available, execute the following command:

# emacs -batch -q -no-site-file -l w3mhack.el NONE -f w3mhack-nonunix-install

If APEL, FLIM (or any other library) aren't installed in the ordinary places, the installer will leave them out. In such a case, it is necessary to tell those places to the installer as shown below:

# emacs -batch -q -no-site-file -l w3mhack.el //c/share/apel://c/share/flim -f w3mhack-nonunix-install


Put this line into your ~/.emacs file:

(require 'w3m-load)

Just type M-x w3m, and you can use emacs-w3m.

In order to handle text/html part with emacs-w3m under SEMI MUAs such as Wanderlust, you have to put the following line in your ~/.emacs file:

(require 'mime-w3m)

For more detail, see Info manual.

Mailing List

We have the mailing list, emacs-w3m@namazu.org, to discuss about emacs-w3m. Because almost all of its members are Japanese, Japanese is mainly used for discussion but we also welcome mails written in English. This list is opened to the public, and its archive is accessible via WEB. You can also subscribe to the gmane.emacs.w3m newsgroup which is gateway'd to this list bidirectionally.

If you want to subscribe to this list, check the disclaimer and send a mail containing

subscribe Your Name

(not your email address) in the body to emacs-w3m-ctl@namazu.org. To unsubscribe to it, send a mail containing just

# bye

in the body to emacs-w3m-ctl@namazu.org.

Related Links


(alphabetical order in the family names)

Thanks to many of the other people for the great contributions.


In order to contact us, please send a mail to emacs-w3m@namazu.org. This mailing list is gateway'd to the gmane.emacs.w3m newsgroup bidirectionally and accepts even messages posted from nonsubscribers.