Document new create-lockfiles option
[bpt/emacs.git] / lisp / ruler-mode.el
index fc62bf6..9a8bb8e 100644 (file)
@@ -1,6 +1,6 @@
 ;;; ruler-mode.el --- display a ruler in the header line
 
-;; Copyright (C) 2001-2011 Free Software Foundation, Inc.
+;; Copyright (C) 2001-2012 Free Software Foundation, Inc.
 
 ;; Author: David Ponce <david@dponce.com>
 ;; Maintainer: David Ponce <david@dponce.com>
@@ -567,8 +567,10 @@ format first."
 
 ;;;###autoload
 (define-minor-mode ruler-mode
-  "Toggle Ruler mode.
-In Ruler mode, Emacs displays a ruler in the header line."
+  "Toggle display of ruler in header line (Ruler mode).
+With a prefix argument ARG, enable Ruler mode if ARG is positive,
+and disable it otherwise.  If called from Lisp, enable the mode
+if ARG is omitted or nil."
   nil nil
   ruler-mode-map
   :group 'ruler-mode