lisp/t-mouse.el

   1 ;;; t-mouse.el --- mouse support within the text terminal
   2
   3 ;; Author: Nick Roberts <nickrob@gnu.org>
   4 ;; Maintainer: FSF
   5 ;; Keywords: mouse gpm linux
   6
   7 ;; Copyright (C) 1994, 1995, 1998, 2006, 2007 Free Software Foundation, Inc.
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; This package provides access to mouse event as reported by the gpm-Linux
  29 ;; package. It tries to reproduce the functionality offered by Emacs under X.
  30 ;; The "gpm" server runs under Linux, so this package is rather
  31 ;; Linux-dependent.
  32
  33 ;; The file, t-mouse was originally written by Alessandro Rubini and Ian T
  34 ;; Zimmerman and communicated with Emacs through the client program mev.  Now
  35 ;; the interface with gpm is directly through a Unix socket, so this file is
  36 ;; reduced to a minor mode macro call.
  37
  38 ;;
  39 \f
  40 ;;; Code:
  41
  42 ;;;###autoload
  43 (define-minor-mode t-mouse-mode
  44   "Toggle t-mouse mode to use the mouse in Linux consoles.
  45 With prefix arg, turn t-mouse mode on iff arg is positive.
  46
  47 This allows the use of the mouse when operating on a Linux console, in the
  48 same way as you can use the mouse under X11.
  49 It requires the `mev' program, part of the `gpm' utilities."
  50   :global t :group 'mouse
  51   (if window-system
  52       (error "t-mouse only works in the console on GNU/Linux")
  53     (if t-mouse-mode
  54         (progn
  55           (unless (fboundp 'term-open-connection)
  56             (error "Emacs must be built with Gpm to use this mode"))
  57           (unless (term-open-connection)
  58             (error "Can't open mouse connection")))
  59       ;; Turn it off
  60       (term-close-connection))))
  61
  62 (provide 't-mouse)
  63
  64 ;; arch-tag: a63163b3-bfbe-4eb2-ab4f-201cd164b05d
  65 ;;; t-mouse.el ends here