;;; time.el --- display time, load and mail indicator in mode line of Emacs -*-coding: utf-8 -*-
;; Copyright (C) 1985, 1986, 1987, 1993, 1994, 1996, 2000, 2001, 2002,
-;; 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
;; Maintainer: FSF
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
(defcustom display-time-mail-file nil
- "*File name of mail inbox file, for indicating existence of new mail.
+ "File name of mail inbox file, for indicating existence of new mail.
Non-nil and not a string means don't check for mail; nil means use
default, which is system-dependent, and is the same as used by Rmail."
:type '(choice (const :tag "None" none)
:group 'display-time)
(defcustom display-time-mail-directory nil
- "*Name of mail inbox directory, for indicating existence of new mail.
+ "Name of mail inbox directory, for indicating existence of new mail.
Any nonempty regular file in the directory is regarded as newly arrived mail.
If nil, do not check a directory for arriving mail."
:type '(choice (const :tag "None" nil)
:group 'display-time)
(defcustom display-time-mail-function nil
- "*Function to call, for indicating existence of new mail.
+ "Function to call, for indicating existence of new mail.
If nil, that means use the default method: check that the file
specified by `display-time-mail-file' is nonempty or that the
directory `display-time-mail-directory' contains nonempty files."
:group 'display-time)
(defcustom display-time-default-load-average 0
- "*Which load average value will be shown in the mode line.
+ "Which load average value will be shown in the mode line.
Almost every system can provide values of load for past 1 minute, past 5 or
-past 15 minutes. The default is to display 1 minute load average."
+past 15 minutes. The default is to display 1 minute load average.
+The value can be one of:
+
+ 0 => 1 minute load
+ 1 => 5 minutes load
+ 2 => 15 minutes load"
:type '(choice (const :tag "1 minute load" 0)
(const :tag "5 minutes load" 1)
(const :tag "15 minutes load" 2)
"Load average currently being shown in mode line.")
(defcustom display-time-load-average-threshold 0.1
- "*Load-average values below this value won't be shown in the mode line."
+ "Load-average values below this value won't be shown in the mode line."
:type 'number
:group 'display-time)
(defvar display-time-timer nil)
(defcustom display-time-interval 60
- "*Seconds between updates of time in the mode line."
+ "Seconds between updates of time in the mode line."
:type 'integer
:group 'display-time)
(defcustom display-time-24hr-format nil
- "*Non-nil indicates time should be displayed as hh:mm, 0 <= hh <= 23.
+ "Non-nil indicates time should be displayed as hh:mm, 0 <= hh <= 23.
A value of nil means 1 <= hh <= 12, and an AM/PM suffix is used."
:type 'boolean
:group 'display-time)
(defvar display-time-string nil)
+;;;###autoload(put 'display-time-string 'risky-local-variable t)
(defcustom display-time-hook nil
- "*List of functions to be called when the time is updated on the mode line."
+ "List of functions to be called when the time is updated on the mode line."
:type 'hook
:group 'display-time)
string))
(defcustom display-time-format nil
- "*String specifying format for displaying the time in the mode line.
+ "String specifying format for displaying the time in the mode line.
See the function `format-time-string' for an explanation of
how to write this string. If this is nil, the defaults
depend on `display-time-day-and-date' and `display-time-24hr-format'."
'local-map (make-mode-line-mouse-map 'mouse-2
read-mail-command)))
""))
- "*List of expressions governing display of the time in the mode line.
+ "List of expressions governing display of the time in the mode line.
For most purposes, you can control the time format using `display-time-format'
which is a more standard interface.
(interactive)
(let ((str
(format-seconds (or format "%Y, %D, %H, %M, %z%S")
- (time-to-seconds
+ (float-time
(time-subtract (current-time) before-init-time)))))
(if (interactive-p)
(message "%s" str)
(interactive)
(let ((str
(format "%.1f seconds"
- (time-to-seconds
+ (float-time
(time-subtract after-init-time before-init-time)))))
(if (interactive-p)
(message "%s" str)