Function: file-name-quote

file-name-quote is a byte-compiled function defined in files.el.gz.

Signature

(file-name-quote NAME &optional TOP)

Documentation

Add the quotation prefix "/:" to file NAME.

If NAME is a remote file name and TOP is nil, the local part of NAME is quoted. If NAME is already a quoted file name, NAME is returned unchanged.

Other relevant functions are documented in the file-name group.

View in manual

Probably introduced at or before Emacs version 26.1.

Shortdoc

;; file-name
(file-name-quote "/tmp/foo")
    => "/:/tmp/foo"

Source Code

;; Defined in /usr/src/emacs/lisp/files.el.gz
(defsubst file-name-quote (name &optional top)
  "Add the quotation prefix \"/:\" to file NAME.
If NAME is a remote file name and TOP is nil, the local part of
NAME is quoted.  If NAME is already a quoted file name, NAME is
returned unchanged."
  (let ((file-name-handler-alist (unless top file-name-handler-alist)))
    (if (file-name-quoted-p name top)
        name
      (concat (file-remote-p name) "/:" (file-local-name name)))))