Mercurial > emacs
comparison lisp/eshell/em-hist.el @ 110580:f57f72bb4757
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.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Sat, 25 Sep 2010 14:51:55 -0700 |
parents | 1d1d5d9bd884 |
children | 40af77a50adc |
comparison
equal
deleted
inserted
replaced
110579:5fabe7db5188 | 110580:f57f72bb4757 |
---|---|
70 :group 'eshell-module) | 70 :group 'eshell-module) |
71 | 71 |
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 |
79 (defcustom eshell-hist-unload-hook | 79 (defcustom eshell-hist-unload-hook |
80 (list | 80 (list |
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. |
91 See also `eshell-read-history' and `eshell-write-history'. | 91 See also `eshell-read-history' and `eshell-write-history'. |
92 If it is nil, Eshell will use the value of HISTFILE." | 92 If 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. |
103 This mirrors the optional behavior of bash." | 103 This 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. |
109 History is always preserved after sanely exiting an Eshell buffer. | 109 History is always preserved after sanely exiting an Eshell buffer. |
110 However, when Emacs is being shut down, this variable determines | 110 However, when Emacs is being shut down, this variable determines |
111 whether to prompt the user. | 111 whether to prompt the user. |
112 If set to nil, it means never save history on termination of Emacs. | 112 If set to nil, it means never save history on termination of Emacs. |
113 If set to `ask', ask if any Eshell buffers are open at exit time. | 113 If set to `ask', ask if any Eshell buffers are open at exit time. |
119 | 119 |
120 (defcustom eshell-input-filter | 120 (defcustom eshell-input-filter |
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. |
125 Takes one argument, the input. If non-nil, the input may be saved on | 125 Takes one argument, the input. If non-nil, the input may be saved on |
126 the input history list. Default is to save anything that isn't all | 126 the input history list. Default is to save anything that isn't all |
127 whitespace." | 127 whitespace." |
128 :type 'function | 128 :type 'function |
129 :group 'eshell-hist) | 129 :group 'eshell-hist) |
130 | 130 |
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. |
135 Otherwise, typing <M-p> and <M-n> will always go to the next history | 135 Otherwise, typing <M-p> and <M-n> will always go to the next history |
136 element, regardless of any text on the command line. In that case, | 136 element, 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." |
138 :type 'boolean | 138 :type 'boolean |
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 |
164 (defcustom eshell-hist-rebind-keys-alist | 164 (defcustom eshell-hist-rebind-keys-alist |
165 '(([(control ?p)] . eshell-previous-input) | 165 '(([(control ?p)] . eshell-previous-input) |
172 ([(meta ?s)] . eshell-next-matching-input) | 172 ([(meta ?s)] . eshell-next-matching-input) |
173 ([(meta ?p)] . eshell-previous-matching-input-from-input) | 173 ([(meta ?p)] . eshell-previous-matching-input-from-input) |
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"))) |
181 :group 'eshell-hist) | 181 :group 'eshell-hist) |
182 | 182 |