Function: file-to-register

file-to-register is an interactive and byte-compiled function defined in register.el.gz.

Signature

(file-to-register FILE-NAME REGISTER)

Documentation

Insert FILE-NAME into REGISTER.

To visit the file, use C-x r j (jump-to-register).

Interactively, prompt for REGISTER using register-read-with-preview. With a prefix-argument, prompt for FILE-NAME using read-file-name, With no prefix-argument, use the currently visited file or directory for FILE-NAME.

View in manual

Probably introduced at or before Emacs version 31.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/register.el.gz
(defun file-to-register (file-name register)
  "Insert FILE-NAME into REGISTER.
To visit the file, use \\[jump-to-register].

Interactively, prompt for REGISTER using `register-read-with-preview'.
With a prefix-argument, prompt for FILE-NAME using `read-file-name',
With no prefix-argument, use the currently visited file or directory
for FILE-NAME."
  (interactive (list (if (eq current-prefix-arg nil)
                         (if (eq major-mode 'dired-mode)
                             (dired-current-directory)
                           (buffer-file-name))
                       (read-file-name "File: "))
                (register-read-with-preview "File to register: ")))
  (unless (eq file-name nil)
    (set-register register (cons 'file file-name))))