diff options
| author | Glenn Morris | 2014-01-26 18:02:28 -0800 |
|---|---|---|
| committer | Glenn Morris | 2014-01-26 18:02:28 -0800 |
| commit | ece4bae50f6ca8d03d076aa33eedd014a3af8c41 (patch) | |
| tree | 66910ffa712f0643475284089989667641d1d5d2 /lisp/emulation | |
| parent | 6ea71a445d523ff95a2cd6ae0cbde8bd7ca8d878 (diff) | |
| download | emacs-ece4bae50f6ca8d03d076aa33eedd014a3af8c41.tar.gz emacs-ece4bae50f6ca8d03d076aa33eedd014a3af8c41.zip | |
Doc, comment, etc updates for increased use of locate-user-emacs-file
This should have been a prerequisite for making these changes in the
first place.
* doc/emacs/calendar.texi (Time Intervals):
* doc/misc/idlwave.texi (Lesson III---User Catalog, Online Help)
(Starting the Shell, Catalogs, User Catalog):
* doc/misc/remember.texi (Quick Start):
* doc/misc/viper.texi:
* doc/misc/vip.texi (Customization, Customizing Constants)
(Customizing Key Bindings): Update for files being in ~/.emacs.d/.
* lisp/ido.el (ido-save-directory-list-file):
* lisp/saveplace.el (save-place-file):
* lisp/calendar/timeclock.el (timeclock-file):
* lisp/net/quickurl.el (quickurl-url-file):
* lisp/obsolete/otodo-mode.el (todo-file-do, todo-file-done, todo-file-top):
* lisp/progmodes/idlwave.el (idlwave-config-directory):
* lisp/textmodes/remember.el (remember-data-file):
Bump :version.
* lisp/shadowfile.el (shadow-info-file, shadow-todo-file): Doc fix.
* lisp/strokes.el (strokes-file): Doc fix. Bump :version.
(strokes-help): Doc fix.
* lisp/emulation/viper-init.el (viper-vi-style-in-minibuffer): Doc fix.
* lisp/emulation/viper.el (viper): Doc fix for custom group.
(top-level): Remove oh-so-no-longer-relevant text about vip.
* lisp/obsolete/otodo-mode.el (todo-prefix): Doc fix.
* etc/NEWS: Related edits.
Diffstat (limited to 'lisp/emulation')
| -rw-r--r-- | lisp/emulation/viper-ex.el | 3 | ||||
| -rw-r--r-- | lisp/emulation/viper-init.el | 2 | ||||
| -rw-r--r-- | lisp/emulation/viper-keym.el | 4 | ||||
| -rw-r--r-- | lisp/emulation/viper-macs.el | 22 | ||||
| -rw-r--r-- | lisp/emulation/viper.el | 33 |
5 files changed, 31 insertions, 33 deletions
diff --git a/lisp/emulation/viper-ex.el b/lisp/emulation/viper-ex.el index a4a5f349ffe..65192c245e0 100644 --- a/lisp/emulation/viper-ex.el +++ b/lisp/emulation/viper-ex.el | |||
| @@ -1887,7 +1887,8 @@ Please contact your system administrator. " | |||
| 1887 | (if (featurep 'xemacs) "X" "") | 1887 | (if (featurep 'xemacs) "X" "") |
| 1888 | )))))) | 1888 | )))))) |
| 1889 | 1889 | ||
| 1890 | ;; Ex source command. Loads the file specified as argument or `~/.viper' | 1890 | ;; Ex source command. |
| 1891 | ;; Loads the file specified as argument or viper-custom-file-name. | ||
| 1891 | (defun ex-source () | 1892 | (defun ex-source () |
| 1892 | (viper-get-ex-file) | 1893 | (viper-get-ex-file) |
| 1893 | (if (string= ex-file "") | 1894 | (if (string= ex-file "") |
diff --git a/lisp/emulation/viper-init.el b/lisp/emulation/viper-init.el index 27e7c30375b..9914fdcd2f4 100644 --- a/lisp/emulation/viper-init.el +++ b/lisp/emulation/viper-init.el | |||
| @@ -922,7 +922,7 @@ value refers to the number of characters affected." | |||
| 922 | 922 | ||
| 923 | (defcustom viper-vi-style-in-minibuffer t | 923 | (defcustom viper-vi-style-in-minibuffer t |
| 924 | "If t, use vi-style editing in minibuffer. | 924 | "If t, use vi-style editing in minibuffer. |
| 925 | Should be set in `~/.viper' file." | 925 | Should be set in `viper-custom-file-name'." |
| 926 | :type 'boolean | 926 | :type 'boolean |
| 927 | :group 'viper) | 927 | :group 'viper) |
| 928 | 928 | ||
diff --git a/lisp/emulation/viper-keym.el b/lisp/emulation/viper-keym.el index 10afe229a63..96c5c2bb650 100644 --- a/lisp/emulation/viper-keym.el +++ b/lisp/emulation/viper-keym.el | |||
| @@ -147,8 +147,8 @@ viper-insert-basic-map. Not recommended, except for novice users.") | |||
| 147 | (defvar viper-empty-keymap (make-sparse-keymap)) | 147 | (defvar viper-empty-keymap (make-sparse-keymap)) |
| 148 | 148 | ||
| 149 | ;; This was the main Vi mode in old versions of VIP which may have been | 149 | ;; This was the main Vi mode in old versions of VIP which may have been |
| 150 | ;; extensively used by VIP users. We declare it as a global var | 150 | ;; extensively used by VIP users. We declare it as a global var and, after |
| 151 | ;; and, after .viper is loaded, we add this keymap to viper-vi-basic-map. | 151 | ;; viper-custom-file-name is loaded, we add this keymapto viper-vi-basic-map. |
| 152 | (defvar viper-mode-map (make-sparse-keymap)) | 152 | (defvar viper-mode-map (make-sparse-keymap)) |
| 153 | 153 | ||
| 154 | ;; Some important keys used in viper | 154 | ;; Some important keys used in viper |
diff --git a/lisp/emulation/viper-macs.el b/lisp/emulation/viper-macs.el index a937309c63d..0c4e7ddac6f 100644 --- a/lisp/emulation/viper-macs.el +++ b/lisp/emulation/viper-macs.el | |||
| @@ -322,7 +322,8 @@ a key is a symbol, e.g., `a', `\\1', `f2', etc., or a list, e.g., | |||
| 322 | ;; More general definitions are inherited by more specific scopes: | 322 | ;; More general definitions are inherited by more specific scopes: |
| 323 | ;; global->major mode->buffer. More specific definitions override more general | 323 | ;; global->major mode->buffer. More specific definitions override more general |
| 324 | (defun viper-record-kbd-macro (macro-name state macro-body &optional scope) | 324 | (defun viper-record-kbd-macro (macro-name state macro-body &optional scope) |
| 325 | "Record a Vi macro. Can be used in `.viper' file to define permanent macros. | 325 | "Record a Vi macro. |
| 326 | Can be used in `viper-custom-file-name' to define permanent macros. | ||
| 326 | MACRO-NAME is a string of characters or a vector of keys. STATE is | 327 | MACRO-NAME is a string of characters or a vector of keys. STATE is |
| 327 | either `vi-state' or `insert-state'. It specifies the Viper state in which to | 328 | either `vi-state' or `insert-state'. It specifies the Viper state in which to |
| 328 | define the macro. MACRO-BODY is a string that represents the keyboard macro. | 329 | define the macro. MACRO-BODY is a string that represents the keyboard macro. |
| @@ -351,8 +352,8 @@ If SCOPE is nil, the user is asked to specify the scope." | |||
| 351 | (error "Can't map an empty macro name")) | 352 | (error "Can't map an empty macro name")) |
| 352 | 353 | ||
| 353 | ;; Macro-name is usually a vector. However, command history or macros | 354 | ;; Macro-name is usually a vector. However, command history or macros |
| 354 | ;; recorded in ~/.viper may be recorded as strings. So, convert to | 355 | ;; recorded in viper-custom-file-name may be recorded as strings. |
| 355 | ;; vectors. | 356 | ;; So, convert to vectors. |
| 356 | (setq macro-name (viper-fixup-macro macro-name)) | 357 | (setq macro-name (viper-fixup-macro macro-name)) |
| 357 | (if (viper-char-array-p macro-name) | 358 | (if (viper-char-array-p macro-name) |
| 358 | (setq macro-name (viper-char-array-to-macro macro-name))) | 359 | (setq macro-name (viper-char-array-to-macro macro-name))) |
| @@ -422,7 +423,7 @@ If SCOPE is nil, the user is asked to specify the scope." | |||
| 422 | ;; if we don't let vector macro-body through %S, | 423 | ;; if we don't let vector macro-body through %S, |
| 423 | ;; the symbols `\.' `\[' etc will be converted into | 424 | ;; the symbols `\.' `\[' etc will be converted into |
| 424 | ;; characters, causing invalid read error on recorded | 425 | ;; characters, causing invalid read error on recorded |
| 425 | ;; macros in .viper. | 426 | ;; macros in viper-custom-file-name. |
| 426 | ;; I am not sure is macro-body can still be a string at | 427 | ;; I am not sure is macro-body can still be a string at |
| 427 | ;; this point, but I am preserving this option anyway. | 428 | ;; this point, but I am preserving this option anyway. |
| 428 | (if (vectorp macro-body) | 429 | (if (vectorp macro-body) |
| @@ -483,11 +484,11 @@ If SCOPE is nil, the user is asked to specify the scope." | |||
| 483 | ;; in effect | 484 | ;; in effect |
| 484 | (defun viper-unrecord-kbd-macro (macro-name state) | 485 | (defun viper-unrecord-kbd-macro (macro-name state) |
| 485 | "Delete macro MACRO-NAME from Viper STATE. | 486 | "Delete macro MACRO-NAME from Viper STATE. |
| 486 | MACRO-NAME must be a vector of viper-style keys. This command is used by Viper | 487 | MACRO-NAME must be a vector of viper-style keys. This command is used |
| 487 | internally, but the user can also use it in ~/.viper to delete pre-defined | 488 | by Viper internally, but you can also use it in `viper-custom-file-name' |
| 488 | macros supplied with Viper. The best way to avoid mistakes in macro names to | 489 | to delete pre-defined macros supplied with Viper. The best way to avoid |
| 489 | be passed to this function is to use viper-describe-kbd-macros and copy the | 490 | mistakes in macro names to be passed to this function is to use |
| 490 | name from there." | 491 | `viper-describe-kbd-macros' and copy the name from there." |
| 491 | (let* (state-name keymap | 492 | (let* (state-name keymap |
| 492 | (macro-alist-var | 493 | (macro-alist-var |
| 493 | (cond ((eq state 'vi-state) | 494 | (cond ((eq state 'vi-state) |
| @@ -507,7 +508,8 @@ name from there." | |||
| 507 | macro-pair macro-entry) | 508 | macro-pair macro-entry) |
| 508 | 509 | ||
| 509 | ;; Macro-name is usually a vector. However, command history or macros | 510 | ;; Macro-name is usually a vector. However, command history or macros |
| 510 | ;; recorded in ~/.viper may appear as strings. So, convert to vectors. | 511 | ;; recorded in viper-custom-file-name may appear as strings. |
| 512 | ;; So, convert to vectors. | ||
| 511 | (setq macro-name (viper-fixup-macro macro-name)) | 513 | (setq macro-name (viper-fixup-macro macro-name)) |
| 512 | (if (viper-char-array-p macro-name) | 514 | (if (viper-char-array-p macro-name) |
| 513 | (setq macro-name (viper-char-array-to-macro macro-name))) | 515 | (setq macro-name (viper-char-array-to-macro macro-name))) |
diff --git a/lisp/emulation/viper.el b/lisp/emulation/viper.el index 690cd881c6c..650b8acbb81 100644 --- a/lisp/emulation/viper.el +++ b/lisp/emulation/viper.el | |||
| @@ -153,9 +153,9 @@ | |||
| 153 | ;; | 153 | ;; |
| 154 | ;; The last viper-vi-basic-minor-mode contains most of the usual Vi bindings | 154 | ;; The last viper-vi-basic-minor-mode contains most of the usual Vi bindings |
| 155 | ;; in its edit mode. This mode provides access to all Emacs facilities. | 155 | ;; in its edit mode. This mode provides access to all Emacs facilities. |
| 156 | ;; Novice users, however, may want to set their viper-expert-level to 1 | 156 | ;; Novice users, however, may want to set their viper-expert-level to 1 in |
| 157 | ;; in their .viper file. This will enable viper-vi-diehard-minor-mode. This | 157 | ;; their viper-custom-file-name. This will enable viper-vi-diehard-minor-mode. |
| 158 | ;; minor mode's bindings make Viper simulate the usual Vi very closely. | 158 | ;; This minor mode's bindings make Viper simulate the usual Vi very closely. |
| 159 | ;; For instance, C-c will not have its standard Emacs binding | 159 | ;; For instance, C-c will not have its standard Emacs binding |
| 160 | ;; and so many of the goodies of Emacs are not available. | 160 | ;; and so many of the goodies of Emacs are not available. |
| 161 | ;; | 161 | ;; |
| @@ -165,12 +165,12 @@ | |||
| 165 | ;; | 165 | ;; |
| 166 | ;; Viper gurus should have at least | 166 | ;; Viper gurus should have at least |
| 167 | ;; (setq viper-expert-level 4) | 167 | ;; (setq viper-expert-level 4) |
| 168 | ;; in their ~/.viper files. This will unsuppress all Emacs keys that are not | 168 | ;; in their viper-custom-file-name. This will unsuppress all Emacs keys |
| 169 | ;; essential for VI-style editing. | 169 | ;; that are not essential for VI-style editing. |
| 170 | ;; Pick-and-choose users may want to put | 170 | ;; Pick-and-choose users may want to put |
| 171 | ;; (setq viper-expert-level 5) | 171 | ;; (setq viper-expert-level 5) |
| 172 | ;; in ~/.viper. Viper will then leave it up to the user to set the variables | 172 | ;; in viper-custom-file-name. Viper will then leave it up to the user to |
| 173 | ;; viper-want-* See viper-set-expert-level for details. | 173 | ;; set the variables viper-want-* See viper-set-expert-level for details. |
| 174 | ;; | 174 | ;; |
| 175 | ;; The very first minor mode, viper-vi-intercept-minor-mode, is of no | 175 | ;; The very first minor mode, viper-vi-intercept-minor-mode, is of no |
| 176 | ;; concern for the user. It is needed to bind Viper's vital keys, such as | 176 | ;; concern for the user. It is needed to bind Viper's vital keys, such as |
| @@ -319,8 +319,7 @@ If set by the user, this must be done _before_ Viper is loaded in `~/.emacs'.") | |||
| 319 | 319 | ||
| 320 | (defgroup viper nil | 320 | (defgroup viper nil |
| 321 | "Vi emulation within Emacs. | 321 | "Vi emulation within Emacs. |
| 322 | NOTE: Viper customization should be saved in `viper-custom-file-name', which | 322 | NOTE: Viper customization should be saved in `viper-custom-file-name'." |
| 323 | defaults to `~/.viper'." | ||
| 324 | :prefix "viper-" | 323 | :prefix "viper-" |
| 325 | :group 'emulations) | 324 | :group 'emulations) |
| 326 | 325 | ||
| @@ -1222,11 +1221,7 @@ If you wish to Viperize AND make this your way of life, please put | |||
| 1222 | (require 'viper) | 1221 | (require 'viper) |
| 1223 | 1222 | ||
| 1224 | in your init file (preferably, close to the top). | 1223 | in your init file (preferably, close to the top). |
| 1225 | These two lines must come in the order given. | 1224 | These two lines must come in the order given.")) |
| 1226 | |||
| 1227 | ** Viper users: | ||
| 1228 | **** The startup file name has been changed from .vip to .viper | ||
| 1229 | **** All vip-* style names have been converted to viper-* style.")) | ||
| 1230 | (if (y-or-n-p "Viperize? ") | 1225 | (if (y-or-n-p "Viperize? ") |
| 1231 | (setq viper-mode t) | 1226 | (setq viper-mode t) |
| 1232 | (setq viper-mode nil)) | 1227 | (setq viper-mode nil)) |
| @@ -1268,8 +1263,8 @@ These two lines must come in the order given. | |||
| 1268 | 1263 | ||
| 1269 | 1264 | ||
| 1270 | ;; Set some useful macros, advices | 1265 | ;; Set some useful macros, advices |
| 1271 | ;; These must be BEFORE ~/.viper is loaded, | 1266 | ;; These must be BEFORE viper-custom-file-name is loaded, |
| 1272 | ;; so the user can unrecord them in ~/.viper. | 1267 | ;; so the user can unrecord them in viper-custom-file-name. |
| 1273 | (if viper-mode | 1268 | (if viper-mode |
| 1274 | (progn | 1269 | (progn |
| 1275 | ;; set advices and some variables that give emacs Vi look. | 1270 | ;; set advices and some variables that give emacs Vi look. |
| @@ -1289,7 +1284,7 @@ These two lines must come in the order given. | |||
| 1289 | ;; Make %%% toggle parsing comments for matching parentheses | 1284 | ;; Make %%% toggle parsing comments for matching parentheses |
| 1290 | (viper-set-parsing-style-toggling-macro nil) | 1285 | (viper-set-parsing-style-toggling-macro nil) |
| 1291 | 1286 | ||
| 1292 | ;; ~/.viper is loaded if exists | 1287 | ;; viper-custom-file-name is loaded if exists |
| 1293 | (viper-load-custom-file) | 1288 | (viper-load-custom-file) |
| 1294 | 1289 | ||
| 1295 | ;; should be after loading custom file to avoid the pesky msg that | 1290 | ;; should be after loading custom file to avoid the pesky msg that |
| @@ -1300,7 +1295,7 @@ These two lines must come in the order given. | |||
| 1300 | 1295 | ||
| 1301 | 1296 | ||
| 1302 | 1297 | ||
| 1303 | ;; Applying Viper customization -- runs after (load .viper) | 1298 | ;; Applying Viper customization -- runs after (load viper-custom-file-name) |
| 1304 | 1299 | ||
| 1305 | ;; Save user settings or Viper defaults for vars controlled by | 1300 | ;; Save user settings or Viper defaults for vars controlled by |
| 1306 | ;; viper-expert-level | 1301 | ;; viper-expert-level |
| @@ -1350,7 +1345,7 @@ These two lines must come in the order given. | |||
| 1350 | 1345 | ||
| 1351 | 1346 | ||
| 1352 | ;; Intercept maps could go in viper-keym.el | 1347 | ;; Intercept maps could go in viper-keym.el |
| 1353 | ;; We keep them here in case someone redefines them in ~/.viper | 1348 | ;; We keep them here in case someone redefines them in viper-custom-file-name |
| 1354 | 1349 | ||
| 1355 | (define-key viper-vi-intercept-map viper-ESC-key 'viper-intercept-ESC-key) | 1350 | (define-key viper-vi-intercept-map viper-ESC-key 'viper-intercept-ESC-key) |
| 1356 | (define-key viper-insert-intercept-map viper-ESC-key 'viper-intercept-ESC-key) | 1351 | (define-key viper-insert-intercept-map viper-ESC-key 'viper-intercept-ESC-key) |