aboutsummaryrefslogtreecommitdiffstats
path: root/lisp
diff options
context:
space:
mode:
authorGlenn Morris2010-09-25 14:51:55 -0700
committerGlenn Morris2010-09-25 14:51:55 -0700
commitec60da520ebe8cc187ab44e17a3645147b75ec57 (patch)
tree96f0a8075fe50dfd85d1e3ab721c94a395409e76 /lisp
parent4c96435152dd2b343057f80f995910ba806774e8 (diff)
downloademacs-ec60da520ebe8cc187ab44e17a3645147b75ec57.tar.gz
emacs-ec60da520ebe8cc187ab44e17a3645147b75ec57.zip
Cosmetic doc fixes for eshell.
* eshell/em-alias.el, eshell/em-banner.el, eshell/em-basic.el: * eshell/em-cmpl.el, eshell/em-dirs.el, eshell/em-glob.el: * eshell/em-hist.el, eshell/em-ls.el, eshell/em-pred.el: * eshell/em-prompt.el, eshell/em-rebind.el, eshell/em-script.el: * eshell/em-smart.el, eshell/em-term.el, eshell/em-unix.el: * eshell/esh-cmd.el, eshell/esh-ext.el, eshell/esh-io.el: * eshell/esh-mode.el, eshell/esh-proc.el, eshell/esh-test.el: * eshell/esh-util.el, eshell/esh-var.el: Remove leading `*' from docs of faces and defcustoms.
Diffstat (limited to 'lisp')
-rw-r--r--lisp/ChangeLog12
-rw-r--r--lisp/eshell/em-alias.el6
-rw-r--r--lisp/eshell/em-banner.el4
-rw-r--r--lisp/eshell/em-basic.el2
-rw-r--r--lisp/eshell/em-cmpl.el10
-rw-r--r--lisp/eshell/em-dirs.el28
-rw-r--r--lisp/eshell/em-glob.el16
-rw-r--r--lisp/eshell/em-hist.el26
-rw-r--r--lisp/eshell/em-ls.el48
-rw-r--r--lisp/eshell/em-pred.el6
-rw-r--r--lisp/eshell/em-prompt.el12
-rw-r--r--lisp/eshell/em-rebind.el12
-rw-r--r--lisp/eshell/em-script.el6
-rw-r--r--lisp/eshell/em-smart.el12
-rw-r--r--lisp/eshell/em-term.el8
-rw-r--r--lisp/eshell/em-unix.el30
-rw-r--r--lisp/eshell/esh-cmd.el28
-rw-r--r--lisp/eshell/esh-ext.el20
-rw-r--r--lisp/eshell/esh-io.el14
-rw-r--r--lisp/eshell/esh-mode.el34
-rw-r--r--lisp/eshell/esh-proc.el26
-rw-r--r--lisp/eshell/esh-test.el6
-rw-r--r--lisp/eshell/esh-util.el22
-rw-r--r--lisp/eshell/esh-var.el16
24 files changed, 208 insertions, 196 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 7d1fcbc778d..e001afa8979 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,15 @@
12010-09-25 Glenn Morris <rgm@gnu.org>
2
3 * eshell/em-alias.el, eshell/em-banner.el, eshell/em-basic.el:
4 * eshell/em-cmpl.el, eshell/em-dirs.el, eshell/em-glob.el:
5 * eshell/em-hist.el, eshell/em-ls.el, eshell/em-pred.el:
6 * eshell/em-prompt.el, eshell/em-rebind.el, eshell/em-script.el:
7 * eshell/em-smart.el, eshell/em-term.el, eshell/em-unix.el:
8 * eshell/esh-cmd.el, eshell/esh-ext.el, eshell/esh-io.el:
9 * eshell/esh-mode.el, eshell/esh-proc.el, eshell/esh-test.el:
10 * eshell/esh-util.el, eshell/esh-var.el:
11 Remove leading `*' from docs of faces and defcustoms.
12
12010-09-25 Ulrich Mueller <ulm@gentoo.org> 132010-09-25 Ulrich Mueller <ulm@gentoo.org>
2 14
3 * eshell/em-ls.el (eshell-ls-archive-regexp): 15 * eshell/em-ls.el (eshell-ls-archive-regexp):
diff --git a/lisp/eshell/em-alias.el b/lisp/eshell/em-alias.el
index 6dcdadf0a5d..6b24c269b30 100644
--- a/lisp/eshell/em-alias.el
+++ b/lisp/eshell/em-alias.el
@@ -103,7 +103,7 @@
103 :group 'eshell-module) 103 :group 'eshell-module)
104 104
105(defcustom eshell-aliases-file (expand-file-name "alias" eshell-directory-name) 105(defcustom eshell-aliases-file (expand-file-name "alias" eshell-directory-name)
106 "*The file in which aliases are kept. 106 "The file in which aliases are kept.
107Whenever an alias is defined by the user, using the `alias' command, 107Whenever an alias is defined by the user, using the `alias' command,
108it will be written to this file. Thus, alias definitions (and 108it will be written to this file. Thus, alias definitions (and
109deletions) are always permanent. This approach was chosen for the 109deletions) are always permanent. This approach was chosen for the
@@ -113,13 +113,13 @@ gained by using this module."
113 :group 'eshell-alias) 113 :group 'eshell-alias)
114 114
115(defcustom eshell-bad-command-tolerance 3 115(defcustom eshell-bad-command-tolerance 3
116 "*The number of failed commands to ignore before creating an alias." 116 "The number of failed commands to ignore before creating an alias."
117 :type 'integer 117 :type 'integer
118 ;; :link '(custom-manual "(eshell)Auto-correction of bad commands") 118 ;; :link '(custom-manual "(eshell)Auto-correction of bad commands")
119 :group 'eshell-alias) 119 :group 'eshell-alias)
120 120
121(defcustom eshell-alias-load-hook '(eshell-alias-initialize) 121(defcustom eshell-alias-load-hook '(eshell-alias-initialize)
122 "*A hook that gets run when `eshell-alias' is loaded." 122 "A hook that gets run when `eshell-alias' is loaded."
123 :type 'hook 123 :type 'hook
124 :group 'eshell-alias) 124 :group 'eshell-alias)
125 125
diff --git a/lisp/eshell/em-banner.el b/lisp/eshell/em-banner.el
index c13df836651..9087cae369c 100644
--- a/lisp/eshell/em-banner.el
+++ b/lisp/eshell/em-banner.el
@@ -58,7 +58,7 @@ modules may have a simple template to begin with."
58;;; User Variables: 58;;; User Variables:
59 59
60(defcustom eshell-banner-message "Welcome to the Emacs shell\n\n" 60(defcustom eshell-banner-message "Welcome to the Emacs shell\n\n"
61 "*The banner message to be displayed when Eshell is loaded. 61 "The banner message to be displayed when Eshell is loaded.
62This can be any sexp, and should end with at least two newlines." 62This can be any sexp, and should end with at least two newlines."
63 :type 'sexp 63 :type 'sexp
64 :group 'eshell-banner) 64 :group 'eshell-banner)
@@ -66,7 +66,7 @@ This can be any sexp, and should end with at least two newlines."
66(put 'eshell-banner-message 'risky-local-variable t) 66(put 'eshell-banner-message 'risky-local-variable t)
67 67
68(defcustom eshell-banner-load-hook '(eshell-banner-initialize) 68(defcustom eshell-banner-load-hook '(eshell-banner-initialize)
69 "*A list of functions to run when `eshell-banner' is loaded." 69 "A list of functions to run when `eshell-banner' is loaded."
70 :type 'hook 70 :type 'hook
71 :group 'eshell-banner) 71 :group 'eshell-banner)
72 72
diff --git a/lisp/eshell/em-basic.el b/lisp/eshell/em-basic.el
index a4074011f58..ce72f752d42 100644
--- a/lisp/eshell/em-basic.el
+++ b/lisp/eshell/em-basic.el
@@ -77,7 +77,7 @@ same thing."
77 :group 'eshell-module) 77 :group 'eshell-module)
78 78
79(defcustom eshell-plain-echo-behavior nil 79(defcustom eshell-plain-echo-behavior nil
80 "*If non-nil, `echo' tries to behave like an ordinary shell echo. 80 "If non-nil, `echo' tries to behave like an ordinary shell echo.
81This comes at some detriment to Lisp functionality. However, the Lisp 81This comes at some detriment to Lisp functionality. However, the Lisp
82equivalent of `echo' can always be achieved by using `identity'." 82equivalent of `echo' can always be achieved by using `identity'."
83 :type 'boolean 83 :type 'boolean
diff --git a/lisp/eshell/em-cmpl.el b/lisp/eshell/em-cmpl.el
index b0aad0f1499..554e010a1b3 100644
--- a/lisp/eshell/em-cmpl.el
+++ b/lisp/eshell/em-cmpl.el
@@ -86,26 +86,26 @@ variable names, arguments, etc."
86;;; User Variables: 86;;; User Variables:
87 87
88(defcustom eshell-cmpl-load-hook '(eshell-cmpl-initialize) 88(defcustom eshell-cmpl-load-hook '(eshell-cmpl-initialize)
89 "*A list of functions to run when `eshell-cmpl' is loaded." 89 "A list of functions to run when `eshell-cmpl' is loaded."
90 :type 'hook 90 :type 'hook
91 :group 'eshell-cmpl) 91 :group 'eshell-cmpl)
92 92
93(defcustom eshell-show-lisp-completions nil 93(defcustom eshell-show-lisp-completions nil
94 "*If non-nil, include Lisp functions in the command completion list. 94 "If non-nil, include Lisp functions in the command completion list.
95If this variable is nil, Lisp completion can still be done in command 95If this variable is nil, Lisp completion can still be done in command
96position by using M-TAB instead of TAB." 96position by using M-TAB instead of TAB."
97 :type 'boolean 97 :type 'boolean
98 :group 'eshell-cmpl) 98 :group 'eshell-cmpl)
99 99
100(defcustom eshell-show-lisp-alternatives t 100(defcustom eshell-show-lisp-alternatives t
101 "*If non-nil, and no other completions found, show Lisp functions. 101 "If non-nil, and no other completions found, show Lisp functions.
102Setting this variable means nothing if `eshell-show-lisp-completions' 102Setting this variable means nothing if `eshell-show-lisp-completions'
103is non-nil." 103is non-nil."
104 :type 'boolean 104 :type 'boolean
105 :group 'eshell-cmpl) 105 :group 'eshell-cmpl)
106 106
107(defcustom eshell-no-completion-during-jobs t 107(defcustom eshell-no-completion-during-jobs t
108 "*If non-nil, don't allow completion while a process is running." 108 "If non-nil, don't allow completion while a process is running."
109 :type 'boolean 109 :type 'boolean
110 :group 'eshell-cmpl) 110 :group 'eshell-cmpl)
111 111
@@ -126,7 +126,7 @@ is non-nil."
126 ("dbx" . "\\`\\([^.]*\\|a\\.out\\)\\'") 126 ("dbx" . "\\`\\([^.]*\\|a\\.out\\)\\'")
127 ("sdb" . "\\`\\([^.]*\\|a\\.out\\)\\'") 127 ("sdb" . "\\`\\([^.]*\\|a\\.out\\)\\'")
128 ("adb" . "\\`\\([^.]*\\|a\\.out\\)\\'")) 128 ("adb" . "\\`\\([^.]*\\|a\\.out\\)\\'"))
129 "*An alist that defines simple argument type correlations. 129 "An alist that defines simple argument type correlations.
130This is provided for common commands, as a simplistic alternative 130This is provided for common commands, as a simplistic alternative
131to writing a completion function." 131to writing a completion function."
132 :type '(repeat (cons string regexp)) 132 :type '(repeat (cons string regexp))
diff --git a/lisp/eshell/em-dirs.el b/lisp/eshell/em-dirs.el
index 43bc3ffaa6f..f4b2575def2 100644
--- a/lisp/eshell/em-dirs.el
+++ b/lisp/eshell/em-dirs.el
@@ -60,14 +60,14 @@ they lack somewhat in feel from the typical shell equivalents."
60;;; User Variables: 60;;; User Variables:
61 61
62(defcustom eshell-dirs-load-hook '(eshell-dirs-initialize) 62(defcustom eshell-dirs-load-hook '(eshell-dirs-initialize)
63 "*A hook that gets run when `eshell-dirs' is loaded." 63 "A hook that gets run when `eshell-dirs' is loaded."
64 :type 'hook 64 :type 'hook
65 :group 'eshell-dirs) 65 :group 'eshell-dirs)
66 66
67(defcustom eshell-pwd-convert-function (if (eshell-under-windows-p) 67(defcustom eshell-pwd-convert-function (if (eshell-under-windows-p)
68 'expand-file-name 68 'expand-file-name
69 'identity) 69 'identity)
70 "*The function used to normalize the value of Eshell's `pwd'. 70 "The function used to normalize the value of Eshell's `pwd'.
71The value returned by `pwd' is also used when recording the 71The value returned by `pwd' is also used when recording the
72last-visited directory in the last-dir-ring, so it will affect the 72last-visited directory in the last-dir-ring, so it will affect the
73form of the list used by 'cd ='." 73form of the list used by 'cd ='."
@@ -78,7 +78,7 @@ form of the list used by 'cd ='."
78 :group 'eshell-dirs) 78 :group 'eshell-dirs)
79 79
80(defcustom eshell-ask-to-save-last-dir 'always 80(defcustom eshell-ask-to-save-last-dir 'always
81 "*Determine if the last-dir-ring should be automatically saved. 81 "Determine if the last-dir-ring should be automatically saved.
82The last-dir-ring is always preserved when exiting an Eshell buffer. 82The last-dir-ring is always preserved when exiting an Eshell buffer.
83However, when Emacs is being shut down, this variable determines 83However, when Emacs is being shut down, this variable determines
84whether to prompt the user, or just save the ring. 84whether to prompt the user, or just save the ring.
@@ -91,22 +91,22 @@ If set to `always', the list-dir-ring will always be saved, silently."
91 :group 'eshell-dirs) 91 :group 'eshell-dirs)
92 92
93(defcustom eshell-cd-shows-directory nil 93(defcustom eshell-cd-shows-directory nil
94 "*If non-nil, using `cd' will report the directory it changes to." 94 "If non-nil, using `cd' will report the directory it changes to."
95 :type 'boolean 95 :type 'boolean
96 :group 'eshell-dirs) 96 :group 'eshell-dirs)
97 97
98(defcustom eshell-cd-on-directory t 98(defcustom eshell-cd-on-directory t
99 "*If non-nil, do a cd if a directory is in command position." 99 "If non-nil, do a cd if a directory is in command position."
100 :type 'boolean 100 :type 'boolean
101 :group 'eshell-dirs) 101 :group 'eshell-dirs)
102 102
103(defcustom eshell-directory-change-hook nil 103(defcustom eshell-directory-change-hook nil
104 "*A hook to run when the current directory changes." 104 "A hook to run when the current directory changes."
105 :type 'hook 105 :type 'hook
106 :group 'eshell-dirs) 106 :group 'eshell-dirs)
107 107
108(defcustom eshell-list-files-after-cd nil 108(defcustom eshell-list-files-after-cd nil
109 "*If non-nil, call \"ls\" with any remaining args after doing a cd. 109 "If non-nil, call \"ls\" with any remaining args after doing a cd.
110This is provided for convenience, since the same effect is easily 110This is provided for convenience, since the same effect is easily
111achieved by adding a function to `eshell-directory-change-hook' that 111achieved by adding a function to `eshell-directory-change-hook' that
112calls \"ls\" and references `eshell-last-arguments'." 112calls \"ls\" and references `eshell-last-arguments'."
@@ -114,39 +114,39 @@ calls \"ls\" and references `eshell-last-arguments'."
114 :group 'eshell-dirs) 114 :group 'eshell-dirs)
115 115
116(defcustom eshell-pushd-tohome nil 116(defcustom eshell-pushd-tohome nil
117 "*If non-nil, make pushd with no arg behave as 'pushd ~' (like `cd'). 117 "If non-nil, make pushd with no arg behave as 'pushd ~' (like `cd').
118This mirrors the optional behavior of tcsh." 118This mirrors the optional behavior of tcsh."
119 :type 'boolean 119 :type 'boolean
120 :group 'eshell-dirs) 120 :group 'eshell-dirs)
121 121
122(defcustom eshell-pushd-dextract nil 122(defcustom eshell-pushd-dextract nil
123 "*If non-nil, make \"pushd +n\" pop the nth dir to the stack top. 123 "If non-nil, make \"pushd +n\" pop the nth dir to the stack top.
124This mirrors the optional behavior of tcsh." 124This mirrors the optional behavior of tcsh."
125 :type 'boolean 125 :type 'boolean
126 :group 'eshell-dirs) 126 :group 'eshell-dirs)
127 127
128(defcustom eshell-pushd-dunique nil 128(defcustom eshell-pushd-dunique nil
129 "*If non-nil, make pushd only add unique directories to the stack. 129 "If non-nil, make pushd only add unique directories to the stack.
130This mirrors the optional behavior of tcsh." 130This mirrors the optional behavior of tcsh."
131 :type 'boolean 131 :type 'boolean
132 :group 'eshell-dirs) 132 :group 'eshell-dirs)
133 133
134(defcustom eshell-dirtrack-verbose t 134(defcustom eshell-dirtrack-verbose t
135 "*If non-nil, show the directory stack following directory change. 135 "If non-nil, show the directory stack following directory change.
136This is effective only if directory tracking is enabled." 136This is effective only if directory tracking is enabled."
137 :type 'boolean 137 :type 'boolean
138 :group 'eshell-dirs) 138 :group 'eshell-dirs)
139 139
140(defcustom eshell-last-dir-ring-file-name 140(defcustom eshell-last-dir-ring-file-name
141 (expand-file-name "lastdir" eshell-directory-name) 141 (expand-file-name "lastdir" eshell-directory-name)
142 "*If non-nil, name of the file to read/write the last-dir-ring. 142 "If non-nil, name of the file to read/write the last-dir-ring.
143See also `eshell-read-last-dir-ring' and `eshell-write-last-dir-ring'. 143See also `eshell-read-last-dir-ring' and `eshell-write-last-dir-ring'.
144If it is nil, the last-dir-ring will not be written to disk." 144If it is nil, the last-dir-ring will not be written to disk."
145 :type 'file 145 :type 'file
146 :group 'eshell-dirs) 146 :group 'eshell-dirs)
147 147
148(defcustom eshell-last-dir-ring-size 32 148(defcustom eshell-last-dir-ring-size 32
149 "*If non-nil, the size of the directory history ring. 149 "If non-nil, the size of the directory history ring.
150This ring is added to every time `cd' or `pushd' is used. It simply 150This ring is added to every time `cd' or `pushd' is used. It simply
151stores the most recent directory locations Eshell has been in. To 151stores the most recent directory locations Eshell has been in. To
152return to the most recent entry, use 'cd -' (equivalent to 'cd -0'). 152return to the most recent entry, use 'cd -' (equivalent to 'cd -0').
@@ -167,7 +167,7 @@ thing again."
167 :group 'eshell-dirs) 167 :group 'eshell-dirs)
168 168
169(defcustom eshell-last-dir-unique t 169(defcustom eshell-last-dir-unique t
170 "*If non-nil, `eshell-last-dir-ring' contains only unique entries." 170 "If non-nil, `eshell-last-dir-ring' contains only unique entries."
171 :type 'boolean 171 :type 'boolean
172 :group 'eshell-dirs) 172 :group 'eshell-dirs)
173 173
diff --git a/lisp/eshell/em-glob.el b/lisp/eshell/em-glob.el
index d4ad3009f86..2f29f3d0aee 100644
--- a/lisp/eshell/em-glob.el
+++ b/lisp/eshell/em-glob.el
@@ -63,39 +63,39 @@ by zsh for filename generation."
63;;; User Variables: 63;;; User Variables:
64 64
65(defcustom eshell-glob-load-hook '(eshell-glob-initialize) 65(defcustom eshell-glob-load-hook '(eshell-glob-initialize)
66 "*A list of functions to run when `eshell-glob' is loaded." 66 "A list of functions to run when `eshell-glob' is loaded."
67 :type 'hook 67 :type 'hook
68 :group 'eshell-glob) 68 :group 'eshell-glob)
69 69
70(defcustom eshell-glob-include-dot-files nil 70(defcustom eshell-glob-include-dot-files nil
71 "*If non-nil, glob patterns will match files beginning with a dot." 71 "If non-nil, glob patterns will match files beginning with a dot."
72 :type 'boolean 72 :type 'boolean
73 :group 'eshell-glob) 73 :group 'eshell-glob)
74 74
75(defcustom eshell-glob-include-dot-dot t 75(defcustom eshell-glob-include-dot-dot t
76 "*If non-nil, glob patterns that match dots will match . and .." 76 "If non-nil, glob patterns that match dots will match . and .."
77 :type 'boolean 77 :type 'boolean
78 :group 'eshell-glob) 78 :group 'eshell-glob)
79 79
80(defcustom eshell-glob-case-insensitive (eshell-under-windows-p) 80(defcustom eshell-glob-case-insensitive (eshell-under-windows-p)
81 "*If non-nil, glob pattern matching will ignore case." 81 "If non-nil, glob pattern matching will ignore case."
82 :type 'boolean 82 :type 'boolean
83 :group 'eshell-glob) 83 :group 'eshell-glob)
84 84
85(defcustom eshell-glob-show-progress nil 85(defcustom eshell-glob-show-progress nil
86 "*If non-nil, display progress messages during a recursive glob. 86 "If non-nil, display progress messages during a recursive glob.
87This option slows down recursive glob processing by quite a bit." 87This option slows down recursive glob processing by quite a bit."
88 :type 'boolean 88 :type 'boolean
89 :group 'eshell-glob) 89 :group 'eshell-glob)
90 90
91(defcustom eshell-error-if-no-glob nil 91(defcustom eshell-error-if-no-glob nil
92 "*If non-nil, it is an error for a glob pattern not to match. 92 "If non-nil, it is an error for a glob pattern not to match.
93 This mimcs the behavior of zsh if non-nil, but bash if nil." 93 This mimcs the behavior of zsh if non-nil, but bash if nil."
94 :type 'boolean 94 :type 'boolean
95 :group 'eshell-glob) 95 :group 'eshell-glob)
96 96
97(defcustom eshell-glob-chars-list '(?\] ?\[ ?* ?? ?~ ?\( ?\) ?| ?# ?^) 97(defcustom eshell-glob-chars-list '(?\] ?\[ ?* ?? ?~ ?\( ?\) ?| ?# ?^)
98 "*List of additional characters used in extended globbing." 98 "List of additional characters used in extended globbing."
99 :type '(repeat character) 99 :type '(repeat character)
100 :group 'eshell-glob) 100 :group 'eshell-glob)
101 101
@@ -117,7 +117,7 @@ This option slows down recursive glob processing by quite a bit."
117 (if (eq (aref str (1+ pos)) ?*) 117 (if (eq (aref str (1+ pos)) ?*)
118 "*" "+")) (+ pos 2)) 118 "*" "+")) (+ pos 2))
119 (cons "*" (1+ pos)))))) 119 (cons "*" (1+ pos))))))
120 "*An alist for translation of extended globbing characters." 120 "An alist for translation of extended globbing characters."
121 :type '(repeat (cons character (choice regexp function))) 121 :type '(repeat (cons character (choice regexp function)))
122 :group 'eshell-glob) 122 :group 'eshell-glob)
123 123
diff --git a/lisp/eshell/em-hist.el b/lisp/eshell/em-hist.el
index 37a926f888a..1f644261337 100644
--- a/lisp/eshell/em-hist.el
+++ b/lisp/eshell/em-hist.el
@@ -72,7 +72,7 @@
72;;; User Variables: 72;;; User Variables:
73 73
74(defcustom eshell-hist-load-hook '(eshell-hist-initialize) 74(defcustom eshell-hist-load-hook '(eshell-hist-initialize)
75 "*A list of functions to call when loading `eshell-hist'." 75 "A list of functions to call when loading `eshell-hist'."
76 :type 'hook 76 :type 'hook
77 :group 'eshell-hist) 77 :group 'eshell-hist)
78 78
@@ -81,31 +81,31 @@
81 (function 81 (function
82 (lambda () 82 (lambda ()
83 (remove-hook 'kill-emacs-hook 'eshell-save-some-history)))) 83 (remove-hook 'kill-emacs-hook 'eshell-save-some-history))))
84 "*A hook that gets run when `eshell-hist' is unloaded." 84 "A hook that gets run when `eshell-hist' is unloaded."
85 :type 'hook 85 :type 'hook
86 :group 'eshell-hist) 86 :group 'eshell-hist)
87 87
88(defcustom eshell-history-file-name 88(defcustom eshell-history-file-name
89 (expand-file-name "history" eshell-directory-name) 89 (expand-file-name "history" eshell-directory-name)
90 "*If non-nil, name of the file to read/write input history. 90 "If non-nil, name of the file to read/write input history.
91See also `eshell-read-history' and `eshell-write-history'. 91See also `eshell-read-history' and `eshell-write-history'.
92If it is nil, Eshell will use the value of HISTFILE." 92If it is nil, Eshell will use the value of HISTFILE."
93 :type 'file 93 :type 'file
94 :group 'eshell-hist) 94 :group 'eshell-hist)
95 95
96(defcustom eshell-history-size 128 96(defcustom eshell-history-size 128
97 "*Size of the input history ring. If nil, use envvar HISTSIZE." 97 "Size of the input history ring. If nil, use envvar HISTSIZE."
98 :type 'integer 98 :type 'integer
99 :group 'eshell-hist) 99 :group 'eshell-hist)
100 100
101(defcustom eshell-hist-ignoredups nil 101(defcustom eshell-hist-ignoredups nil
102 "*If non-nil, don't add input matching the last on the input ring. 102 "If non-nil, don't add input matching the last on the input ring.
103This mirrors the optional behavior of bash." 103This mirrors the optional behavior of bash."
104 :type 'boolean 104 :type 'boolean
105 :group 'eshell-hist) 105 :group 'eshell-hist)
106 106
107(defcustom eshell-save-history-on-exit t 107(defcustom eshell-save-history-on-exit t
108 "*Determine if history should be automatically saved. 108 "Determine if history should be automatically saved.
109History is always preserved after sanely exiting an Eshell buffer. 109History is always preserved after sanely exiting an Eshell buffer.
110However, when Emacs is being shut down, this variable determines 110However, when Emacs is being shut down, this variable determines
111whether to prompt the user. 111whether to prompt the user.
@@ -121,7 +121,7 @@ If set to t, history will always be saved, silently."
121 (function 121 (function
122 (lambda (str) 122 (lambda (str)
123 (not (string-match "\\`\\s-*\\'" str)))) 123 (not (string-match "\\`\\s-*\\'" str))))
124 "*Predicate for filtering additions to input history. 124 "Predicate for filtering additions to input history.
125Takes one argument, the input. If non-nil, the input may be saved on 125Takes one argument, the input. If non-nil, the input may be saved on
126the input history list. Default is to save anything that isn't all 126the input history list. Default is to save anything that isn't all
127whitespace." 127whitespace."
@@ -131,7 +131,7 @@ whitespace."
131(put 'eshell-input-filter 'risky-local-variable t) 131(put 'eshell-input-filter 'risky-local-variable t)
132 132
133(defcustom eshell-hist-match-partial t 133(defcustom eshell-hist-match-partial t
134 "*If non-nil, movement through history is constrained by current input. 134 "If non-nil, movement through history is constrained by current input.
135Otherwise, typing <M-p> and <M-n> will always go to the next history 135Otherwise, typing <M-p> and <M-n> will always go to the next history
136element, regardless of any text on the command line. In that case, 136element, regardless of any text on the command line. In that case,
137<C-c M-r> and <C-c M-s> still offer that functionality." 137<C-c M-r> and <C-c M-s> still offer that functionality."
@@ -139,25 +139,25 @@ element, regardless of any text on the command line. In that case,
139 :group 'eshell-hist) 139 :group 'eshell-hist)
140 140
141(defcustom eshell-hist-move-to-end t 141(defcustom eshell-hist-move-to-end t
142 "*If non-nil, move to the end of the buffer before cycling history." 142 "If non-nil, move to the end of the buffer before cycling history."
143 :type 'boolean 143 :type 'boolean
144 :group 'eshell-hist) 144 :group 'eshell-hist)
145 145
146(defcustom eshell-hist-event-designator 146(defcustom eshell-hist-event-designator
147 "^!\\(!\\|-?[0-9]+\\|\\??[^:^$%*?]+\\??\\|#\\)" 147 "^!\\(!\\|-?[0-9]+\\|\\??[^:^$%*?]+\\??\\|#\\)"
148 "*The regexp used to identifier history event designators." 148 "The regexp used to identifier history event designators."
149 :type 'regexp 149 :type 'regexp
150 :group 'eshell-hist) 150 :group 'eshell-hist)
151 151
152(defcustom eshell-hist-word-designator 152(defcustom eshell-hist-word-designator
153 "^:?\\([0-9]+\\|[$^%*]\\)?\\(\\*\\|-[0-9]*\\|[$^%*]\\)?" 153 "^:?\\([0-9]+\\|[$^%*]\\)?\\(\\*\\|-[0-9]*\\|[$^%*]\\)?"
154 "*The regexp used to identify history word designators." 154 "The regexp used to identify history word designators."
155 :type 'regexp 155 :type 'regexp
156 :group 'eshell-hist) 156 :group 'eshell-hist)
157 157
158(defcustom eshell-hist-modifier 158(defcustom eshell-hist-modifier
159 "^\\(:\\([hretpqx&g]\\|s/\\([^/]*\\)/\\([^/]*\\)/\\)\\)*" 159 "^\\(:\\([hretpqx&g]\\|s/\\([^/]*\\)/\\([^/]*\\)/\\)\\)*"
160 "*The regexp used to identity history modifiers." 160 "The regexp used to identity history modifiers."
161 :type 'regexp 161 :type 'regexp
162 :group 'eshell-hist) 162 :group 'eshell-hist)
163 163
@@ -174,7 +174,7 @@ element, regardless of any text on the command line. In that case,
174 ([(meta ?n)] . eshell-next-matching-input-from-input) 174 ([(meta ?n)] . eshell-next-matching-input-from-input)
175 ([up] . eshell-previous-matching-input-from-input) 175 ([up] . eshell-previous-matching-input-from-input)
176 ([down] . eshell-next-matching-input-from-input)) 176 ([down] . eshell-next-matching-input-from-input))
177 "*History keys to bind differently if point is in input text." 177 "History keys to bind differently if point is in input text."
178 :type '(repeat (cons (vector :tag "Keys to bind" 178 :type '(repeat (cons (vector :tag "Keys to bind"
179 (repeat :inline t sexp)) 179 (repeat :inline t sexp))
180 (function :tag "Command"))) 180 (function :tag "Command")))
diff --git a/lisp/eshell/em-ls.el b/lisp/eshell/em-ls.el
index 1bb7bd6f77a..db2a21cd319 100644
--- a/lisp/eshell/em-ls.el
+++ b/lisp/eshell/em-ls.el
@@ -54,24 +54,24 @@ properties to colorize its output based on the setting of
54 (function 54 (function
55 (lambda () 55 (lambda ()
56 (fset 'insert-directory eshell-ls-orig-insert-directory)))) 56 (fset 'insert-directory eshell-ls-orig-insert-directory))))
57 "*When unloading `eshell-ls', restore the definition of `insert-directory'." 57 "When unloading `eshell-ls', restore the definition of `insert-directory'."
58 :type 'hook 58 :type 'hook
59 :group 'eshell-ls) 59 :group 'eshell-ls)
60 60
61(defcustom eshell-ls-initial-args nil 61(defcustom eshell-ls-initial-args nil
62 "*If non-nil, this list of args is included before any call to `ls'. 62 "If non-nil, this list of args is included before any call to `ls'.
63This is useful for enabling human-readable format (-h), for example." 63This is useful for enabling human-readable format (-h), for example."
64 :type '(repeat :tag "Arguments" string) 64 :type '(repeat :tag "Arguments" string)
65 :group 'eshell-ls) 65 :group 'eshell-ls)
66 66
67(defcustom eshell-ls-dired-initial-args nil 67(defcustom eshell-ls-dired-initial-args nil
68 "*If non-nil, args is included before any call to `ls' in Dired. 68 "If non-nil, args is included before any call to `ls' in Dired.
69This is useful for enabling human-readable format (-h), for example." 69This is useful for enabling human-readable format (-h), for example."
70 :type '(repeat :tag "Arguments" string) 70 :type '(repeat :tag "Arguments" string)
71 :group 'eshell-ls) 71 :group 'eshell-ls)
72 72
73(defcustom eshell-ls-use-in-dired nil 73(defcustom eshell-ls-use-in-dired nil
74 "*If non-nil, use `eshell-ls' to read directories in Dired." 74 "If non-nil, use `eshell-ls' to read directories in Dired."
75 :set (lambda (symbol value) 75 :set (lambda (symbol value)
76 (if value 76 (if value
77 (unless (and (boundp 'eshell-ls-use-in-dired) 77 (unless (and (boundp 'eshell-ls-use-in-dired)
@@ -86,24 +86,24 @@ This is useful for enabling human-readable format (-h), for example."
86 :group 'eshell-ls) 86 :group 'eshell-ls)
87 87
88(defcustom eshell-ls-default-blocksize 1024 88(defcustom eshell-ls-default-blocksize 1024
89 "*The default blocksize to use when display file sizes with -s." 89 "The default blocksize to use when display file sizes with -s."
90 :type 'integer 90 :type 'integer
91 :group 'eshell-ls) 91 :group 'eshell-ls)
92 92
93(defcustom eshell-ls-exclude-regexp nil 93(defcustom eshell-ls-exclude-regexp nil
94 "*Unless -a is specified, files matching this regexp will not be shown." 94 "Unless -a is specified, files matching this regexp will not be shown."
95 :type '(choice regexp (const nil)) 95 :type '(choice regexp (const nil))
96 :group 'eshell-ls) 96 :group 'eshell-ls)
97 97
98(defcustom eshell-ls-exclude-hidden t 98(defcustom eshell-ls-exclude-hidden t
99 "*Unless -a is specified, files beginning with . will not be shown. 99 "Unless -a is specified, files beginning with . will not be shown.
100Using this boolean, instead of `eshell-ls-exclude-regexp', is both 100Using this boolean, instead of `eshell-ls-exclude-regexp', is both
101faster and conserves more memory." 101faster and conserves more memory."
102 :type 'boolean 102 :type 'boolean
103 :group 'eshell-ls) 103 :group 'eshell-ls)
104 104
105(defcustom eshell-ls-use-colors t 105(defcustom eshell-ls-use-colors t
106 "*If non-nil, use colors in file listings." 106 "If non-nil, use colors in file listings."
107 :type 'boolean 107 :type 'boolean
108 :group 'eshell-ls) 108 :group 'eshell-ls)
109 109
@@ -111,7 +111,7 @@ faster and conserves more memory."
111 '((((class color) (background light)) (:foreground "Blue" :weight bold)) 111 '((((class color) (background light)) (:foreground "Blue" :weight bold))
112 (((class color) (background dark)) (:foreground "SkyBlue" :weight bold)) 112 (((class color) (background dark)) (:foreground "SkyBlue" :weight bold))
113 (t (:weight bold))) 113 (t (:weight bold)))
114 "*The face used for highlight directories." 114 "The face used for highlight directories."
115 :group 'eshell-ls) 115 :group 'eshell-ls)
116(define-obsolete-face-alias 'eshell-ls-directory-face 116(define-obsolete-face-alias 'eshell-ls-directory-face
117 'eshell-ls-directory "22.1") 117 'eshell-ls-directory "22.1")
@@ -119,14 +119,14 @@ faster and conserves more memory."
119(defface eshell-ls-symlink 119(defface eshell-ls-symlink
120 '((((class color) (background light)) (:foreground "Dark Cyan" :weight bold)) 120 '((((class color) (background light)) (:foreground "Dark Cyan" :weight bold))
121 (((class color) (background dark)) (:foreground "Cyan" :weight bold))) 121 (((class color) (background dark)) (:foreground "Cyan" :weight bold)))
122 "*The face used for highlight symbolic links." 122 "The face used for highlight symbolic links."
123 :group 'eshell-ls) 123 :group 'eshell-ls)
124(define-obsolete-face-alias 'eshell-ls-symlink-face 'eshell-ls-symlink "22.1") 124(define-obsolete-face-alias 'eshell-ls-symlink-face 'eshell-ls-symlink "22.1")
125 125
126(defface eshell-ls-executable 126(defface eshell-ls-executable
127 '((((class color) (background light)) (:foreground "ForestGreen" :weight bold)) 127 '((((class color) (background light)) (:foreground "ForestGreen" :weight bold))
128 (((class color) (background dark)) (:foreground "Green" :weight bold))) 128 (((class color) (background dark)) (:foreground "Green" :weight bold)))
129 "*The face used for highlighting executables (not directories, though)." 129 "The face used for highlighting executables (not directories, though)."
130 :group 'eshell-ls) 130 :group 'eshell-ls)
131(define-obsolete-face-alias 'eshell-ls-executable-face 131(define-obsolete-face-alias 'eshell-ls-executable-face
132 'eshell-ls-executable "22.1") 132 'eshell-ls-executable "22.1")
@@ -134,14 +134,14 @@ faster and conserves more memory."
134(defface eshell-ls-readonly 134(defface eshell-ls-readonly
135 '((((class color) (background light)) (:foreground "Brown")) 135 '((((class color) (background light)) (:foreground "Brown"))
136 (((class color) (background dark)) (:foreground "Pink"))) 136 (((class color) (background dark)) (:foreground "Pink")))
137 "*The face used for highlighting read-only files." 137 "The face used for highlighting read-only files."
138 :group 'eshell-ls) 138 :group 'eshell-ls)
139(define-obsolete-face-alias 'eshell-ls-readonly-face 'eshell-ls-readonly "22.1") 139(define-obsolete-face-alias 'eshell-ls-readonly-face 'eshell-ls-readonly "22.1")
140 140
141(defface eshell-ls-unreadable 141(defface eshell-ls-unreadable
142 '((((class color) (background light)) (:foreground "Grey30")) 142 '((((class color) (background light)) (:foreground "Grey30"))
143 (((class color) (background dark)) (:foreground "DarkGrey"))) 143 (((class color) (background dark)) (:foreground "DarkGrey")))
144 "*The face used for highlighting unreadable files." 144 "The face used for highlighting unreadable files."
145 :group 'eshell-ls) 145 :group 'eshell-ls)
146(define-obsolete-face-alias 'eshell-ls-unreadable-face 146(define-obsolete-face-alias 'eshell-ls-unreadable-face
147 'eshell-ls-unreadable "22.1") 147 'eshell-ls-unreadable "22.1")
@@ -149,21 +149,21 @@ faster and conserves more memory."
149(defface eshell-ls-special 149(defface eshell-ls-special
150 '((((class color) (background light)) (:foreground "Magenta" :weight bold)) 150 '((((class color) (background light)) (:foreground "Magenta" :weight bold))
151 (((class color) (background dark)) (:foreground "Magenta" :weight bold))) 151 (((class color) (background dark)) (:foreground "Magenta" :weight bold)))
152 "*The face used for highlighting non-regular files." 152 "The face used for highlighting non-regular files."
153 :group 'eshell-ls) 153 :group 'eshell-ls)
154(define-obsolete-face-alias 'eshell-ls-special-face 'eshell-ls-special "22.1") 154(define-obsolete-face-alias 'eshell-ls-special-face 'eshell-ls-special "22.1")
155 155
156(defface eshell-ls-missing 156(defface eshell-ls-missing
157 '((((class color) (background light)) (:foreground "Red" :weight bold)) 157 '((((class color) (background light)) (:foreground "Red" :weight bold))
158 (((class color) (background dark)) (:foreground "Red" :weight bold))) 158 (((class color) (background dark)) (:foreground "Red" :weight bold)))
159 "*The face used for highlighting non-existent file names." 159 "The face used for highlighting non-existent file names."
160 :group 'eshell-ls) 160 :group 'eshell-ls)
161(define-obsolete-face-alias 'eshell-ls-missing-face 'eshell-ls-missing "22.1") 161(define-obsolete-face-alias 'eshell-ls-missing-face 'eshell-ls-missing "22.1")
162 162
163(defcustom eshell-ls-archive-regexp 163(defcustom eshell-ls-archive-regexp
164 (concat "\\.\\(t\\(a[rz]\\|gz\\)\\|arj\\|lzh\\|" 164 (concat "\\.\\(t\\(a[rz]\\|gz\\)\\|arj\\|lzh\\|"
165 "zip\\|[zZ]\\|gz\\|bz2\\|xz\\|deb\\|rpm\\)\\'") 165 "zip\\|[zZ]\\|gz\\|bz2\\|xz\\|deb\\|rpm\\)\\'")
166 "*A regular expression that matches names of file archives. 166 "A regular expression that matches names of file archives.
167This typically includes both traditional archives and compressed 167This typically includes both traditional archives and compressed
168files." 168files."
169 :version "24.1" ; added xz 169 :version "24.1" ; added xz
@@ -173,26 +173,26 @@ files."
173(defface eshell-ls-archive 173(defface eshell-ls-archive
174 '((((class color) (background light)) (:foreground "Orchid" :weight bold)) 174 '((((class color) (background light)) (:foreground "Orchid" :weight bold))
175 (((class color) (background dark)) (:foreground "Orchid" :weight bold))) 175 (((class color) (background dark)) (:foreground "Orchid" :weight bold)))
176 "*The face used for highlighting archived and compressed file names." 176 "The face used for highlighting archived and compressed file names."
177 :group 'eshell-ls) 177 :group 'eshell-ls)
178(define-obsolete-face-alias 'eshell-ls-archive-face 'eshell-ls-archive "22.1") 178(define-obsolete-face-alias 'eshell-ls-archive-face 'eshell-ls-archive "22.1")
179 179
180(defcustom eshell-ls-backup-regexp 180(defcustom eshell-ls-backup-regexp
181 "\\(\\`\\.?#\\|\\(\\.bak\\|~\\)\\'\\)" 181 "\\(\\`\\.?#\\|\\(\\.bak\\|~\\)\\'\\)"
182 "*A regular expression that matches names of backup files." 182 "A regular expression that matches names of backup files."
183 :type 'regexp 183 :type 'regexp
184 :group 'eshell-ls) 184 :group 'eshell-ls)
185 185
186(defface eshell-ls-backup 186(defface eshell-ls-backup
187 '((((class color) (background light)) (:foreground "OrangeRed")) 187 '((((class color) (background light)) (:foreground "OrangeRed"))
188 (((class color) (background dark)) (:foreground "LightSalmon"))) 188 (((class color) (background dark)) (:foreground "LightSalmon")))
189 "*The face used for highlighting backup file names." 189 "The face used for highlighting backup file names."
190 :group 'eshell-ls) 190 :group 'eshell-ls)
191(define-obsolete-face-alias 'eshell-ls-backup-face 'eshell-ls-backup "22.1") 191(define-obsolete-face-alias 'eshell-ls-backup-face 'eshell-ls-backup "22.1")
192 192
193(defcustom eshell-ls-product-regexp 193(defcustom eshell-ls-product-regexp
194 "\\.\\(elc\\|o\\(bj\\)?\\|a\\|lib\\|res\\)\\'" 194 "\\.\\(elc\\|o\\(bj\\)?\\|a\\|lib\\|res\\)\\'"
195 "*A regular expression that matches names of product files. 195 "A regular expression that matches names of product files.
196Products are files that get generated from a source file, and hence 196Products are files that get generated from a source file, and hence
197ought to be recreatable if they are deleted." 197ought to be recreatable if they are deleted."
198 :type 'regexp 198 :type 'regexp
@@ -201,13 +201,13 @@ ought to be recreatable if they are deleted."
201(defface eshell-ls-product 201(defface eshell-ls-product
202 '((((class color) (background light)) (:foreground "OrangeRed")) 202 '((((class color) (background light)) (:foreground "OrangeRed"))
203 (((class color) (background dark)) (:foreground "LightSalmon"))) 203 (((class color) (background dark)) (:foreground "LightSalmon")))
204 "*The face used for highlighting files that are build products." 204 "The face used for highlighting files that are build products."
205 :group 'eshell-ls) 205 :group 'eshell-ls)
206(define-obsolete-face-alias 'eshell-ls-product-face 'eshell-ls-product "22.1") 206(define-obsolete-face-alias 'eshell-ls-product-face 'eshell-ls-product "22.1")
207 207
208(defcustom eshell-ls-clutter-regexp 208(defcustom eshell-ls-clutter-regexp
209 "\\(^texput\\.log\\|^core\\)\\'" 209 "\\(^texput\\.log\\|^core\\)\\'"
210 "*A regular expression that matches names of junk files. 210 "A regular expression that matches names of junk files.
211These are mainly files that get created for various reasons, but don't 211These are mainly files that get created for various reasons, but don't
212really need to stick around for very long." 212really need to stick around for very long."
213 :type 'regexp 213 :type 'regexp
@@ -216,7 +216,7 @@ really need to stick around for very long."
216(defface eshell-ls-clutter 216(defface eshell-ls-clutter
217 '((((class color) (background light)) (:foreground "OrangeRed" :weight bold)) 217 '((((class color) (background light)) (:foreground "OrangeRed" :weight bold))
218 (((class color) (background dark)) (:foreground "OrangeRed" :weight bold))) 218 (((class color) (background dark)) (:foreground "OrangeRed" :weight bold)))
219 "*The face used for highlighting junk file names." 219 "The face used for highlighting junk file names."
220 :group 'eshell-ls) 220 :group 'eshell-ls)
221(define-obsolete-face-alias 'eshell-ls-clutter-face 'eshell-ls-clutter "22.1") 221(define-obsolete-face-alias 'eshell-ls-clutter-face 'eshell-ls-clutter "22.1")
222 222
@@ -250,7 +250,7 @@ calling FUNC with FILE as an argument."
250 (,(eval func) ,file))))) 250 (,(eval func) ,file)))))
251 251
252(defcustom eshell-ls-highlight-alist nil 252(defcustom eshell-ls-highlight-alist nil
253 "*This alist correlates test functions to color. 253 "This alist correlates test functions to color.
254The format of the members of this alist is 254The format of the members of this alist is
255 255
256 (TEST-SEXP . FACE) 256 (TEST-SEXP . FACE)
diff --git a/lisp/eshell/em-pred.el b/lisp/eshell/em-pred.el
index aee1b5437de..15a3deea30c 100644
--- a/lisp/eshell/em-pred.el
+++ b/lisp/eshell/em-pred.el
@@ -61,7 +61,7 @@ ordinary strings."
61;;; User Variables: 61;;; User Variables:
62 62
63(defcustom eshell-pred-load-hook '(eshell-pred-initialize) 63(defcustom eshell-pred-load-hook '(eshell-pred-initialize)
64 "*A list of functions to run when `eshell-pred' is loaded." 64 "A list of functions to run when `eshell-pred' is loaded."
65 :type 'hook 65 :type 'hook
66 :group 'eshell-pred) 66 :group 'eshell-pred)
67 67
@@ -101,7 +101,7 @@ ordinary strings."
101 (?m . (eshell-pred-file-time ?m "modification" 5)) 101 (?m . (eshell-pred-file-time ?m "modification" 5))
102 (?c . (eshell-pred-file-time ?c "change" 6)) 102 (?c . (eshell-pred-file-time ?c "change" 6))
103 (?L . (eshell-pred-file-size))) 103 (?L . (eshell-pred-file-size)))
104 "*A list of predicates than can be applied to a globbing pattern. 104 "A list of predicates than can be applied to a globbing pattern.
105The format of each entry is 105The format of each entry is
106 106
107 (CHAR . PREDICATE-FUNC-SEXP)" 107 (CHAR . PREDICATE-FUNC-SEXP)"
@@ -150,7 +150,7 @@ The format of each entry is
150 (eshell-pred-substitute t) 150 (eshell-pred-substitute t)
151 (error "`g' modifier cannot be used alone")))) 151 (error "`g' modifier cannot be used alone"))))
152 (?s . (eshell-pred-substitute))) 152 (?s . (eshell-pred-substitute)))
153 "*A list of modifiers than can be applied to an argument expansion. 153 "A list of modifiers than can be applied to an argument expansion.
154The format of each entry is 154The format of each entry is
155 155
156 (CHAR ENTRYWISE-P MODIFIER-FUNC-SEXP)" 156 (CHAR ENTRYWISE-P MODIFIER-FUNC-SEXP)"
diff --git a/lisp/eshell/em-prompt.el b/lisp/eshell/em-prompt.el
index 6e8abd660d1..29e1ace26b1 100644
--- a/lisp/eshell/em-prompt.el
+++ b/lisp/eshell/em-prompt.el
@@ -39,7 +39,7 @@ as is common with most shells."
39;;; User Variables: 39;;; User Variables:
40 40
41(defcustom eshell-prompt-load-hook '(eshell-prompt-initialize) 41(defcustom eshell-prompt-load-hook '(eshell-prompt-initialize)
42 "*A list of functions to call when loading `eshell-prompt'." 42 "A list of functions to call when loading `eshell-prompt'."
43 :type 'hook 43 :type 'hook
44 :group 'eshell-prompt) 44 :group 'eshell-prompt)
45 45
@@ -55,7 +55,7 @@ prompt."
55 :group 'eshell-prompt) 55 :group 'eshell-prompt)
56 56
57(defcustom eshell-prompt-regexp "^[^#$\n]* [#$] " 57(defcustom eshell-prompt-regexp "^[^#$\n]* [#$] "
58 "*A regexp which fully matches your eshell prompt. 58 "A regexp which fully matches your eshell prompt.
59This setting is important, since it affects how eshell will interpret 59This setting is important, since it affects how eshell will interpret
60the lines that are passed to it. 60the lines that are passed to it.
61If this variable is changed, all Eshell buffers must be exited and 61If this variable is changed, all Eshell buffers must be exited and
@@ -64,7 +64,7 @@ re-entered for it to take effect."
64 :group 'eshell-prompt) 64 :group 'eshell-prompt)
65 65
66(defcustom eshell-highlight-prompt t 66(defcustom eshell-highlight-prompt t
67 "*If non-nil, Eshell should highlight the prompt." 67 "If non-nil, Eshell should highlight the prompt."
68 :type 'boolean 68 :type 'boolean
69 :group 'eshell-prompt) 69 :group 'eshell-prompt)
70 70
@@ -72,20 +72,20 @@ re-entered for it to take effect."
72 '((((class color) (background light)) (:foreground "Red" :bold t)) 72 '((((class color) (background light)) (:foreground "Red" :bold t))
73 (((class color) (background dark)) (:foreground "Pink" :bold t)) 73 (((class color) (background dark)) (:foreground "Pink" :bold t))
74 (t (:bold t))) 74 (t (:bold t)))
75 "*The face used to highlight prompt strings. 75 "The face used to highlight prompt strings.
76For highlighting other kinds of strings -- similar to shell mode's 76For highlighting other kinds of strings -- similar to shell mode's
77behavior -- simply use an output filer which changes text properties." 77behavior -- simply use an output filer which changes text properties."
78 :group 'eshell-prompt) 78 :group 'eshell-prompt)
79(define-obsolete-face-alias 'eshell-prompt-face 'eshell-prompt "22.1") 79(define-obsolete-face-alias 'eshell-prompt-face 'eshell-prompt "22.1")
80 80
81(defcustom eshell-before-prompt-hook nil 81(defcustom eshell-before-prompt-hook nil
82 "*A list of functions to call before outputting the prompt." 82 "A list of functions to call before outputting the prompt."
83 :type 'hook 83 :type 'hook
84 :options '(eshell-begin-on-new-line) 84 :options '(eshell-begin-on-new-line)
85 :group 'eshell-prompt) 85 :group 'eshell-prompt)
86 86
87(defcustom eshell-after-prompt-hook nil 87(defcustom eshell-after-prompt-hook nil
88 "*A list of functions to call after outputting the prompt. 88 "A list of functions to call after outputting the prompt.
89Note that if `eshell-scroll-show-maximum-output' is non-nil, then 89Note that if `eshell-scroll-show-maximum-output' is non-nil, then
90setting `eshell-show-maximum-output' here won't do much. It depends 90setting `eshell-show-maximum-output' here won't do much. It depends
91on whether the user wants the resizing to happen while output is 91on whether the user wants the resizing to happen while output is
diff --git a/lisp/eshell/em-rebind.el b/lisp/eshell/em-rebind.el
index ef60cf793a0..9b208d64803 100644
--- a/lisp/eshell/em-rebind.el
+++ b/lisp/eshell/em-rebind.el
@@ -43,7 +43,7 @@ the behavior of normal shells while the user editing new input text."
43;;; User Variables: 43;;; User Variables:
44 44
45(defcustom eshell-rebind-load-hook '(eshell-rebind-initialize) 45(defcustom eshell-rebind-load-hook '(eshell-rebind-initialize)
46 "*A list of functions to call when loading `eshell-rebind'." 46 "A list of functions to call when loading `eshell-rebind'."
47 :type 'hook 47 :type 'hook
48 :group 'eshell-rebind) 48 :group 'eshell-rebind)
49 49
@@ -55,14 +55,14 @@ the behavior of normal shells while the user editing new input text."
55 ([delete] . eshell-delete-backward-char) 55 ([delete] . eshell-delete-backward-char)
56 ([(control ?w)] . backward-kill-word) 56 ([(control ?w)] . backward-kill-word)
57 ([(control ?u)] . eshell-kill-input)) 57 ([(control ?u)] . eshell-kill-input))
58 "*Bind some keys differently if point is in input text." 58 "Bind some keys differently if point is in input text."
59 :type '(repeat (cons (vector :tag "Keys to bind" 59 :type '(repeat (cons (vector :tag "Keys to bind"
60 (repeat :inline t sexp)) 60 (repeat :inline t sexp))
61 (function :tag "Command"))) 61 (function :tag "Command")))
62 :group 'eshell-rebind) 62 :group 'eshell-rebind)
63 63
64(defcustom eshell-confine-point-to-input t 64(defcustom eshell-confine-point-to-input t
65 "*If non-nil, do not allow the point to leave the current input. 65 "If non-nil, do not allow the point to leave the current input.
66This is more difficult to do nicely in Emacs than one might think. 66This is more difficult to do nicely in Emacs than one might think.
67Basically, the `point-left' attribute is added to the input text, and 67Basically, the `point-left' attribute is added to the input text, and
68a function is placed on that hook to take the point back to 68a function is placed on that hook to take the point back to
@@ -77,13 +77,13 @@ people will left the point alone in the Eshell buffer. Sigh."
77 :group 'eshell-rebind) 77 :group 'eshell-rebind)
78 78
79(defcustom eshell-error-if-move-away t 79(defcustom eshell-error-if-move-away t
80 "*If non-nil, consider it an error to try to move outside current input. 80 "If non-nil, consider it an error to try to move outside current input.
81This is default behavior of shells like bash." 81This is default behavior of shells like bash."
82 :type 'boolean 82 :type 'boolean
83 :group 'eshell-rebind) 83 :group 'eshell-rebind)
84 84
85(defcustom eshell-remap-previous-input t 85(defcustom eshell-remap-previous-input t
86 "*If non-nil, remap input keybindings on previous prompts as well." 86 "If non-nil, remap input keybindings on previous prompts as well."
87 :type 'boolean 87 :type 'boolean
88 :group 'eshell-rebind) 88 :group 'eshell-rebind)
89 89
@@ -132,7 +132,7 @@ This is default behavior of shells like bash."
132 forward-visible-line 132 forward-visible-line
133 forward-comment 133 forward-comment
134 forward-thing) 134 forward-thing)
135 "*A list of commands that cannot leave the input area." 135 "A list of commands that cannot leave the input area."
136 :type '(repeat function) 136 :type '(repeat function)
137 :group 'eshell-rebind) 137 :group 'eshell-rebind)
138 138
diff --git a/lisp/eshell/em-script.el b/lisp/eshell/em-script.el
index 0371ee86b6d..183faa1dd77 100644
--- a/lisp/eshell/em-script.el
+++ b/lisp/eshell/em-script.el
@@ -36,19 +36,19 @@ commands, as a script file."
36;;; User Variables: 36;;; User Variables:
37 37
38(defcustom eshell-script-load-hook '(eshell-script-initialize) 38(defcustom eshell-script-load-hook '(eshell-script-initialize)
39 "*A list of functions to call when loading `eshell-script'." 39 "A list of functions to call when loading `eshell-script'."
40 :type 'hook 40 :type 'hook
41 :group 'eshell-script) 41 :group 'eshell-script)
42 42
43(defcustom eshell-login-script (expand-file-name "login" eshell-directory-name) 43(defcustom eshell-login-script (expand-file-name "login" eshell-directory-name)
44 "*If non-nil, a file to invoke when starting up Eshell interactively. 44 "If non-nil, a file to invoke when starting up Eshell interactively.
45This file should be a file containing Eshell commands, where comment 45This file should be a file containing Eshell commands, where comment
46lines begin with '#'." 46lines begin with '#'."
47 :type 'file 47 :type 'file
48 :group 'eshell-script) 48 :group 'eshell-script)
49 49
50(defcustom eshell-rc-script (expand-file-name "profile" eshell-directory-name) 50(defcustom eshell-rc-script (expand-file-name "profile" eshell-directory-name)
51 "*If non-nil, a file to invoke whenever Eshell is started. 51 "If non-nil, a file to invoke whenever Eshell is started.
52This includes when running `eshell-command'." 52This includes when running `eshell-command'."
53 :type 'file 53 :type 'file
54 :group 'eshell-script) 54 :group 'eshell-script)
diff --git a/lisp/eshell/em-smart.el b/lisp/eshell/em-smart.el
index c9be839e12b..afe3cf826b1 100644
--- a/lisp/eshell/em-smart.el
+++ b/lisp/eshell/em-smart.el
@@ -86,7 +86,7 @@ it to get a real sense of how it works."
86;;; User Variables: 86;;; User Variables:
87 87
88(defcustom eshell-smart-load-hook '(eshell-smart-initialize) 88(defcustom eshell-smart-load-hook '(eshell-smart-initialize)
89 "*A list of functions to call when loading `eshell-smart'." 89 "A list of functions to call when loading `eshell-smart'."
90 :type 'hook 90 :type 'hook
91 :group 'eshell-smart) 91 :group 'eshell-smart)
92 92
@@ -96,12 +96,12 @@ it to get a real sense of how it works."
96 (lambda () 96 (lambda ()
97 (remove-hook 'window-configuration-change-hook 97 (remove-hook 'window-configuration-change-hook
98 'eshell-refresh-windows)))) 98 'eshell-refresh-windows))))
99 "*A hook that gets run when `eshell-smart' is unloaded." 99 "A hook that gets run when `eshell-smart' is unloaded."
100 :type 'hook 100 :type 'hook
101 :group 'eshell-smart) 101 :group 'eshell-smart)
102 102
103(defcustom eshell-review-quick-commands nil 103(defcustom eshell-review-quick-commands nil
104 "*If t, always review commands. 104 "If t, always review commands.
105Reviewing means keeping point on the text of the command that was just 105Reviewing means keeping point on the text of the command that was just
106invoked, to allow corrections to be made easily. 106invoked, to allow corrections to be made easily.
107 107
@@ -124,12 +124,12 @@ only if that output can be presented in its entirely in the Eshell window."
124 yank-pop 124 yank-pop
125 yank-rectangle 125 yank-rectangle
126 yank) 126 yank)
127 "*A list of commands which cause Eshell to jump to the end of buffer." 127 "A list of commands which cause Eshell to jump to the end of buffer."
128 :type '(repeat function) 128 :type '(repeat function)
129 :group 'eshell-smart) 129 :group 'eshell-smart)
130 130
131(defcustom eshell-smart-space-goes-to-end t 131(defcustom eshell-smart-space-goes-to-end t
132 "*If non-nil, space will go to end of buffer when point-max is visible. 132 "If non-nil, space will go to end of buffer when point-max is visible.
133That is, if a command is running and the user presses SPACE at a time 133That is, if a command is running and the user presses SPACE at a time
134when the end of the buffer is visible, point will go to the end of the 134when the end of the buffer is visible, point will go to the end of the
135buffer and smart-display will be turned off (that is, subsequently 135buffer and smart-display will be turned off (that is, subsequently
@@ -148,7 +148,7 @@ buffer using \\[end-of-buffer]."
148 :group 'eshell-smart) 148 :group 'eshell-smart)
149 149
150(defcustom eshell-where-to-jump 'begin 150(defcustom eshell-where-to-jump 'begin
151 "*This variable indicates where point should jump to after a command. 151 "This variable indicates where point should jump to after a command.
152The options are `begin', `after' or `end'." 152The options are `begin', `after' or `end'."
153 :type '(radio (const :tag "Beginning of command" begin) 153 :type '(radio (const :tag "Beginning of command" begin)
154 (const :tag "After command word" after) 154 (const :tag "After command word" after)
diff --git a/lisp/eshell/em-term.el b/lisp/eshell/em-term.el
index 826e7ec0d05..bd27d9f262e 100644
--- a/lisp/eshell/em-term.el
+++ b/lisp/eshell/em-term.el
@@ -48,7 +48,7 @@ which commands are considered visual in nature."
48;;; User Variables: 48;;; User Variables:
49 49
50(defcustom eshell-term-load-hook '(eshell-term-initialize) 50(defcustom eshell-term-load-hook '(eshell-term-initialize)
51 "*A list of functions to call when loading `eshell-term'." 51 "A list of functions to call when loading `eshell-term'."
52 :type 'hook 52 :type 'hook
53 :group 'eshell-term) 53 :group 'eshell-term)
54 54
@@ -58,19 +58,19 @@ which commands are considered visual in nature."
58 "less" "more" ; M-x view-file 58 "less" "more" ; M-x view-file
59 "lynx" "ncftp" ; w3.el, ange-ftp 59 "lynx" "ncftp" ; w3.el, ange-ftp
60 "pine" "tin" "trn" "elm") ; GNUS!! 60 "pine" "tin" "trn" "elm") ; GNUS!!
61 "*A list of commands that present their output in a visual fashion." 61 "A list of commands that present their output in a visual fashion."
62 :type '(repeat string) 62 :type '(repeat string)
63 :group 'eshell-term) 63 :group 'eshell-term)
64 64
65(defcustom eshell-term-name "eterm" 65(defcustom eshell-term-name "eterm"
66 "*Name to use for the TERM variable when running visual commands. 66 "Name to use for the TERM variable when running visual commands.
67See `term-term-name' in term.el for more information on how this is 67See `term-term-name' in term.el for more information on how this is
68used." 68used."
69 :type 'string 69 :type 'string
70 :group 'eshell-term) 70 :group 'eshell-term)
71 71
72(defcustom eshell-escape-control-x t 72(defcustom eshell-escape-control-x t
73 "*If non-nil, allow <C-x> to be handled by Emacs key in visual buffers. 73 "If non-nil, allow <C-x> to be handled by Emacs key in visual buffers.
74See the variable `eshell-visual-commands'. If this variable is set to 74See the variable `eshell-visual-commands'. If this variable is set to
75nil, <C-x> will send that control character to the invoked process." 75nil, <C-x> will send that control character to the invoked process."
76 :type 'boolean 76 :type 'boolean
diff --git a/lisp/eshell/em-unix.el b/lisp/eshell/em-unix.el
index 6ceb591e131..7d0ff22ceb6 100644
--- a/lisp/eshell/em-unix.el
+++ b/lisp/eshell/em-unix.el
@@ -55,84 +55,84 @@ by name)."
55 :group 'eshell-module) 55 :group 'eshell-module)
56 56
57(defcustom eshell-unix-load-hook '(eshell-unix-initialize) 57(defcustom eshell-unix-load-hook '(eshell-unix-initialize)
58 "*A list of functions to run when `eshell-unix' is loaded." 58 "A list of functions to run when `eshell-unix' is loaded."
59 :type 'hook 59 :type 'hook
60 :group 'eshell-unix) 60 :group 'eshell-unix)
61 61
62(defcustom eshell-plain-grep-behavior nil 62(defcustom eshell-plain-grep-behavior nil
63 "*If non-nil, standalone \"grep\" commands will behave normally. 63 "If non-nil, standalone \"grep\" commands will behave normally.
64Standalone in this context means not redirected, and not on the 64Standalone in this context means not redirected, and not on the
65receiving side of a command pipeline." 65receiving side of a command pipeline."
66 :type 'boolean 66 :type 'boolean
67 :group 'eshell-unix) 67 :group 'eshell-unix)
68 68
69(defcustom eshell-no-grep-available (not (eshell-search-path "grep")) 69(defcustom eshell-no-grep-available (not (eshell-search-path "grep"))
70 "*If non-nil, no grep is available on the current machine." 70 "If non-nil, no grep is available on the current machine."
71 :type 'boolean 71 :type 'boolean
72 :group 'eshell-unix) 72 :group 'eshell-unix)
73 73
74(defcustom eshell-plain-diff-behavior nil 74(defcustom eshell-plain-diff-behavior nil
75 "*If non-nil, standalone \"diff\" commands will behave normally. 75 "If non-nil, standalone \"diff\" commands will behave normally.
76Standalone in this context means not redirected, and not on the 76Standalone in this context means not redirected, and not on the
77receiving side of a command pipeline." 77receiving side of a command pipeline."
78 :type 'boolean 78 :type 'boolean
79 :group 'eshell-unix) 79 :group 'eshell-unix)
80 80
81(defcustom eshell-plain-locate-behavior (featurep 'xemacs) 81(defcustom eshell-plain-locate-behavior (featurep 'xemacs)
82 "*If non-nil, standalone \"locate\" commands will behave normally. 82 "If non-nil, standalone \"locate\" commands will behave normally.
83Standalone in this context means not redirected, and not on the 83Standalone in this context means not redirected, and not on the
84receiving side of a command pipeline." 84receiving side of a command pipeline."
85 :type 'boolean 85 :type 'boolean
86 :group 'eshell-unix) 86 :group 'eshell-unix)
87 87
88(defcustom eshell-rm-removes-directories nil 88(defcustom eshell-rm-removes-directories nil
89 "*If non-nil, `rm' will remove directory entries. 89 "If non-nil, `rm' will remove directory entries.
90Otherwise, `rmdir' is required." 90Otherwise, `rmdir' is required."
91 :type 'boolean 91 :type 'boolean
92 :group 'eshell-unix) 92 :group 'eshell-unix)
93 93
94(defcustom eshell-rm-interactive-query (= (user-uid) 0) 94(defcustom eshell-rm-interactive-query (= (user-uid) 0)
95 "*If non-nil, `rm' will query before removing anything." 95 "If non-nil, `rm' will query before removing anything."
96 :type 'boolean 96 :type 'boolean
97 :group 'eshell-unix) 97 :group 'eshell-unix)
98 98
99(defcustom eshell-mv-interactive-query (= (user-uid) 0) 99(defcustom eshell-mv-interactive-query (= (user-uid) 0)
100 "*If non-nil, `mv' will query before overwriting anything." 100 "If non-nil, `mv' will query before overwriting anything."
101 :type 'boolean 101 :type 'boolean
102 :group 'eshell-unix) 102 :group 'eshell-unix)
103 103
104(defcustom eshell-mv-overwrite-files t 104(defcustom eshell-mv-overwrite-files t
105 "*If non-nil, `mv' will overwrite files without warning." 105 "If non-nil, `mv' will overwrite files without warning."
106 :type 'boolean 106 :type 'boolean
107 :group 'eshell-unix) 107 :group 'eshell-unix)
108 108
109(defcustom eshell-cp-interactive-query (= (user-uid) 0) 109(defcustom eshell-cp-interactive-query (= (user-uid) 0)
110 "*If non-nil, `cp' will query before overwriting anything." 110 "If non-nil, `cp' will query before overwriting anything."
111 :type 'boolean 111 :type 'boolean
112 :group 'eshell-unix) 112 :group 'eshell-unix)
113 113
114(defcustom eshell-cp-overwrite-files t 114(defcustom eshell-cp-overwrite-files t
115 "*If non-nil, `cp' will overwrite files without warning." 115 "If non-nil, `cp' will overwrite files without warning."
116 :type 'boolean 116 :type 'boolean
117 :group 'eshell-unix) 117 :group 'eshell-unix)
118 118
119(defcustom eshell-ln-interactive-query (= (user-uid) 0) 119(defcustom eshell-ln-interactive-query (= (user-uid) 0)
120 "*If non-nil, `ln' will query before overwriting anything." 120 "If non-nil, `ln' will query before overwriting anything."
121 :type 'boolean 121 :type 'boolean
122 :group 'eshell-unix) 122 :group 'eshell-unix)
123 123
124(defcustom eshell-ln-overwrite-files nil 124(defcustom eshell-ln-overwrite-files nil
125 "*If non-nil, `ln' will overwrite files without warning." 125 "If non-nil, `ln' will overwrite files without warning."
126 :type 'boolean 126 :type 'boolean
127 :group 'eshell-unix) 127 :group 'eshell-unix)
128 128
129(defcustom eshell-default-target-is-dot nil 129(defcustom eshell-default-target-is-dot nil
130 "*If non-nil, the default destination for cp, mv or ln is `.'." 130 "If non-nil, the default destination for cp, mv or ln is `.'."
131 :type 'boolean 131 :type 'boolean
132 :group 'eshell-unix) 132 :group 'eshell-unix)
133 133
134(defcustom eshell-du-prefer-over-ange nil 134(defcustom eshell-du-prefer-over-ange nil
135 "*Use Eshell's du in ange-ftp remote directories. 135 "Use Eshell's du in ange-ftp remote directories.
136Otherwise, Emacs will attempt to use rsh to invoke du on the remote machine." 136Otherwise, Emacs will attempt to use rsh to invoke du on the remote machine."
137 :type 'boolean 137 :type 'boolean
138 :group 'eshell-unix) 138 :group 'eshell-unix)
diff --git a/lisp/eshell/esh-cmd.el b/lisp/eshell/esh-cmd.el
index ed335ab5fd4..0dc1cb26fa9 100644
--- a/lisp/eshell/esh-cmd.el
+++ b/lisp/eshell/esh-cmd.el
@@ -122,28 +122,28 @@ however."
122 :group 'eshell) 122 :group 'eshell)
123 123
124(defcustom eshell-prefer-lisp-functions nil 124(defcustom eshell-prefer-lisp-functions nil
125 "*If non-nil, prefer Lisp functions to external commands." 125 "If non-nil, prefer Lisp functions to external commands."
126 :type 'boolean 126 :type 'boolean
127 :group 'eshell-cmd) 127 :group 'eshell-cmd)
128 128
129(defcustom eshell-lisp-regexp "\\([(`]\\|#'\\)" 129(defcustom eshell-lisp-regexp "\\([(`]\\|#'\\)"
130 "*A regexp which, if matched at beginning of an argument, means Lisp. 130 "A regexp which, if matched at beginning of an argument, means Lisp.
131Such arguments will be passed to `read', and then evaluated." 131Such arguments will be passed to `read', and then evaluated."
132 :type 'regexp 132 :type 'regexp
133 :group 'eshell-cmd) 133 :group 'eshell-cmd)
134 134
135(defcustom eshell-pre-command-hook nil 135(defcustom eshell-pre-command-hook nil
136 "*A hook run before each interactive command is invoked." 136 "A hook run before each interactive command is invoked."
137 :type 'hook 137 :type 'hook
138 :group 'eshell-cmd) 138 :group 'eshell-cmd)
139 139
140(defcustom eshell-post-command-hook nil 140(defcustom eshell-post-command-hook nil
141 "*A hook run after each interactive command is invoked." 141 "A hook run after each interactive command is invoked."
142 :type 'hook 142 :type 'hook
143 :group 'eshell-cmd) 143 :group 'eshell-cmd)
144 144
145(defcustom eshell-prepare-command-hook nil 145(defcustom eshell-prepare-command-hook nil
146 "*A set of functions called to prepare a named command. 146 "A set of functions called to prepare a named command.
147The command name and its argument are in `eshell-last-command-name' 147The command name and its argument are in `eshell-last-command-name'
148and `eshell-last-arguments'. The functions on this hook can change 148and `eshell-last-arguments'. The functions on this hook can change
149the value of these symbols if necessary. 149the value of these symbols if necessary.
@@ -154,7 +154,7 @@ To prevent a command from executing at all, set
154 :group 'eshell-cmd) 154 :group 'eshell-cmd)
155 155
156(defcustom eshell-named-command-hook nil 156(defcustom eshell-named-command-hook nil
157 "*A set of functions called before a named command is invoked. 157 "A set of functions called before a named command is invoked.
158Each function will be passed the command name and arguments that were 158Each function will be passed the command name and arguments that were
159passed to `eshell-named-command'. 159passed to `eshell-named-command'.
160 160
@@ -180,7 +180,7 @@ call to `cd' using the arguments that were passed to the function."
180(defcustom eshell-pre-rewrite-command-hook 180(defcustom eshell-pre-rewrite-command-hook
181 '(eshell-no-command-conversion 181 '(eshell-no-command-conversion
182 eshell-subcommand-arg-values) 182 eshell-subcommand-arg-values)
183 "*A hook run before command rewriting begins. 183 "A hook run before command rewriting begins.
184The terms of the command to be rewritten is passed as arguments, and 184The terms of the command to be rewritten is passed as arguments, and
185may be modified in place. Any return value is ignored." 185may be modified in place. Any return value is ignored."
186 :type 'hook 186 :type 'hook
@@ -193,7 +193,7 @@ may be modified in place. Any return value is ignored."
193 eshell-rewrite-sexp-command 193 eshell-rewrite-sexp-command
194 eshell-rewrite-initial-subcommand 194 eshell-rewrite-initial-subcommand
195 eshell-rewrite-named-command) 195 eshell-rewrite-named-command)
196 "*A set of functions used to rewrite the command argument. 196 "A set of functions used to rewrite the command argument.
197Once parsing of a command line is completed, the next step is to 197Once parsing of a command line is completed, the next step is to
198rewrite the initial argument into something runnable. 198rewrite the initial argument into something runnable.
199 199
@@ -207,14 +207,14 @@ forms or strings)."
207 :group 'eshell-cmd) 207 :group 'eshell-cmd)
208 208
209(defcustom eshell-post-rewrite-command-hook nil 209(defcustom eshell-post-rewrite-command-hook nil
210 "*A hook run after command rewriting is finished. 210 "A hook run after command rewriting is finished.
211Each function is passed the symbol containing the rewritten command, 211Each function is passed the symbol containing the rewritten command,
212which may be modified directly. Any return value is ignored." 212which may be modified directly. Any return value is ignored."
213 :type 'hook 213 :type 'hook
214 :group 'eshell-cmd) 214 :group 'eshell-cmd)
215 215
216(defcustom eshell-complex-commands '("ls") 216(defcustom eshell-complex-commands '("ls")
217 "*A list of commands names or functions, that determine complexity. 217 "A list of commands names or functions, that determine complexity.
218That is, if a command is defined by a function named eshell/NAME, 218That is, if a command is defined by a function named eshell/NAME,
219and NAME is part of this list, it is invoked as a complex command. 219and NAME is part of this list, it is invoked as a complex command.
220Complex commands are always correct, but run much slower. If a 220Complex commands are always correct, but run much slower. If a
@@ -231,12 +231,12 @@ return non-nil if the command is complex."
231;;; User Variables: 231;;; User Variables:
232 232
233(defcustom eshell-cmd-load-hook '(eshell-cmd-initialize) 233(defcustom eshell-cmd-load-hook '(eshell-cmd-initialize)
234 "*A hook that gets run when `eshell-cmd' is loaded." 234 "A hook that gets run when `eshell-cmd' is loaded."
235 :type 'hook 235 :type 'hook
236 :group 'eshell-cmd) 236 :group 'eshell-cmd)
237 237
238(defcustom eshell-debug-command nil 238(defcustom eshell-debug-command nil
239 "*If non-nil, enable debugging code. SSLLOOWW. 239 "If non-nil, enable debugging code. SSLLOOWW.
240This option is only useful for reporting bugs. If you enable it, you 240This option is only useful for reporting bugs. If you enable it, you
241will have to visit the file 'eshell-cmd.el' and run the command 241will have to visit the file 'eshell-cmd.el' and run the command
242\\[eval-buffer]." 242\\[eval-buffer]."
@@ -247,7 +247,7 @@ will have to visit the file 'eshell-cmd.el' and run the command
247 '(eshell-named-command 247 '(eshell-named-command
248 eshell-lisp-command 248 eshell-lisp-command
249 eshell-process-identity) 249 eshell-process-identity)
250 "*A list of functions which might return an ansychronous process. 250 "A list of functions which might return an ansychronous process.
251If they return a process object, execution of the calling Eshell 251If they return a process object, execution of the calling Eshell
252command will wait for completion (in the background) before finishing 252command will wait for completion (in the background) before finishing
253the command." 253the command."
@@ -258,7 +258,7 @@ the command."
258 '((eshell-in-subcommand-p t) 258 '((eshell-in-subcommand-p t)
259 (default-directory default-directory) 259 (default-directory default-directory)
260 (process-environment (eshell-copy-environment))) 260 (process-environment (eshell-copy-environment)))
261 "*A list of `let' bindings for subcommand environments." 261 "A list of `let' bindings for subcommand environments."
262 :type 'sexp 262 :type 'sexp
263 :group 'eshell-cmd) 263 :group 'eshell-cmd)
264 264
diff --git a/lisp/eshell/esh-ext.el b/lisp/eshell/esh-ext.el
index dba8665d9ae..8a3f86a3997 100644
--- a/lisp/eshell/esh-ext.el
+++ b/lisp/eshell/esh-ext.el
@@ -1,7 +1,7 @@
1;;; esh-ext.el --- commands external to Eshell 1;;; esh-ext.el --- commands external to Eshell
2 2
3;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 3;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
4;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. 4;; 2008, 2009, 2010 Free Software Foundation, Inc.
5 5
6;; Author: John Wiegley <johnw@gnu.org> 6;; Author: John Wiegley <johnw@gnu.org>
7 7
@@ -48,17 +48,17 @@ loaded into memory, thus beginning a new process."
48;;; User Variables: 48;;; User Variables:
49 49
50(defcustom eshell-ext-load-hook '(eshell-ext-initialize) 50(defcustom eshell-ext-load-hook '(eshell-ext-initialize)
51 "*A hook that gets run when `eshell-ext' is loaded." 51 "A hook that gets run when `eshell-ext' is loaded."
52 :type 'hook 52 :type 'hook
53 :group 'eshell-ext) 53 :group 'eshell-ext)
54 54
55(defcustom eshell-binary-suffixes exec-suffixes 55(defcustom eshell-binary-suffixes exec-suffixes
56 "*A list of suffixes used when searching for executable files." 56 "A list of suffixes used when searching for executable files."
57 :type '(repeat string) 57 :type '(repeat string)
58 :group 'eshell-ext) 58 :group 'eshell-ext)
59 59
60(defcustom eshell-force-execution nil 60(defcustom eshell-force-execution nil
61 "*If non-nil, try to execute binary files regardless of permissions. 61 "If non-nil, try to execute binary files regardless of permissions.
62This can be useful on systems like Windows, where the operating system 62This can be useful on systems like Windows, where the operating system
63doesn't happen to honor the permission bits in certain cases; or in 63doesn't happen to honor the permission bits in certain cases; or in
64cases where you want to associate an interpreter with a particular 64cases where you want to associate an interpreter with a particular
@@ -96,7 +96,7 @@ since nothing else but Eshell will be able to understand
96 (or (eshell-search-path "cmd.exe") 96 (or (eshell-search-path "cmd.exe")
97 (eshell-search-path "command.com")) 97 (eshell-search-path "command.com"))
98 shell-file-name)) 98 shell-file-name))
99 "*The name of the shell command to use for DOS/Windows batch files. 99 "The name of the shell command to use for DOS/Windows batch files.
100This defaults to nil on non-Windows systems, where this variable is 100This defaults to nil on non-Windows systems, where this variable is
101wholly ignored." 101wholly ignored."
102 :type '(choice file (const nil)) 102 :type '(choice file (const nil))
@@ -113,7 +113,7 @@ wholly ignored."
113(defcustom eshell-interpreter-alist 113(defcustom eshell-interpreter-alist
114 (if (eshell-under-windows-p) 114 (if (eshell-under-windows-p)
115 '(("\\.\\(bat\\|cmd\\)\\'" . eshell-invoke-batch-file))) 115 '(("\\.\\(bat\\|cmd\\)\\'" . eshell-invoke-batch-file)))
116 "*An alist defining interpreter substitutions. 116 "An alist defining interpreter substitutions.
117Each member is a cons cell of the form: 117Each member is a cons cell of the form:
118 118
119 (MATCH . INTERPRETER) 119 (MATCH . INTERPRETER)
@@ -134,7 +134,7 @@ possible return values of `eshell-external-command', which see."
134 :group 'eshell-ext) 134 :group 'eshell-ext)
135 135
136(defcustom eshell-alternate-command-hook nil 136(defcustom eshell-alternate-command-hook nil
137 "*A hook run whenever external command lookup fails. 137 "A hook run whenever external command lookup fails.
138If a functions wishes to provide an alternate command, they must throw 138If a functions wishes to provide an alternate command, they must throw
139it using the tag `eshell-replace-command'. This is done because the 139it using the tag `eshell-replace-command'. This is done because the
140substituted command need not be external at all, and therefore must be 140substituted command need not be external at all, and therefore must be
@@ -147,12 +147,12 @@ by the user on the command line."
147 :group 'eshell-ext) 147 :group 'eshell-ext)
148 148
149(defcustom eshell-command-interpreter-max-length 256 149(defcustom eshell-command-interpreter-max-length 256
150 "*The maximum length of any command interpreter string, plus args." 150 "The maximum length of any command interpreter string, plus args."
151 :type 'integer 151 :type 'integer
152 :group 'eshell-ext) 152 :group 'eshell-ext)
153 153
154(defcustom eshell-explicit-command-char ?* 154(defcustom eshell-explicit-command-char ?*
155 "*If this char occurs before a command name, call it externally. 155 "If this char occurs before a command name, call it externally.
156That is, although `vi' may be an alias, `\vi' will always call the 156That is, although `vi' may be an alias, `\vi' will always call the
157external version." 157external version."
158 :type 'character 158 :type 'character
diff --git a/lisp/eshell/esh-io.el b/lisp/eshell/esh-io.el
index 3aa785c7c1b..53b6fd2163e 100644
--- a/lisp/eshell/esh-io.el
+++ b/lisp/eshell/esh-io.el
@@ -73,12 +73,12 @@ though they were files."
73;;; User Variables: 73;;; User Variables:
74 74
75(defcustom eshell-io-load-hook '(eshell-io-initialize) 75(defcustom eshell-io-load-hook '(eshell-io-initialize)
76 "*A hook that gets run when `eshell-io' is loaded." 76 "A hook that gets run when `eshell-io' is loaded."
77 :type 'hook 77 :type 'hook
78 :group 'eshell-io) 78 :group 'eshell-io)
79 79
80(defcustom eshell-number-of-handles 3 80(defcustom eshell-number-of-handles 3
81 "*The number of file handles that eshell supports. 81 "The number of file handles that eshell supports.
82Currently this is standard input, output and error. But even all of 82Currently this is standard input, output and error. But even all of
83these Emacs does not currently support with asynchronous processes 83these Emacs does not currently support with asynchronous processes
84\(which is what eshell uses so that you can continue doing work in 84\(which is what eshell uses so that you can continue doing work in
@@ -87,17 +87,17 @@ other buffers) ."
87 :group 'eshell-io) 87 :group 'eshell-io)
88 88
89(defcustom eshell-output-handle 1 89(defcustom eshell-output-handle 1
90 "*The index of the standard output handle." 90 "The index of the standard output handle."
91 :type 'integer 91 :type 'integer
92 :group 'eshell-io) 92 :group 'eshell-io)
93 93
94(defcustom eshell-error-handle 2 94(defcustom eshell-error-handle 2
95 "*The index of the standard error handle." 95 "The index of the standard error handle."
96 :type 'integer 96 :type 'integer
97 :group 'eshell-io) 97 :group 'eshell-io)
98 98
99(defcustom eshell-buffer-shorthand nil 99(defcustom eshell-buffer-shorthand nil
100 "*If non-nil, a symbol name can be used for a buffer in redirection. 100 "If non-nil, a symbol name can be used for a buffer in redirection.
101If nil, redirecting to a buffer requires buffer name syntax. If this 101If nil, redirecting to a buffer requires buffer name syntax. If this
102variable is set, redirection directly to Lisp symbols will be 102variable is set, redirection directly to Lisp symbols will be
103impossible. 103impossible.
@@ -110,7 +110,7 @@ Example:
110 :group 'eshell-io) 110 :group 'eshell-io)
111 111
112(defcustom eshell-print-queue-size 5 112(defcustom eshell-print-queue-size 5
113 "*The size of the print queue, for doing buffered printing. 113 "The size of the print queue, for doing buffered printing.
114This is basically a speed enhancement, to avoid blocking the Lisp code 114This is basically a speed enhancement, to avoid blocking the Lisp code
115from executing while Emacs is redisplaying." 115from executing while Emacs is redisplaying."
116 :type 'integer 116 :type 'integer
@@ -127,7 +127,7 @@ from executing while Emacs is redisplaying."
127 (let ((x-select-enable-clipboard t)) 127 (let ((x-select-enable-clipboard t))
128 (kill-new ""))) 128 (kill-new "")))
129 'eshell-clipboard-append) t)) 129 'eshell-clipboard-append) t))
130 "*Map virtual devices name to Emacs Lisp functions. 130 "Map virtual devices name to Emacs Lisp functions.
131If the user specifies any of the filenames above as a redirection 131If the user specifies any of the filenames above as a redirection
132target, the function in the second element will be called. 132target, the function in the second element will be called.
133 133
diff --git a/lisp/eshell/esh-mode.el b/lisp/eshell/esh-mode.el
index cc7f0df92ca..4477f138478 100644
--- a/lisp/eshell/esh-mode.el
+++ b/lisp/eshell/esh-mode.el
@@ -75,54 +75,54 @@
75;;; User Variables: 75;;; User Variables:
76 76
77(defcustom eshell-mode-unload-hook nil 77(defcustom eshell-mode-unload-hook nil
78 "*A hook that gets run when `eshell-mode' is unloaded." 78 "A hook that gets run when `eshell-mode' is unloaded."
79 :type 'hook 79 :type 'hook
80 :group 'eshell-mode) 80 :group 'eshell-mode)
81 81
82(defcustom eshell-mode-hook nil 82(defcustom eshell-mode-hook nil
83 "*A hook that gets run when `eshell-mode' is entered." 83 "A hook that gets run when `eshell-mode' is entered."
84 :type 'hook 84 :type 'hook
85 :group 'eshell-mode) 85 :group 'eshell-mode)
86 86
87(defcustom eshell-first-time-mode-hook nil 87(defcustom eshell-first-time-mode-hook nil
88 "*A hook that gets run the first time `eshell-mode' is entered. 88 "A hook that gets run the first time `eshell-mode' is entered.
89That is to say, the first time during an Emacs session." 89That is to say, the first time during an Emacs session."
90 :type 'hook 90 :type 'hook
91 :group 'eshell-mode) 91 :group 'eshell-mode)
92 92
93(defcustom eshell-exit-hook '(eshell-query-kill-processes) 93(defcustom eshell-exit-hook '(eshell-query-kill-processes)
94 "*A hook that is run whenever `eshell' is exited. 94 "A hook that is run whenever `eshell' is exited.
95This hook is only run if exiting actually kills the buffer." 95This hook is only run if exiting actually kills the buffer."
96 :type 'hook 96 :type 'hook
97 :group 'eshell-mode) 97 :group 'eshell-mode)
98 98
99(defcustom eshell-kill-on-exit t 99(defcustom eshell-kill-on-exit t
100 "*If non-nil, kill the Eshell buffer on the `exit' command. 100 "If non-nil, kill the Eshell buffer on the `exit' command.
101Otherwise, the buffer will simply be buried." 101Otherwise, the buffer will simply be buried."
102 :type 'boolean 102 :type 'boolean
103 :group 'eshell-mode) 103 :group 'eshell-mode)
104 104
105(defcustom eshell-input-filter-functions nil 105(defcustom eshell-input-filter-functions nil
106 "*Functions to call before input is processed. 106 "Functions to call before input is processed.
107The input is contained in the region from `eshell-last-input-start' to 107The input is contained in the region from `eshell-last-input-start' to
108`eshell-last-input-end'." 108`eshell-last-input-end'."
109 :type 'hook 109 :type 'hook
110 :group 'eshell-mode) 110 :group 'eshell-mode)
111 111
112(defcustom eshell-send-direct-to-subprocesses nil 112(defcustom eshell-send-direct-to-subprocesses nil
113 "*If t, send any input immediately to a subprocess." 113 "If t, send any input immediately to a subprocess."
114 :type 'boolean 114 :type 'boolean
115 :group 'eshell-mode) 115 :group 'eshell-mode)
116 116
117(defcustom eshell-expand-input-functions nil 117(defcustom eshell-expand-input-functions nil
118 "*Functions to call before input is parsed. 118 "Functions to call before input is parsed.
119Each function is passed two arguments, which bounds the region of the 119Each function is passed two arguments, which bounds the region of the
120current input text." 120current input text."
121 :type 'hook 121 :type 'hook
122 :group 'eshell-mode) 122 :group 'eshell-mode)
123 123
124(defcustom eshell-scroll-to-bottom-on-input nil 124(defcustom eshell-scroll-to-bottom-on-input nil
125 "*Controls whether input to interpreter causes window to scroll. 125 "Controls whether input to interpreter causes window to scroll.
126If nil, then do not scroll. If t or `all', scroll all windows showing 126If nil, then do not scroll. If t or `all', scroll all windows showing
127buffer. If `this', scroll only the selected window. 127buffer. If `this', scroll only the selected window.
128 128
@@ -133,7 +133,7 @@ See `eshell-preinput-scroll-to-bottom'."
133 :group 'eshell-mode) 133 :group 'eshell-mode)
134 134
135(defcustom eshell-scroll-to-bottom-on-output nil 135(defcustom eshell-scroll-to-bottom-on-output nil
136 "*Controls whether interpreter output causes window to scroll. 136 "Controls whether interpreter output causes window to scroll.
137If nil, then do not scroll. If t or `all', scroll all windows showing 137If nil, then do not scroll. If t or `all', scroll all windows showing
138buffer. If `this', scroll only the selected window. If `others', 138buffer. If `this', scroll only the selected window. If `others',
139scroll only those that are not the selected window. 139scroll only those that are not the selected window.
@@ -147,7 +147,7 @@ See variable `eshell-scroll-show-maximum-output' and function
147 :group 'eshell-mode) 147 :group 'eshell-mode)
148 148
149(defcustom eshell-scroll-show-maximum-output t 149(defcustom eshell-scroll-show-maximum-output t
150 "*Controls how interpreter output causes window to scroll. 150 "Controls how interpreter output causes window to scroll.
151If non-nil, then show the maximum output when the window is scrolled. 151If non-nil, then show the maximum output when the window is scrolled.
152 152
153See variable `eshell-scroll-to-bottom-on-output' and function 153See variable `eshell-scroll-to-bottom-on-output' and function
@@ -156,7 +156,7 @@ See variable `eshell-scroll-to-bottom-on-output' and function
156 :group 'eshell-mode) 156 :group 'eshell-mode)
157 157
158(defcustom eshell-buffer-maximum-lines 1024 158(defcustom eshell-buffer-maximum-lines 1024
159 "*The maximum size in lines for eshell buffers. 159 "The maximum size in lines for eshell buffers.
160Eshell buffers are truncated from the top to be no greater than this 160Eshell buffers are truncated from the top to be no greater than this
161number, if the function `eshell-truncate-buffer' is on 161number, if the function `eshell-truncate-buffer' is on
162`eshell-output-filter-functions'." 162`eshell-output-filter-functions'."
@@ -168,14 +168,14 @@ number, if the function `eshell-truncate-buffer' is on
168 eshell-handle-control-codes 168 eshell-handle-control-codes
169 eshell-handle-ansi-color 169 eshell-handle-ansi-color
170 eshell-watch-for-password-prompt) 170 eshell-watch-for-password-prompt)
171 "*Functions to call before output is displayed. 171 "Functions to call before output is displayed.
172These functions are only called for output that is displayed 172These functions are only called for output that is displayed
173interactively, and not for output which is redirected." 173interactively, and not for output which is redirected."
174 :type 'hook 174 :type 'hook
175 :group 'eshell-mode) 175 :group 'eshell-mode)
176 176
177(defcustom eshell-preoutput-filter-functions nil 177(defcustom eshell-preoutput-filter-functions nil
178 "*Functions to call before output is inserted into the buffer. 178 "Functions to call before output is inserted into the buffer.
179These functions get one argument, a string containing the text to be 179These functions get one argument, a string containing the text to be
180inserted. They return the string as it should be inserted." 180inserted. They return the string as it should be inserted."
181 :type 'hook 181 :type 'hook
@@ -183,18 +183,18 @@ inserted. They return the string as it should be inserted."
183 183
184(defcustom eshell-password-prompt-regexp 184(defcustom eshell-password-prompt-regexp
185 "[Pp]ass\\(word\\|phrase\\).*:\\s *\\'" 185 "[Pp]ass\\(word\\|phrase\\).*:\\s *\\'"
186 "*Regexp matching prompts for passwords in the inferior process. 186 "Regexp matching prompts for passwords in the inferior process.
187This is used by `eshell-watch-for-password-prompt'." 187This is used by `eshell-watch-for-password-prompt'."
188 :type 'regexp 188 :type 'regexp
189 :group 'eshell-mode) 189 :group 'eshell-mode)
190 190
191(defcustom eshell-skip-prompt-function nil 191(defcustom eshell-skip-prompt-function nil
192 "*A function called from beginning of line to skip the prompt." 192 "A function called from beginning of line to skip the prompt."
193 :type '(choice (const nil) function) 193 :type '(choice (const nil) function)
194 :group 'eshell-mode) 194 :group 'eshell-mode)
195 195
196(defcustom eshell-status-in-modeline t 196(defcustom eshell-status-in-modeline t
197 "*If non-nil, let the user know a command is running in the modeline." 197 "If non-nil, let the user know a command is running in the modeline."
198 :type 'boolean 198 :type 'boolean
199 :group 'eshell-mode) 199 :group 'eshell-mode)
200 200
diff --git a/lisp/eshell/esh-proc.el b/lisp/eshell/esh-proc.el
index 4fef82b46d5..ccc36ed9949 100644
--- a/lisp/eshell/esh-proc.el
+++ b/lisp/eshell/esh-proc.el
@@ -1,7 +1,7 @@
1;;; esh-proc.el --- process management 1;;; esh-proc.el --- process management
2 2
3;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 3;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
4;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. 4;; 2008, 2009, 2010 Free Software Foundation, Inc.
5 5
6;; Author: John Wiegley <johnw@gnu.org> 6;; Author: John Wiegley <johnw@gnu.org>
7 7
@@ -40,27 +40,27 @@ finish."
40;;; User Variables: 40;;; User Variables:
41 41
42(defcustom eshell-proc-load-hook '(eshell-proc-initialize) 42(defcustom eshell-proc-load-hook '(eshell-proc-initialize)
43 "*A hook that gets run when `eshell-proc' is loaded." 43 "A hook that gets run when `eshell-proc' is loaded."
44 :type 'hook 44 :type 'hook
45 :group 'eshell-proc) 45 :group 'eshell-proc)
46 46
47(defcustom eshell-process-wait-seconds 0 47(defcustom eshell-process-wait-seconds 0
48 "*The number of seconds to delay waiting for a synchronous process." 48 "The number of seconds to delay waiting for a synchronous process."
49 :type 'integer 49 :type 'integer
50 :group 'eshell-proc) 50 :group 'eshell-proc)
51 51
52(defcustom eshell-process-wait-milliseconds 50 52(defcustom eshell-process-wait-milliseconds 50
53 "*The number of milliseconds to delay waiting for a synchronous process." 53 "The number of milliseconds to delay waiting for a synchronous process."
54 :type 'integer 54 :type 'integer
55 :group 'eshell-proc) 55 :group 'eshell-proc)
56 56
57(defcustom eshell-done-messages-in-minibuffer t 57(defcustom eshell-done-messages-in-minibuffer t
58 "*If non-nil, subjob \"Done\" messages will display in minibuffer." 58 "If non-nil, subjob \"Done\" messages will display in minibuffer."
59 :type 'boolean 59 :type 'boolean
60 :group 'eshell-proc) 60 :group 'eshell-proc)
61 61
62(defcustom eshell-delete-exited-processes t 62(defcustom eshell-delete-exited-processes t
63 "*If nil, process entries will stick around until `jobs' is run. 63 "If nil, process entries will stick around until `jobs' is run.
64This variable sets the buffer-local value of `delete-exited-processes' 64This variable sets the buffer-local value of `delete-exited-processes'
65in Eshell buffers. 65in Eshell buffers.
66 66
@@ -81,12 +81,12 @@ variable's value to take effect."
81 81
82(defcustom eshell-reset-signals 82(defcustom eshell-reset-signals
83 "^\\(interrupt\\|killed\\|quit\\|stopped\\)" 83 "^\\(interrupt\\|killed\\|quit\\|stopped\\)"
84 "*If a termination signal matches this regexp, the terminal will be reset." 84 "If a termination signal matches this regexp, the terminal will be reset."
85 :type 'regexp 85 :type 'regexp
86 :group 'eshell-proc) 86 :group 'eshell-proc)
87 87
88(defcustom eshell-exec-hook nil 88(defcustom eshell-exec-hook nil
89 "*Called each time a process is exec'd by `eshell-gather-process-output'. 89 "Called each time a process is exec'd by `eshell-gather-process-output'.
90It is passed one argument, which is the process that was just started. 90It is passed one argument, which is the process that was just started.
91It is useful for things that must be done each time a process is 91It is useful for things that must be done each time a process is
92executed in a eshell mode buffer (e.g., `process-kill-without-query'). 92executed in a eshell mode buffer (e.g., `process-kill-without-query').
@@ -96,7 +96,7 @@ is created."
96 :group 'eshell-proc) 96 :group 'eshell-proc)
97 97
98(defcustom eshell-kill-hook '(eshell-reset-after-proc) 98(defcustom eshell-kill-hook '(eshell-reset-after-proc)
99 "*Called when a process run by `eshell-gather-process-output' has ended. 99 "Called when a process run by `eshell-gather-process-output' has ended.
100It is passed two arguments: the process that was just ended, and the 100It is passed two arguments: the process that was just ended, and the
101termination status (as a string). Note that the first argument may be 101termination status (as a string). Note that the first argument may be
102nil, in which case the user attempted to send a signal, but there was 102nil, in which case the user attempted to send a signal, but there was
@@ -418,12 +418,12 @@ If QUERY is non-nil, query the user with QUERY before calling FUNC."
418 result)) 418 result))
419 419
420(defcustom eshell-kill-process-wait-time 5 420(defcustom eshell-kill-process-wait-time 5
421 "*Seconds to wait between sending termination signals to a subprocess." 421 "Seconds to wait between sending termination signals to a subprocess."
422 :type 'integer 422 :type 'integer
423 :group 'eshell-proc) 423 :group 'eshell-proc)
424 424
425(defcustom eshell-kill-process-signals '(SIGINT SIGQUIT SIGKILL) 425(defcustom eshell-kill-process-signals '(SIGINT SIGQUIT SIGKILL)
426 "*Signals used to kill processes when an Eshell buffer exits. 426 "Signals used to kill processes when an Eshell buffer exits.
427Eshell calls each of these signals in order when an Eshell buffer is 427Eshell calls each of these signals in order when an Eshell buffer is
428killed; if the process is still alive afterwards, Eshell waits a 428killed; if the process is still alive afterwards, Eshell waits a
429number of seconds defined by `eshell-kill-process-wait-time', and 429number of seconds defined by `eshell-kill-process-wait-time', and
@@ -432,7 +432,7 @@ tries the next signal in the list."
432 :group 'eshell-proc) 432 :group 'eshell-proc)
433 433
434(defcustom eshell-kill-processes-on-exit nil 434(defcustom eshell-kill-processes-on-exit nil
435 "*If non-nil, kill active processes when exiting an Eshell buffer. 435 "If non-nil, kill active processes when exiting an Eshell buffer.
436Emacs will only kill processes owned by that Eshell buffer. 436Emacs will only kill processes owned by that Eshell buffer.
437 437
438If nil, ownership of background and foreground processes reverts to 438If nil, ownership of background and foreground processes reverts to
diff --git a/lisp/eshell/esh-test.el b/lisp/eshell/esh-test.el
index 5bce6072f0a..971d0cd63e6 100644
--- a/lisp/eshell/esh-test.el
+++ b/lisp/eshell/esh-test.el
@@ -43,7 +43,7 @@
43(defface eshell-test-ok 43(defface eshell-test-ok
44 '((((class color) (background light)) (:foreground "Green" :bold t)) 44 '((((class color) (background light)) (:foreground "Green" :bold t))
45 (((class color) (background dark)) (:foreground "Green" :bold t))) 45 (((class color) (background dark)) (:foreground "Green" :bold t)))
46 "*The face used to highlight OK result strings." 46 "The face used to highlight OK result strings."
47 :group 'eshell-test) 47 :group 'eshell-test)
48(define-obsolete-face-alias 'eshell-test-ok-face 'eshell-test-ok "22.1") 48(define-obsolete-face-alias 'eshell-test-ok-face 'eshell-test-ok "22.1")
49 49
@@ -51,12 +51,12 @@
51 '((((class color) (background light)) (:foreground "OrangeRed" :bold t)) 51 '((((class color) (background light)) (:foreground "OrangeRed" :bold t))
52 (((class color) (background dark)) (:foreground "OrangeRed" :bold t)) 52 (((class color) (background dark)) (:foreground "OrangeRed" :bold t))
53 (t (:bold t))) 53 (t (:bold t)))
54 "*The face used to highlight FAILED result strings." 54 "The face used to highlight FAILED result strings."
55 :group 'eshell-test) 55 :group 'eshell-test)
56(define-obsolete-face-alias 'eshell-test-failed-face 'eshell-test-failed "22.1") 56(define-obsolete-face-alias 'eshell-test-failed-face 'eshell-test-failed "22.1")
57 57
58(defcustom eshell-show-usage-metrics nil 58(defcustom eshell-show-usage-metrics nil
59 "*If non-nil, display different usage metrics for each Eshell command." 59 "If non-nil, display different usage metrics for each Eshell command."
60 :set (lambda (symbol value) 60 :set (lambda (symbol value)
61 (if value 61 (if value
62 (add-hook 'eshell-mode-hook 'eshell-show-usage-metrics) 62 (add-hook 'eshell-mode-hook 'eshell-show-usage-metrics)
diff --git a/lisp/eshell/esh-util.el b/lisp/eshell/esh-util.el
index c86fa041f93..377fd6b08e4 100644
--- a/lisp/eshell/esh-util.el
+++ b/lisp/eshell/esh-util.el
@@ -32,7 +32,7 @@
32;;; User Variables: 32;;; User Variables:
33 33
34(defcustom eshell-stringify-t t 34(defcustom eshell-stringify-t t
35 "*If non-nil, the string representation of t is 't'. 35 "If non-nil, the string representation of t is 't'.
36If nil, t will be represented only in the exit code of the function, 36If nil, t will be represented only in the exit code of the function,
37and not printed as a string. This causes Lisp functions to behave 37and not printed as a string. This causes Lisp functions to behave
38similarly to external commands, as far as successful result output." 38similarly to external commands, as far as successful result output."
@@ -40,45 +40,45 @@ similarly to external commands, as far as successful result output."
40 :group 'eshell-util) 40 :group 'eshell-util)
41 41
42(defcustom eshell-group-file "/etc/group" 42(defcustom eshell-group-file "/etc/group"
43 "*If non-nil, the name of the group file on your system." 43 "If non-nil, the name of the group file on your system."
44 :type '(choice (const :tag "No group file" nil) file) 44 :type '(choice (const :tag "No group file" nil) file)
45 :group 'eshell-util) 45 :group 'eshell-util)
46 46
47(defcustom eshell-passwd-file "/etc/passwd" 47(defcustom eshell-passwd-file "/etc/passwd"
48 "*If non-nil, the name of the passwd file on your system." 48 "If non-nil, the name of the passwd file on your system."
49 :type '(choice (const :tag "No passwd file" nil) file) 49 :type '(choice (const :tag "No passwd file" nil) file)
50 :group 'eshell-util) 50 :group 'eshell-util)
51 51
52(defcustom eshell-hosts-file "/etc/hosts" 52(defcustom eshell-hosts-file "/etc/hosts"
53 "*The name of the /etc/hosts file." 53 "The name of the /etc/hosts file."
54 :type '(choice (const :tag "No hosts file" nil) file) 54 :type '(choice (const :tag "No hosts file" nil) file)
55 :group 'eshell-util) 55 :group 'eshell-util)
56 56
57(defcustom eshell-handle-errors t 57(defcustom eshell-handle-errors t
58 "*If non-nil, Eshell will handle errors itself. 58 "If non-nil, Eshell will handle errors itself.
59Setting this to nil is offered as an aid to debugging only." 59Setting this to nil is offered as an aid to debugging only."
60 :type 'boolean 60 :type 'boolean
61 :group 'eshell-util) 61 :group 'eshell-util)
62 62
63(defcustom eshell-private-file-modes 384 ; umask 177 63(defcustom eshell-private-file-modes 384 ; umask 177
64 "*The file-modes value to use for creating \"private\" files." 64 "The file-modes value to use for creating \"private\" files."
65 :type 'integer 65 :type 'integer
66 :group 'eshell-util) 66 :group 'eshell-util)
67 67
68(defcustom eshell-private-directory-modes 448 ; umask 077 68(defcustom eshell-private-directory-modes 448 ; umask 077
69 "*The file-modes value to use for creating \"private\" directories." 69 "The file-modes value to use for creating \"private\" directories."
70 :type 'integer 70 :type 'integer
71 :group 'eshell-util) 71 :group 'eshell-util)
72 72
73(defcustom eshell-tar-regexp 73(defcustom eshell-tar-regexp
74 "\\.t\\(ar\\(\\.\\(gz\\|bz2\\|xz\\|Z\\)\\)?\\|gz\\|a[zZ]\\|z2\\)\\'" 74 "\\.t\\(ar\\(\\.\\(gz\\|bz2\\|xz\\|Z\\)\\)?\\|gz\\|a[zZ]\\|z2\\)\\'"
75 "*Regular expression used to match tar file names." 75 "Regular expression used to match tar file names."
76 :version "24.1" ; added xz 76 :version "24.1" ; added xz
77 :type 'regexp 77 :type 'regexp
78 :group 'eshell-util) 78 :group 'eshell-util)
79 79
80(defcustom eshell-convert-numeric-arguments t 80(defcustom eshell-convert-numeric-arguments t
81 "*If non-nil, converting arguments of numeric form to Lisp numbers. 81 "If non-nil, converting arguments of numeric form to Lisp numbers.
82Numeric form is tested using the regular expression 82Numeric form is tested using the regular expression
83`eshell-number-regexp'. 83`eshell-number-regexp'.
84 84
@@ -96,7 +96,7 @@ argument matches `eshell-number-regexp'."
96 :group 'eshell-util) 96 :group 'eshell-util)
97 97
98(defcustom eshell-number-regexp "-?\\([0-9]*\\.\\)?[0-9]+\\(e[-0-9.]+\\)?" 98(defcustom eshell-number-regexp "-?\\([0-9]*\\.\\)?[0-9]+\\(e[-0-9.]+\\)?"
99 "*Regular expression used to match numeric arguments. 99 "Regular expression used to match numeric arguments.
100If `eshell-convert-numeric-arguments' is non-nil, and an argument 100If `eshell-convert-numeric-arguments' is non-nil, and an argument
101matches this regexp, it will be converted to a Lisp number, using the 101matches this regexp, it will be converted to a Lisp number, using the
102function `string-to-number'." 102function `string-to-number'."
@@ -104,7 +104,7 @@ function `string-to-number'."
104 :group 'eshell-util) 104 :group 'eshell-util)
105 105
106(defcustom eshell-ange-ls-uids nil 106(defcustom eshell-ange-ls-uids nil
107 "*List of user/host/id strings, used to determine remote ownership." 107 "List of user/host/id strings, used to determine remote ownership."
108 :type '(repeat (cons :tag "Host for User/UID map" 108 :type '(repeat (cons :tag "Host for User/UID map"
109 (string :tag "Hostname") 109 (string :tag "Hostname")
110 (repeat (cons :tag "User/UID List" 110 (repeat (cons :tag "User/UID List"
diff --git a/lisp/eshell/esh-var.el b/lisp/eshell/esh-var.el
index 1610c53d428..f76d1de3c8d 100644
--- a/lisp/eshell/esh-var.el
+++ b/lisp/eshell/esh-var.el
@@ -1,7 +1,7 @@
1;;; esh-var.el --- handling of variables 1;;; esh-var.el --- handling of variables
2 2
3;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 3;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
4;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. 4;; 2008, 2009, 2010 Free Software Foundation, Inc.
5 5
6;; Author: John Wiegley <johnw@gnu.org> 6;; Author: John Wiegley <johnw@gnu.org>
7 7
@@ -128,27 +128,27 @@ variable value, a subcommand, or even the result of a Lisp form."
128;;; User Variables: 128;;; User Variables:
129 129
130(defcustom eshell-var-load-hook '(eshell-var-initialize) 130(defcustom eshell-var-load-hook '(eshell-var-initialize)
131 "*A list of functions to call when loading `eshell-var'." 131 "A list of functions to call when loading `eshell-var'."
132 :type 'hook 132 :type 'hook
133 :group 'eshell-var) 133 :group 'eshell-var)
134 134
135(defcustom eshell-prefer-lisp-variables nil 135(defcustom eshell-prefer-lisp-variables nil
136 "*If non-nil, prefer Lisp variables to environment variables." 136 "If non-nil, prefer Lisp variables to environment variables."
137 :type 'boolean 137 :type 'boolean
138 :group 'eshell-var) 138 :group 'eshell-var)
139 139
140(defcustom eshell-complete-export-definition t 140(defcustom eshell-complete-export-definition t
141 "*If non-nil, completing names for `export' shows current definition." 141 "If non-nil, completing names for `export' shows current definition."
142 :type 'boolean 142 :type 'boolean
143 :group 'eshell-var) 143 :group 'eshell-var)
144 144
145(defcustom eshell-modify-global-environment nil 145(defcustom eshell-modify-global-environment nil
146 "*If non-nil, using `export' changes Emacs's global environment." 146 "If non-nil, using `export' changes Emacs's global environment."
147 :type 'boolean 147 :type 'boolean
148 :group 'eshell-var) 148 :group 'eshell-var)
149 149
150(defcustom eshell-variable-name-regexp "[A-Za-z0-9_-]+" 150(defcustom eshell-variable-name-regexp "[A-Za-z0-9_-]+"
151 "*A regexp identifying what constitutes a variable name reference. 151 "A regexp identifying what constitutes a variable name reference.
152Note that this only applies for '$NAME'. If the syntax '$<NAME>' is 152Note that this only applies for '$NAME'. If the syntax '$<NAME>' is
153used, then NAME can contain any character, including angle brackets, 153used, then NAME can contain any character, including angle brackets,
154if they are quoted with a backslash." 154if they are quoted with a backslash."
@@ -183,7 +183,7 @@ if they are quoted with a backslash."
183 eshell-command-arguments 183 eshell-command-arguments
184 (eshell-apply-indices eshell-command-arguments 184 (eshell-apply-indices eshell-command-arguments
185 indices))))) 185 indices)))))
186 "*This list provides aliasing for variable references. 186 "This list provides aliasing for variable references.
187It is very similar in concept to what `eshell-user-aliases-list' does 187It is very similar in concept to what `eshell-user-aliases-list' does
188for commands. Each member of this defines defines the name of a 188for commands. Each member of this defines defines the name of a
189command, and the Lisp value to return for that variable if it is 189command, and the Lisp value to return for that variable if it is