Commit 4472a196 authored by Glenn Morris's avatar Glenn Morris

register.el doc fixes

* lisp/register.el (register-read-with-preview, point-to-register)
(window-configuration-to-register, frame-configuration-to-register)
(jump-to-register, number-to-register, view-register, insert-register)
(copy-to-register, append-to-register, prepend-to-register)
(copy-rectangle-to-register): Doc fixes.
parent 70e5a261
2014-02-02 Glenn Morris <rgm@gnu.org>
* register.el (register-read-with-preview, point-to-register)
(window-configuration-to-register, frame-configuration-to-register)
(jump-to-register, number-to-register, view-register, insert-register)
(copy-to-register, append-to-register, prepend-to-register)
(copy-rectangle-to-register): Doc fixes.
2014-02-02 Stefan Monnier <monnier@iro.umontreal.ca>
* help-fns.el (help-C-file-name): Handle advised functions (bug#16478).
......
......@@ -145,11 +145,12 @@ Format of each entry is controlled by the variable `register-preview-function'."
(insert (mapconcat register-preview-function register-alist ""))))))
(defun register-read-with-preview (prompt)
"Read and return an event, prompting with PROMPT, possibly showing a preview.
If `register-alist' and `register-preview-delay' are both non-nil,
display a window listing registers after `register-preview-delay' seconds.
If `help-char' (or a member of `help-event-list') is pressed, display
such a window regardless."
"Read and return a register name, possibly showing existing registers.
Prompt with the string PROMPT. If `register-alist' and
`register-preview-delay' are both non-nil, display a window
listing existing registers after `register-preview-delay' seconds.
If `help-char' (or a member of `help-event-list') is pressed,
display such a window regardless."
(let* ((buffer "*Register Preview*")
(timer (when (numberp register-preview-delay)
(run-with-timer register-preview-delay nil
......@@ -176,7 +177,9 @@ such a window regardless."
"Store current location of point in register REGISTER.
With prefix argument, store current frame configuration.
Use \\[jump-to-register] to go to that location or restore that configuration.
Argument is a character, naming the register."
Argument is a character, naming the register.
Interactively, reads the register using `register-read-with-preview'."
(interactive (list (register-read-with-preview "Point to register: ")
current-prefix-arg))
;; Turn the marker into a file-ref if the buffer is killed.
......@@ -188,7 +191,9 @@ Argument is a character, naming the register."
(defun window-configuration-to-register (register &optional _arg)
"Store the window configuration of the selected frame in register REGISTER.
Use \\[jump-to-register] to restore the configuration.
Argument is a character, naming the register."
Argument is a character, naming the register.
Interactively, reads the register using `register-read-with-preview'."
(interactive (list (register-read-with-preview
"Window configuration to register: ")
current-prefix-arg))
......@@ -199,7 +204,9 @@ Argument is a character, naming the register."
(defun frame-configuration-to-register (register &optional _arg)
"Store the window configuration of all frames in register REGISTER.
Use \\[jump-to-register] to restore the configuration.
Argument is a character, naming the register."
Argument is a character, naming the register.
Interactively, reads the register using `register-read-with-preview'."
(interactive (list (register-read-with-preview
"Frame configuration to register: ")
current-prefix-arg))
......@@ -217,7 +224,9 @@ If the register contains a window configuration (one frame) or a frameset
First argument is a character, naming the register.
Optional second arg non-nil (interactively, prefix argument) says to
delete any existing frames that the frameset doesn't mention.
\(Otherwise, these frames are iconified.)"
\(Otherwise, these frames are iconified.)
Interactively, reads the register using `register-read-with-preview'."
(interactive (list (register-read-with-preview "Jump to register: ")
current-prefix-arg))
(let ((val (get-register register)))
......@@ -265,7 +274,9 @@ delete any existing frames that the frameset doesn't mention.
Two args, NUMBER and REGISTER (a character, naming the register).
If NUMBER is nil, a decimal number is read from the buffer starting
at point, and point moves to the end of that number.
Interactively, NUMBER is the prefix arg (none means nil)."
Interactively, NUMBER is the prefix arg (none means nil).
Interactively, reads the register using `register-read-with-preview'."
(interactive (list current-prefix-arg
(register-read-with-preview "Number to register: ")))
(set-register register
......@@ -298,7 +309,9 @@ If REGISTER is empty or if it contains text, call
(defun view-register (register)
"Display what is contained in register named REGISTER.
The Lisp value REGISTER is a character."
The Lisp value REGISTER is a character.
Interactively, reads the register using `register-read-with-preview'."
(interactive (list (register-read-with-preview "View register: ")))
(let ((val (get-register register)))
(if (null val)
......@@ -400,7 +413,9 @@ The Lisp value REGISTER is a character."
"Insert contents of register REGISTER. (REGISTER is a character.)
Normally puts point before and mark after the inserted text.
If optional second arg is non-nil, puts mark before and point after.
Interactively, second arg is non-nil if prefix arg is supplied."
Interactively, second arg is non-nil if prefix arg is supplied.
Interactively, reads the register using `register-read-with-preview'."
(interactive (progn
(barf-if-buffer-read-only)
(list (register-read-with-preview "Insert register: ")
......@@ -431,7 +446,9 @@ With prefix arg, delete as well.
Called from program, takes four args: REGISTER, START, END and DELETE-FLAG.
START and END are buffer positions indicating what to copy.
The optional argument REGION if non-nil, indicates that we're not just copying
some text between START and END, but we're copying the region."
some text between START and END, but we're copying the region.
Interactively, reads the register using `register-read-with-preview'."
(interactive (list (register-read-with-preview "Copy to register: ")
(region-beginning)
(region-end)
......@@ -450,7 +467,9 @@ some text between START and END, but we're copying the region."
"Append region to text in register REGISTER.
With prefix arg, delete as well.
Called from program, takes four args: REGISTER, START, END and DELETE-FLAG.
START and END are buffer positions indicating what to append."
START and END are buffer positions indicating what to append.
Interactively, reads the register using `register-read-with-preview'."
(interactive (list (register-read-with-preview "Append to register: ")
(region-beginning)
(region-end)
......@@ -472,7 +491,9 @@ START and END are buffer positions indicating what to append."
"Prepend region to text in register REGISTER.
With prefix arg, delete as well.
Called from program, takes four args: REGISTER, START, END and DELETE-FLAG.
START and END are buffer positions indicating what to prepend."
START and END are buffer positions indicating what to prepend.
Interactively, reads the register using `register-read-with-preview'."
(interactive (list (register-read-with-preview "Prepend to register: ")
(region-beginning)
(region-end)
......@@ -496,7 +517,9 @@ With prefix arg, delete as well.
To insert this register in the buffer, use \\[insert-register].
Called from a program, takes four args: REGISTER, START, END and DELETE-FLAG.
START and END are buffer positions giving two corners of rectangle."
START and END are buffer positions giving two corners of rectangle.
Interactively, reads the register using `register-read-with-preview'."
(interactive (list (register-read-with-preview
"Copy rectangle to register: ")
(region-beginning)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment