summaryrefslogtreecommitdiff
path: root/lisp/emulation
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2014-01-26 18:02:28 -0800
committerGlenn Morris <rgm@gnu.org>2014-01-26 18:02:28 -0800
commitece4bae50f6ca8d03d076aa33eedd014a3af8c41 (patch)
tree66910ffa712f0643475284089989667641d1d5d2 /lisp/emulation
parent6ea71a445d523ff95a2cd6ae0cbde8bd7ca8d878 (diff)
downloademacs-ece4bae50f6ca8d03d076aa33eedd014a3af8c41.tar.gz
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.el3
-rw-r--r--lisp/emulation/viper-init.el2
-rw-r--r--lisp/emulation/viper-keym.el4
-rw-r--r--lisp/emulation/viper-macs.el22
-rw-r--r--lisp/emulation/viper.el33
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. "
(if (featurep 'xemacs) "X" "")
))))))
-;; Ex source command. Loads the file specified as argument or `~/.viper'
+;; Ex source command.
+;; Loads the file specified as argument or viper-custom-file-name.
(defun ex-source ()
(viper-get-ex-file)
(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."
(defcustom viper-vi-style-in-minibuffer t
"If t, use vi-style editing in minibuffer.
-Should be set in `~/.viper' file."
+Should be set in `viper-custom-file-name'."
:type 'boolean
:group 'viper)
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.")
(defvar viper-empty-keymap (make-sparse-keymap))
;; This was the main Vi mode in old versions of VIP which may have been
-;; extensively used by VIP users. We declare it as a global var
-;; and, after .viper is loaded, we add this keymap to viper-vi-basic-map.
+;; extensively used by VIP users. We declare it as a global var and, after
+;; viper-custom-file-name is loaded, we add this keymapto viper-vi-basic-map.
(defvar viper-mode-map (make-sparse-keymap))
;; 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.,
;; More general definitions are inherited by more specific scopes:
;; global->major mode->buffer. More specific definitions override more general
(defun viper-record-kbd-macro (macro-name state macro-body &optional scope)
- "Record a Vi macro. Can be used in `.viper' file to define permanent macros.
+ "Record a Vi macro.
+Can be used in `viper-custom-file-name' to define permanent macros.
MACRO-NAME is a string of characters or a vector of keys. STATE is
either `vi-state' or `insert-state'. It specifies the Viper state in which to
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."
(error "Can't map an empty macro name"))
;; Macro-name is usually a vector. However, command history or macros
- ;; recorded in ~/.viper may be recorded as strings. So, convert to
- ;; vectors.
+ ;; recorded in viper-custom-file-name may be recorded as strings.
+ ;; So, convert to vectors.
(setq macro-name (viper-fixup-macro macro-name))
(if (viper-char-array-p macro-name)
(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."
;; if we don't let vector macro-body through %S,
;; the symbols `\.' `\[' etc will be converted into
;; characters, causing invalid read error on recorded
- ;; macros in .viper.
+ ;; macros in viper-custom-file-name.
;; I am not sure is macro-body can still be a string at
;; this point, but I am preserving this option anyway.
(if (vectorp macro-body)
@@ -483,11 +484,11 @@ If SCOPE is nil, the user is asked to specify the scope."
;; in effect
(defun viper-unrecord-kbd-macro (macro-name state)
"Delete macro MACRO-NAME from Viper STATE.
-MACRO-NAME must be a vector of viper-style keys. This command is used by Viper
-internally, but the user can also use it in ~/.viper to delete pre-defined
-macros supplied with Viper. The best way to avoid mistakes in macro names to
-be passed to this function is to use viper-describe-kbd-macros and copy the
-name from there."
+MACRO-NAME must be a vector of viper-style keys. This command is used
+by Viper internally, but you can also use it in `viper-custom-file-name'
+to delete pre-defined macros supplied with Viper. The best way to avoid
+mistakes in macro names to be passed to this function is to use
+`viper-describe-kbd-macros' and copy the name from there."
(let* (state-name keymap
(macro-alist-var
(cond ((eq state 'vi-state)
@@ -507,7 +508,8 @@ name from there."
macro-pair macro-entry)
;; Macro-name is usually a vector. However, command history or macros
- ;; recorded in ~/.viper may appear as strings. So, convert to vectors.
+ ;; recorded in viper-custom-file-name may appear as strings.
+ ;; So, convert to vectors.
(setq macro-name (viper-fixup-macro macro-name))
(if (viper-char-array-p macro-name)
(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 @@
;;
;; The last viper-vi-basic-minor-mode contains most of the usual Vi bindings
;; in its edit mode. This mode provides access to all Emacs facilities.
-;; Novice users, however, may want to set their viper-expert-level to 1
-;; in their .viper file. This will enable viper-vi-diehard-minor-mode. This
-;; minor mode's bindings make Viper simulate the usual Vi very closely.
+;; Novice users, however, may want to set their viper-expert-level to 1 in
+;; their viper-custom-file-name. This will enable viper-vi-diehard-minor-mode.
+;; This minor mode's bindings make Viper simulate the usual Vi very closely.
;; For instance, C-c will not have its standard Emacs binding
;; and so many of the goodies of Emacs are not available.
;;
@@ -165,12 +165,12 @@
;;
;; Viper gurus should have at least
;; (setq viper-expert-level 4)
-;; in their ~/.viper files. This will unsuppress all Emacs keys that are not
-;; essential for VI-style editing.
+;; in their viper-custom-file-name. This will unsuppress all Emacs keys
+;; that are not essential for VI-style editing.
;; Pick-and-choose users may want to put
;; (setq viper-expert-level 5)
-;; in ~/.viper. Viper will then leave it up to the user to set the variables
-;; viper-want-* See viper-set-expert-level for details.
+;; in viper-custom-file-name. Viper will then leave it up to the user to
+;; set the variables viper-want-* See viper-set-expert-level for details.
;;
;; The very first minor mode, viper-vi-intercept-minor-mode, is of no
;; 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'.")
(defgroup viper nil
"Vi emulation within Emacs.
-NOTE: Viper customization should be saved in `viper-custom-file-name', which
-defaults to `~/.viper'."
+NOTE: Viper customization should be saved in `viper-custom-file-name'."
:prefix "viper-"
:group 'emulations)
@@ -1222,11 +1221,7 @@ If you wish to Viperize AND make this your way of life, please put
(require 'viper)
in your init file (preferably, close to the top).
-These two lines must come in the order given.
-
-** Viper users:
- **** The startup file name has been changed from .vip to .viper
- **** All vip-* style names have been converted to viper-* style."))
+These two lines must come in the order given."))
(if (y-or-n-p "Viperize? ")
(setq viper-mode t)
(setq viper-mode nil))
@@ -1268,8 +1263,8 @@ These two lines must come in the order given.
;; Set some useful macros, advices
-;; These must be BEFORE ~/.viper is loaded,
-;; so the user can unrecord them in ~/.viper.
+;; These must be BEFORE viper-custom-file-name is loaded,
+;; so the user can unrecord them in viper-custom-file-name.
(if viper-mode
(progn
;; set advices and some variables that give emacs Vi look.
@@ -1289,7 +1284,7 @@ These two lines must come in the order given.
;; Make %%% toggle parsing comments for matching parentheses
(viper-set-parsing-style-toggling-macro nil)
- ;; ~/.viper is loaded if exists
+ ;; viper-custom-file-name is loaded if exists
(viper-load-custom-file)
;; 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.
-;; Applying Viper customization -- runs after (load .viper)
+;; Applying Viper customization -- runs after (load viper-custom-file-name)
;; Save user settings or Viper defaults for vars controlled by
;; viper-expert-level
@@ -1350,7 +1345,7 @@ These two lines must come in the order given.
;; Intercept maps could go in viper-keym.el
-;; We keep them here in case someone redefines them in ~/.viper
+;; We keep them here in case someone redefines them in viper-custom-file-name
(define-key viper-vi-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
(define-key viper-insert-intercept-map viper-ESC-key 'viper-intercept-ESC-key)