Add 2012 to FSF copyright years for Emacs files
[bpt/emacs.git] / lisp / eshell / em-prompt.el
index 33b207f..3fe9995 100644 (file)
@@ -1,16 +1,15 @@
 ;;; em-prompt.el --- command prompts
 
-;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
-;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; Copyright (C) 1999-2012  Free Software Foundation, Inc.
 
 ;; Author: John Wiegley <johnw@gnu.org>
 
 ;; 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
@@ -18,9 +17,7 @@
 ;; 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:
 
@@ -31,7 +28,8 @@
 
 (eval-when-compile (require 'eshell))
 
-(defgroup eshell-prompt nil
+;;;###autoload
+(eshell-defgroup eshell-prompt nil
   "This module provides command prompts, and navigation between them,
 as is common with most shells."
   :tag "Command prompts"
@@ -39,24 +37,25 @@ as is common with most shells."
 
 ;;; User Variables:
 
-(defcustom eshell-prompt-load-hook '(eshell-prompt-initialize)
-  "*A list of functions to call when loading `eshell-prompt'."
+(defcustom eshell-prompt-load-hook nil
+  "A list of functions to call when loading `eshell-prompt'."
+  :version "24.1"                      ; removed eshell-prompt-initialize
   :type 'hook
   :group 'eshell-prompt)
 
 (defcustom eshell-prompt-function
   (function
    (lambda ()
-     (concat (eshell/pwd)
+     (concat (abbreviate-file-name (eshell/pwd))
             (if (= (user-uid) 0) " # " " $ "))))
-  "*A function that returns the Eshell prompt string.
+  "A function that returns the Eshell prompt string.
 Make sure to update `eshell-prompt-regexp' so that it will match your
 prompt."
   :type 'function
   :group 'eshell-prompt)
 
 (defcustom eshell-prompt-regexp "^[^#$\n]* [#$] "
-  "*A regexp which fully matches your eshell prompt.
+  "A regexp which fully matches your eshell prompt.
 This setting is important, since it affects how eshell will interpret
 the lines that are passed to it.
 If this variable is changed, all Eshell buffers must be exited and
@@ -65,7 +64,7 @@ re-entered for it to take effect."
   :group 'eshell-prompt)
 
 (defcustom eshell-highlight-prompt t
-  "*If non-nil, Eshell should highlight the prompt."
+  "If non-nil, Eshell should highlight the prompt."
   :type 'boolean
   :group 'eshell-prompt)
 
@@ -73,21 +72,20 @@ re-entered for it to take effect."
   '((((class color) (background light)) (:foreground "Red" :bold t))
     (((class color) (background dark)) (:foreground "Pink" :bold t))
     (t (:bold t)))
-  "*The face used to highlight prompt strings.
+  "The face used to highlight prompt strings.
 For highlighting other kinds of strings -- similar to shell mode's
 behavior -- simply use an output filer which changes text properties."
   :group 'eshell-prompt)
-;; backward-compatibility alias
-(put 'eshell-prompt-face 'face-alias 'eshell-prompt)
+(define-obsolete-face-alias 'eshell-prompt-face 'eshell-prompt "22.1")
 
 (defcustom eshell-before-prompt-hook nil
-  "*A list of functions to call before outputting the prompt."
+  "A list of functions to call before outputting the prompt."
   :type 'hook
   :options '(eshell-begin-on-new-line)
   :group 'eshell-prompt)
 
 (defcustom eshell-after-prompt-hook nil
-  "*A list of functions to call after outputting the prompt.
+  "A list of functions to call after outputting the prompt.
 Note that if `eshell-scroll-show-maximum-output' is non-nil, then
 setting `eshell-show-maximum-output' here won't do much.  It depends
 on whether the user wants the resizing to happen while output is
@@ -175,5 +173,8 @@ If this takes us past the end of the current line, don't skip at all."
 
 (provide 'em-prompt)
 
-;; arch-tag: 01c1574b-ce70-4e89-bc38-e6619f61e208
+;; Local Variables:
+;; generated-autoload-file: "esh-groups.el"
+;; End:
+
 ;;; em-prompt.el ends here