MouseTerm

MouseTerm is a SIMBL/PlugSuit plugin for Mac OS X's Terminal.app that passes mouse events to the terminal, allowing you to use mouse shortcuts within applications that support them.

No configuration is necessary, just open the .dmg file, run Install, and restart Terminal.app. To uninstall, simply run Uninstall from the .dmg.

Download

MouseTerm.dmg (82 KB)

Status

MouseTerm is currently alpha quality software. Some features have not yet been implemented, and there may be bugs in the current implementation.

What works:

• Mouse scroll wheel reporting.
• Simulated mouse wheel scrolling for programs like less (i.e. any fullscreen program that uses application cursor key mode).

What's being worked on:

• Reporting for other mouse buttons.
• xterm "hilite" mouse tracking mode.
• A preferences dialog and terminal profile integration.

Frequently Asked Questions

What programs can I use the mouse in?

This varies widely and depends on the specific program. less, Emacs, and Vim are good places to test out mouse reporting.

How do I enable mouse reporting in Vim?

To enable the mouse for all modes add the following to your ~/.vimrc file:

if has("mouse")
    set mouse=a
endif

Run :help mouse for more information and other possible values.

What about enabling it in Emacs?

By default MouseTerm will use simulated mouse wheel scrolling in Emacs. To enable terminal mouse support, add this to your ~/.emacs file:

(xterm-mouse-mode 1)
(mouse-wheel-mode 1)
(global-set-key [mouse-4] '(lambda ()
                             (interactive)
                             (scroll-down 1)))

(global-set-key [mouse-5] '(lambda ()
                             (interactive)
                             (scroll-up 1)))

Development

Download the official development repository using Mercurial:

hg clone http://bitheap.org/hg/mouseterm/

Run make to compile the plugin, and make install to install it into your home directory's SIMBL plugins folder. Run make and make builddmg to create a disk image of the application.

JRSwizzle and some mouse reporting code from iTerm are used in MouseTerm.