Document what does mouse-3 do on the mode line if there's only one window.

[gnu-emacs] / lisp / battery.el

diff --git a/lisp/battery.el b/lisp/battery.el
index e7f628d4d006fca8bf892a6a1eb9e48175a5ca61..ccafa8bf21308fa29b96e52269349045ae4663e8 100644 (file)
--- a/lisp/battery.el
+++ b/lisp/battery.el
@@ -1,8 +1,8 @@
 ;;; battery.el --- display battery status information.
 
-;; Copyright (C) 1997, 1998 Free Software Foundation, Inc.
+;; Copyright (C) 1997, 1998, 2000 Free Software Foundation, Inc.
 
-;; Author: Ralph Schleicher <rs@purple.UL.BaWue.DE>
+;; Author: Ralph Schleicher <rs@nunatak.allgaeu.org>
 ;; Keywords: hardware
 
 ;; This file is part of GNU Emacs.
@@ -33,7 +33,13 @@
 (require 'timer)
 
 \f
-(defvar battery-status-function
+
+(defgroup battery nil
+  "Display battery status information."
+  :prefix "battery-"
+  :group 'hardware)
+
+(defcustom battery-status-function
   (cond ((and (eq system-type 'gnu/linux)
              (file-readable-p "/proc/apm"))
         'battery-linux-proc-apm))
@@ -44,31 +50,39 @@ Cons cells are of the form
     (CONVERSION . REPLACEMENT-TEXT)
 
 CONVERSION is the character code of a \"conversion specification\"
-introduced by a `%' character in a control string.")
+introduced by a `%' character in a control string."
+  :type 'function
+  :group 'battery)
 
-(defvar battery-echo-area-format
+(defcustom battery-echo-area-format
   (cond ((eq battery-status-function 'battery-linux-proc-apm)
         "Power %L, battery %B (%p%% load, remaining time %t)"))
   "*Control string formatting the string to display in the echo area.
 Ordinary characters in the control string are printed as-is, while
 conversion specifications introduced by a `%' character in the control
 string are substituted as defined by the current value of the variable
-`battery-status-function'.")
+`battery-status-function'."
+  :type '(choice string (const nil))
+  :group 'battery)
 
 (defvar battery-mode-line-string nil
   "String to display in the mode line.")
 
-(defvar battery-mode-line-format
+(defcustom battery-mode-line-format
   (cond ((eq battery-status-function 'battery-linux-proc-apm)
         " [%b%p%%]"))
   "*Control string formatting the string to display in the mode line.
 Ordinary characters in the control string are printed as-is, while
 conversion specifications introduced by a `%' character in the control
 string are substituted as defined by the current value of the variable
-`battery-status-function'.")
+`battery-status-function'."
+  :type '(choice string (const nil))
+  :group 'battery)
 
-(defvar battery-update-interval 60
-  "*Seconds after which the battery status will be updated.")
+(defcustom battery-update-interval 60
+  "*Seconds after which the battery status will be updated."
+  :type 'integer
+  :group 'battery)
 
 (defvar battery-update-timer nil
   "Interval timer object.")
@@ -76,7 +90,7 @@ string are substituted as defined by the current value of the variable
 ;;;###autoload
 (defun battery ()
   "Display battery status information in the echo area.
-The text beeing displayed in the echo area is controlled by the variables
+The text being displayed in the echo area is controlled by the variables
 `battery-echo-area-format' and `battery-status-function'."
   (interactive)
   (message "%s" (if (and battery-echo-area-format battery-status-function)
@@ -87,16 +101,14 @@ The text beeing displayed in the echo area is controlled by the variables
 ;;;###autoload
 (defun display-battery ()
   "Display battery status information in the mode line.
-The text beeing displayed in the mode line is controlled by the variables
+The text being displayed in the mode line is controlled by the variables
 `battery-mode-line-format' and `battery-status-function'.
 The mode line will be updated automatically every `battery-update-interval'
 seconds."
   (interactive)
   (setq battery-mode-line-string "")
   (or global-mode-string (setq global-mode-string '("")))
-  (or (memq 'battery-mode-line-string global-mode-string)
-      (setq global-mode-string (append global-mode-string
-                                      '(battery-mode-line-string))))
+  (add-to-list 'global-mode-string 'battery-mode-line-string t)
   (and battery-update-timer (cancel-timer battery-update-timer))
   (setq battery-update-timer (run-at-time nil battery-update-interval
                                          'battery-update-handler))
@@ -155,9 +167,9 @@ The following %-sequences are provided:
        seconds minutes hours remaining-time buffer tem)
     (unwind-protect
        (save-excursion
-         (setq buffer (generate-new-buffer " *battery*"))
-         (buffer-disable-undo buffer)
+         (setq buffer (get-buffer-create " *battery*"))
          (set-buffer buffer)
+         (erase-buffer)
          (battery-insert-file-contents "/proc/apm")
          (re-search-forward battery-linux-proc-apm-regexp)
          (setq driver-version (match-string 1))
@@ -191,8 +203,7 @@ The following %-sequences are provided:
              (setq minutes (/ seconds 60)
                    hours (/ seconds 3600))
              (setq remaining-time
-                   (format "%d:%02d" hours (- minutes (* 60 hours)))))))
-      (and buffer (kill-buffer buffer)))
+                   (format "%d:%02d" hours (- minutes (* 60 hours))))))))
     (list (cons ?v (or driver-version "N/A"))
          (cons ?V (or bios-version "N/A"))
          (cons ?I (or bios-interface "N/A"))
@@ -235,6 +246,7 @@ The following %-sequences are provided:
 FILE-NAME can be a non-ordinary file, for example, a named pipe.
 Return t if file exists."
   (let ((load-read-function 'battery-read-function)
+       (load-source-file-function nil)
        (load-path '("."))
        (load-history nil))
     (save-excursion