tramp.el 171 KB
Newer Older
1
;;; tramp.el --- Transparent Remote Access, Multiple Protocol
Kai Großjohann's avatar
Kai Großjohann committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1998-2016 Free Software Foundation, Inc.
Kai Großjohann's avatar
Kai Großjohann committed
4

Stefan Monnier's avatar
Stefan Monnier committed
5
;; Author: Kai Großjohann <kai.grossjohann@gmx.net>
Michael Albinus's avatar
Michael Albinus committed
6
;;         Michael Albinus <michael.albinus@gmx.de>
Kai Großjohann's avatar
Kai Großjohann committed
7
;; Keywords: comm, processes
8
;; Package: tramp
Kai Großjohann's avatar
Kai Großjohann committed
9 10 11

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Kai Großjohann's avatar
Kai Großjohann committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Kai Großjohann's avatar
Kai Großjohann committed
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Kai Großjohann's avatar
Kai Großjohann committed
24 25 26 27 28 29 30 31

;;; Commentary:

;; This package provides remote file editing, similar to ange-ftp.
;; The difference is that ange-ftp uses FTP to transfer files between
;; the local and the remote host, whereas tramp.el uses a combination
;; of rsh and rcp or other work-alike programs, such as ssh/scp.
;;
32
;; For more detailed instructions, please see the info file.
Kai Großjohann's avatar
Kai Großjohann committed
33 34 35
;;
;; Notes:
;; -----
36
;;
37
;; This package only works for Emacs 22.1 and higher, and for XEmacs 21.4
38
;; and higher.  For XEmacs 21, you need the package `fsf-compat' for
39
;; the `with-timeout' macro.
Kai Großjohann's avatar
Kai Großjohann committed
40 41 42
;;
;; Also see the todo list at the bottom of this file.
;;
43
;; The current version of Tramp can be retrieved from the following URL:
Michael Albinus's avatar
Michael Albinus committed
44
;;            http://ftp.gnu.org/gnu/tramp/
Kai Großjohann's avatar
Kai Großjohann committed
45 46
;;
;; There's a mailing list for this, as well.  Its name is:
Michael Albinus's avatar
Michael Albinus committed
47 48 49
;;            tramp-devel@gnu.org
;; You can use the Web to subscribe, under the following URL:
;;            http://lists.gnu.org/mailman/listinfo/tramp-devel
Kai Großjohann's avatar
Kai Großjohann committed
50 51
;;
;; For the adventurous, the current development sources are available
52
;; via Git.  You can find instructions about this at the following URL:
53
;;            http://savannah.gnu.org/projects/tramp/
Kai Großjohann's avatar
Kai Großjohann committed
54 55 56 57 58
;;
;; Don't forget to put on your asbestos longjohns, first!

;;; Code:

59
(require 'tramp-compat)
Kai Großjohann's avatar
Kai Großjohann committed
60

Michael Albinus's avatar
Michael Albinus committed
61 62
;; Pacify byte-compiler.
(eval-when-compile
Michael Albinus's avatar
Michael Albinus committed
63 64 65 66
  (require 'cl))
(defvar bkup-backup-directory-info)
(defvar directory-sep-char)
(defvar eshell-path-env)
67
(defvar ls-lisp-use-insert-directory-program)
Michael Albinus's avatar
Michael Albinus committed
68
(defvar outline-regexp)
Michael Albinus's avatar
Michael Albinus committed
69

Kai Großjohann's avatar
Kai Großjohann committed
70 71 72
;;; User Customizable Internal Variables:

(defgroup tramp nil
73
  "Edit remote files with a combination of ssh, scp, etc."
74
  :group 'files
75
  :group 'comm
Michael Albinus's avatar
Michael Albinus committed
76
  :link '(custom-manual "(tramp)Top")
77
  :version "22.1")
Kai Großjohann's avatar
Kai Großjohann committed
78

79 80 81
;; Maybe we need once a real Tramp mode, with key bindings etc.
;;;###autoload
(defcustom tramp-mode t
82
  "Whether Tramp is enabled.
83 84 85 86
If it is set to nil, all remote file names are used literally."
  :group 'tramp
  :type 'boolean)

87
(defcustom tramp-verbose 3
88
  "Verbosity level for Tramp messages.
89 90 91 92 93 94 95 96 97 98 99
Any level x includes messages for all levels 1 .. x-1.  The levels are

 0  silent (no tramp messages at all)
 1  errors
 2  warnings
 3  connection to remote hosts (default level)
 4  activities
 5  internal
 6  sent and received strings
 7  file caching
 8  connection properties
100
 9  test commands
101
10  traces (huge)."
Kai Großjohann's avatar
Kai Großjohann committed
102 103 104
  :group 'tramp
  :type 'integer)

105
;; Emacs case.
106 107 108 109 110 111 112
(eval-and-compile
  (when (boundp 'backup-directory-alist)
    (defcustom tramp-backup-directory-alist nil
      "Alist of filename patterns and backup directory names.
Each element looks like (REGEXP . DIRECTORY), with the same meaning like
in `backup-directory-alist'.  If a Tramp file is backed up, and DIRECTORY
is a local file name, the backup directory is prepended with Tramp file
113
name prefix \(method, user, host) of file.
114

115
\(setq tramp-backup-directory-alist backup-directory-alist)
116 117 118 119 120 121 122 123 124 125 126 127

gives the same backup policy for Tramp files on their hosts like the
policy for local files."
      :group 'tramp
      :type '(repeat (cons (regexp :tag "Regexp matching filename")
			   (directory :tag "Backup directory name"))))))

;; XEmacs case.  We cannot check for `bkup-backup-directory-info', because
;; the package "backup-dir" might not be loaded yet.
(eval-and-compile
  (when (featurep 'xemacs)
    (defcustom tramp-bkup-backup-directory-info nil
Michael Albinus's avatar
Michael Albinus committed
128
      "Alist of (FILE-REGEXP BACKUP-DIR OPTIONS ...))
129 130 131
It has the same meaning like `bkup-backup-directory-info' from package
`backup-dir'.  If a Tramp file is backed up, and BACKUP-DIR is a local
file name, the backup directory is prepended with Tramp file name prefix
132
\(method, user, host) of file.
133

134
\(setq tramp-bkup-backup-directory-info bkup-backup-directory-info)
135 136 137

gives the same backup policy for Tramp files on their hosts like the
policy for local files."
138
      :type '(repeat
139 140 141 142 143 144 145 146 147
	      (list (regexp :tag "File regexp")
		    (string :tag "Backup Dir")
		    (set :inline t
			 (const ok-create)
			 (const full-path)
			 (const prepend-name)
			 (const search-upward))))
      :group 'tramp)))

Kai Großjohann's avatar
Kai Großjohann committed
148
(defcustom tramp-auto-save-directory nil
149
  "Put auto-save files in this directory, if set.
150 151
The idea is to use a local directory so that auto-saving is faster.
This setting has precedence over `auto-save-file-name-transforms'."
Kai Großjohann's avatar
Kai Großjohann committed
152
  :group 'tramp
153 154
  :type '(choice (const :tag "Use default" nil)
		 (directory :tag "Auto save directory name")))
Kai Großjohann's avatar
Kai Großjohann committed
155

156 157 158 159
(defcustom tramp-encoding-shell
  (if (memq system-type '(windows-nt))
      (getenv "COMSPEC")
    "/bin/sh")
160
  "Use this program for encoding and decoding commands on the local host.
161 162 163 164 165
This shell is used to execute the encoding and decoding command on the
local host, so if you want to use `~' in those commands, you should
choose a shell here which groks tilde expansion.  `/bin/sh' normally
does not understand tilde expansion.

Paul Eggert's avatar
Paul Eggert committed
166
For encoding and decoding, commands like the following are executed:
167 168 169 170

    /bin/sh -c COMMAND < INPUT > OUTPUT

This variable can be used to change the \"/bin/sh\" part.  See the
171
variable `tramp-encoding-command-switch' for the \"-c\" part.
Kai Großjohann's avatar
Kai Großjohann committed
172

173 174 175
If the shell must be forced to be interactive, see
`tramp-encoding-command-interactive'.

Kai Großjohann's avatar
Kai Großjohann committed
176 177 178 179 180 181
Note that this variable is not used for remote commands.  There are
mechanisms in tramp.el which automatically determine the right shell to
use for the remote host."
  :group 'tramp
  :type '(file :must-match t))

182
(defcustom tramp-encoding-command-switch
Michael Albinus's avatar
Michael Albinus committed
183
  (if (string-match "cmd\\.exe" (or tramp-encoding-shell ""))
184 185
      "/c"
    "-c")
186
  "Use this switch together with `tramp-encoding-shell' for local commands.
187 188 189 190
See the variable `tramp-encoding-shell' for more information."
  :group 'tramp
  :type 'string)

191
(defcustom tramp-encoding-command-interactive
Michael Albinus's avatar
Michael Albinus committed
192
  (unless (string-match "cmd\\.exe" (or tramp-encoding-shell "")) "-i")
193
  "Use this switch together with `tramp-encoding-shell' for interactive shells.
194
See the variable `tramp-encoding-shell' for more information."
195
  :version "24.1"
196 197 198
  :group 'tramp
  :type '(choice (const nil) string))

199
;;;###tramp-autoload
200
(defvar tramp-methods nil
201
  "Alist of methods for remote files.
Kai Großjohann's avatar
Kai Großjohann committed
202 203 204
This is a list of entries of the form (NAME PARAM1 PARAM2 ...).
Each NAME stands for a remote access method.  Each PARAM is a
pair of the form (KEY VALUE).  The following KEYs are defined:
205
  * `tramp-remote-shell'
206 207 208 209 210 211 212
    This specifies the shell to use on the remote host.  This
    MUST be a Bourne-like shell.  It is normally not necessary to
    set this to any value other than \"/bin/sh\": Tramp wants to
    use a shell which groks tilde expansion, but it can search
    for it.  Also note that \"/bin/sh\" exists on all Unixen,
    this might not be true for the value that you decide to use.
    You Have Been Warned.
Michael Albinus's avatar
Michael Albinus committed
213 214 215 216 217 218
  * `tramp-remote-shell-login'
    This specifies the arguments to let `tramp-remote-shell' run
    as a login shell.  It defaults to (\"-l\"), but some shells,
    like ksh, require another argument.  See
    `tramp-connection-properties' for a way to overwrite the
    default value.
219 220
  * `tramp-remote-shell-args'
    For implementation of `shell-command', this specifies the
221
    arguments to let `tramp-remote-shell' run a single command.
222 223
  * `tramp-login-program'
    This specifies the name of the program to use for logging in to the
224 225
    remote host.  This may be the name of rsh or a workalike program,
    or the name of telnet or a workalike, or the name of su or a workalike.
226
  * `tramp-login-args'
Kai Großjohann's avatar
Kai Großjohann committed
227
    This specifies the list of arguments to pass to the above
228
    mentioned program.  Please note that this is a list of list of arguments,
Kai Großjohann's avatar
Kai Großjohann committed
229
    that is, normally you don't want to put \"-a -b\" or \"-f foo\"
230 231 232 233 234 235 236 237 238
    here.  Instead, you want a list (\"-a\" \"-b\"), or (\"-f\" \"foo\").
    There are some patterns: \"%h\" in this list is replaced by the host
    name, \"%u\" is replaced by the user name, \"%p\" is replaced by the
    port number, and \"%%\" can be used to obtain a literal percent character.
    If a list containing \"%h\", \"%u\" or \"%p\" is unchanged during
    expansion (i.e. no host or no user specified), this list is not used as
    argument.  By this, arguments like (\"-l\" \"%u\") are optional.
    \"%t\" is replaced by the temporary file name produced with
    `tramp-make-tramp-temp-file'.  \"%k\" indicates the keep-date
239 240
    parameter of a program, if exists.  \"%c\" adds additional
    `tramp-ssh-controlmaster-options' options for the first hop.
241 242 243
  * `tramp-login-env'
     A list of environment variables and their values, which will
     be set when calling `tramp-login-program'.
244 245 246 247 248
  * `tramp-async-args'
    When an asynchronous process is started, we know already that
    the connection works.  Therefore, we can pass additional
    parameters to suppress diagnostic messages, in order not to
    tamper the process output.
249 250
  * `tramp-copy-program'
    This specifies the name of the program to use for remotely copying
251
    the file; this might be the absolute filename of scp or the name of
252
    a workalike program.  It is always applied on the local host.
253
  * `tramp-copy-args'
Kai Großjohann's avatar
Kai Großjohann committed
254
    This specifies the list of parameters to pass to the above mentioned
255
    program, the hints for `tramp-login-args' also apply here.
256 257 258
  * `tramp-copy-env'
     A list of environment variables and their values, which will
     be set when calling `tramp-copy-program'.
259 260 261 262 263 264 265
  * `tramp-remote-copy-program'
    The listener program to be applied on remote side, if needed.
  * `tramp-remote-copy-args'
    The list of parameters to pass to the listener program, the hints
    for `tramp-login-args' also apply here.  Additionally, \"%r\" could
    be used here and in `tramp-copy-args'.  It denotes a randomly
    chosen port for the remote listener.
266 267 268
  * `tramp-copy-keep-date'
    This specifies whether the copying program when the preserves the
    timestamp of the original file.
269 270 271 272 273
  * `tramp-copy-keep-tmpfile'
    This specifies whether a temporary local file shall be kept
    for optimization reasons (useful for \"rsync\" methods).
  * `tramp-copy-recursive'
    Whether the operation copies directories recursively.
274 275 276 277 278 279 280
  * `tramp-default-port'
    The default port of a method is needed in case of gateway connections.
    Additionally, it is used as indication which method is prepared for
    passing gateways.
  * `tramp-gw-args'
    As the attribute name says, additional arguments are specified here
    when a method is applied via a gateway.
281 282 283
  * `tramp-tmpdir'
    A directory on the remote host for temporary files.  If not
    specified, \"/tmp\" is taken as default.
284 285 286 287 288
  * `tramp-connection-timeout'
    This is the maximum time to be spent for establishing a connection.
    In general, the global default value shall be used, but for
    some methods, like \"su\" or \"sudo\", a shorter timeout
    might be desirable.
289 290 291 292

What does all this mean?  Well, you should specify `tramp-login-program'
for all methods; this program is used to log in to the remote site.  Then,
there are two ways to actually transfer the files between the local and the
293
remote side.  One way is using an additional scp-like program.  If you want
294
to do this, set `tramp-copy-program' in the method.
Kai Großjohann's avatar
Kai Großjohann committed
295 296

Another possibility for file transfer is inline transfer, i.e. the
297
file is passed through the same buffer used by `tramp-login-program'.  In
Kai Großjohann's avatar
Kai Großjohann committed
298
this case, the file contents need to be protected since the
299
`tramp-login-program' might use escape codes or the connection might not
Kai Großjohann's avatar
Kai Großjohann committed
300
be eight-bit clean.  Therefore, file contents are encoded for transit.
301 302
See the variables `tramp-local-coding-commands' and
`tramp-remote-coding-commands' for details.
Kai Großjohann's avatar
Kai Großjohann committed
303

304
So, to summarize: if the method is an out-of-band method, then you
305
must specify `tramp-copy-program' and `tramp-copy-args'.  If it is an
306 307
inline method, then these two parameters should be nil.  Methods which
are fit for gateways must have `tramp-default-port' at least.
Kai Großjohann's avatar
Kai Großjohann committed
308 309 310

Notes:

311 312
When using `su' or `sudo' the phrase \"open connection to a remote
host\" sounds strange, but it is used nevertheless, for consistency.
313 314 315 316
No connection is opened to a remote host, but `su' or `sudo' is
started on the local host.  You should specify a remote host
`localhost' or the name of the local host.  Another host name is
useful only in combination with `tramp-default-proxies-alist'.")
Kai Großjohann's avatar
Kai Großjohann committed
317

318
(defcustom tramp-default-method
Paul Eggert's avatar
Paul Eggert committed
319 320
  ;; An external copy method seems to be preferred, because it performs
  ;; much better for large files, and it hasn't too serious delays
321 322
  ;; for small files.  But it must be ensured that there aren't
  ;; permanent password queries.  Either a password agent like
323 324
  ;; "ssh-agent" or "Pageant" shall run, or the optional
  ;; password-cache.el or auth-sources.el packages shall be active for
325 326 327
  ;; password caching.  If we detect that the user is running OpenSSH
  ;; 4.0 or newer, we could reuse the connection, which calls also for
  ;; an external method.
328
  (cond
Glenn Morris's avatar
Glenn Morris committed
329 330 331 332 333
   ;; PuTTY is installed.  We don't take it, if it is installed on a
   ;; non-windows system, or pscp from the pssh (parallel ssh) package
   ;; is found.
   ((and (eq system-type 'windows-nt)
	 (executable-find "pscp"))
334
    (if	(or (fboundp 'password-read)
335
	    (fboundp 'auth-source-user-or-password)
336
	    (fboundp 'auth-source-search)
337
	    ;; Pageant is running.
338
	    (tramp-compat-process-running-p "Pageant"))
339 340 341 342
	"pscp"
      "plink"))
   ;; There is an ssh installation.
   ((executable-find "scp")
343 344 345 346 347
    (if	(or (fboundp 'password-read)
	    (fboundp 'auth-source-user-or-password)
	    (fboundp 'auth-source-search)
	    ;; ssh-agent is running.
	    (getenv "SSH_AUTH_SOCK")
348
	    (getenv "SSH_AGENT_PID"))
349 350
	"scp"
      "ssh"))
351 352
   ;; Fallback.
   (t "ftp"))
353
  "Default method to use for transferring files.
354
See `tramp-methods' for possibilities.
355
Also see `tramp-default-method-alist'."
356 357 358
  :group 'tramp
  :type 'string)

359
;;;###tramp-autoload
360
(defcustom tramp-default-method-alist nil
361
  "Default method to use for specific host/user pairs.
362 363 364 365 366 367 368 369 370 371 372
This is an alist of items (HOST USER METHOD).  The first matching item
specifies the method to use for a file name which does not specify a
method.  HOST and USER are regular expressions or nil, which is
interpreted as a regular expression which always matches.  If no entry
matches, the variable `tramp-default-method' takes effect.

If the file name does not specify the user, lookup is done using the
empty string for the user name.

See `tramp-methods' for a list of possibilities for METHOD."
  :group 'tramp
373 374 375
  :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
		       (choice :tag "User regexp" regexp sexp)
		       (choice :tag "Method name" string (const nil)))))
376

377
(defcustom tramp-default-user nil
378
  "Default user to use for transferring files.
379 380 381 382 383 384 385
It is nil by default; otherwise settings in configuration files like
\"~/.ssh/config\" would be overwritten.  Also see `tramp-default-user-alist'.

This variable is regarded as obsolete, and will be removed soon."
  :group 'tramp
  :type '(choice (const nil) string))

386
;;;###tramp-autoload
387
(defcustom tramp-default-user-alist nil
388
  "Default user to use for specific method/host pairs.
389 390 391 392 393 394 395 396 397
This is an alist of items (METHOD HOST USER).  The first matching item
specifies the user to use for a file name which does not specify a
user.  METHOD and USER are regular expressions or nil, which is
interpreted as a regular expression which always matches.  If no entry
matches, the variable `tramp-default-user' takes effect.

If the file name does not specify the method, lookup is done using the
empty string for the method name."
  :group 'tramp
398 399 400
  :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
		       (choice :tag "  Host regexp" regexp sexp)
		       (choice :tag "    User name" string (const nil)))))
401

402
(defcustom tramp-default-host (system-name)
403
  "Default host to use for transferring files.
404 405 406 407
Useful for su and sudo methods mostly."
  :group 'tramp
  :type 'string)

408 409 410 411 412 413 414 415 416 417 418 419
;;;###tramp-autoload
(defcustom tramp-default-host-alist nil
  "Default host to use for specific method/user pairs.
This is an alist of items (METHOD USER HOST).  The first matching item
specifies the host to use for a file name which does not specify a
host.  METHOD and HOST are regular expressions or nil, which is
interpreted as a regular expression which always matches.  If no entry
matches, the variable `tramp-default-host' takes effect.

If the file name does not specify the method, lookup is done using the
empty string for the method name."
  :group 'tramp
Glenn Morris's avatar
Glenn Morris committed
420
  :version "24.4"
421 422 423 424
  :type '(repeat (list (choice :tag "Method regexp" regexp sexp)
		       (choice :tag "  User regexp" regexp sexp)
		       (choice :tag "    Host name" string (const nil)))))

425
(defcustom tramp-default-proxies-alist nil
426
  "Route to be followed for specific host/user pairs.
427 428 429
This is an alist of items (HOST USER PROXY).  The first matching
item specifies the proxy to be passed for a file name located on
a remote target matching USER@HOST.  HOST and USER are regular
430 431 432 433 434 435 436 437 438
expressions.  PROXY must be a Tramp filename without a localname
part.  Method and user name on PROXY are optional, which is
interpreted with the default values.  PROXY can contain the
patterns %h and %u, which are replaced by the strings matching
HOST or USER, respectively.

HOST, USER or PROXY could also be Lisp forms, which will be
evaluated.  The result must be a string or nil, which is
interpreted as a regular expression which always matches."
439
  :group 'tramp
440 441
  :type '(repeat (list (choice :tag "Host regexp" regexp sexp)
		       (choice :tag "User regexp" regexp sexp)
442
		       (choice :tag " Proxy name" string (const nil)))))
443

Michael Albinus's avatar
Michael Albinus committed
444 445 446
(defcustom tramp-save-ad-hoc-proxies nil
  "Whether to save ad-hoc proxies persistently."
  :group 'tramp
Glenn Morris's avatar
Glenn Morris committed
447
  :version "24.3"
Michael Albinus's avatar
Michael Albinus committed
448 449
  :type 'boolean)

450 451 452 453 454 455 456 457
(defcustom tramp-restricted-shell-hosts-alist
  (when (memq system-type '(windows-nt))
    (list (concat "\\`" (regexp-quote (system-name)) "\\'")))
  "List of hosts, which run a restricted shell.
This is a list of regular expressions, which denote hosts running
a registered shell like \"rbash\".  Those hosts can be used as
proxies only, see `tramp-default-proxies-alist'.  If the local
host runs a registered shell, it shall be added to this list, too."
458
  :version "24.3"
459 460 461
  :group 'tramp
  :type '(repeat (regexp :tag "Host regexp")))

462
;;;###tramp-autoload
463 464
(defconst tramp-local-host-regexp
  (concat
465 466
   "\\`"
   (regexp-opt
467
    (list "localhost" "localhost6" (system-name) "127.0.0.1" "::1") t)
468
   "\\'")
469
  "Host names which are regarded as local host.")
470

471
(defvar tramp-completion-function-alist nil
472
  "Alist of methods for remote files.
473
This is a list of entries of the form \(NAME PAIR1 PAIR2 ...).
474
Each NAME stands for a remote access method.  Each PAIR is of the form
475
\(FUNCTION FILE).  FUNCTION is responsible to extract user names and host
476 477
names from FILE for completion.  The following predefined FUNCTIONs exists:

478 479 480 481 482 483 484 485
 * `tramp-parse-rhosts'      for \"~/.rhosts\" like files,
 * `tramp-parse-shosts'      for \"~/.ssh/known_hosts\" like files,
 * `tramp-parse-sconfig'     for \"~/.ssh/config\" like files,
 * `tramp-parse-shostkeys'   for \"~/.ssh2/hostkeys/*\" like files,
 * `tramp-parse-sknownhosts' for \"~/.ssh2/knownhosts/*\" like files,
 * `tramp-parse-hosts'       for \"/etc/hosts\" like files,
 * `tramp-parse-passwd'      for \"/etc/passwd\" like files.
 * `tramp-parse-netrc'       for \"~/.netrc\" like files.
Michael Albinus's avatar
Michael Albinus committed
486
 * `tramp-parse-putty'       for PuTTY registered sessions.
487

Michael Albinus's avatar
Michael Albinus committed
488
FUNCTION can also be a user defined function.  For more details see
489 490
the info pages.")

491 492 493
(defconst tramp-echo-mark-marker "_echo"
  "String marker to surround echoed commands.")

494 495 496 497 498 499
(defconst tramp-echo-mark-marker-length (length tramp-echo-mark-marker)
  "String length of `tramp-echo-mark-marker'.")

(defconst tramp-echo-mark
  (concat tramp-echo-mark-marker
	  (make-string tramp-echo-mark-marker-length ?\b))
500 501 502 503 504
  "String mark to be transmitted around shell commands.
Used to separate their echo from the output they produce.  This
will only be used if we cannot disable remote echo via stty.
This string must have no effect on the remote shell except for
producing some echo which can later be detected by
505 506 507
`tramp-echoed-echo-mark-regexp'.  Using `tramp-echo-mark-marker',
followed by an equal number of backspaces to erase them will
usually suffice.")
508

509 510 511
(defconst tramp-echoed-echo-mark-regexp
  (format "%s\\(\b\\( \b\\)?\\)\\{%d\\}"
	  tramp-echo-mark-marker tramp-echo-mark-marker-length)
512 513 514
  "Regexp which matches `tramp-echo-mark' as it gets echoed by
the remote shell.")

515 516
(defcustom tramp-local-end-of-line
  (if (memq system-type '(windows-nt)) "\r\n" "\n")
517
  "String used for end of line in local processes."
518
  :version "24.1"
519 520 521
  :group 'tramp
  :type 'string)

Kai Großjohann's avatar
Kai Großjohann committed
522
(defcustom tramp-rsh-end-of-line "\n"
523
  "String used for end of line in rsh connections.
Kai Großjohann's avatar
Kai Großjohann committed
524
I don't think this ever needs to be changed, so please tell me about it
Michael Albinus's avatar
Michael Albinus committed
525
if you need to change this."
Kai Großjohann's avatar
Kai Großjohann committed
526 527 528 529
  :group 'tramp
  :type 'string)

(defcustom tramp-login-prompt-regexp
Michael Albinus's avatar
Michael Albinus committed
530
  ".*\\(user\\|login\\)\\( .*\\)?: *"
531
  "Regexp matching login-like prompts.
532 533 534
The regexp should match at end of buffer.

Sometimes the prompt is reported to look like \"login as:\"."
Kai Großjohann's avatar
Kai Großjohann committed
535 536 537
  :group 'tramp
  :type 'regexp)

Kai Großjohann's avatar
Kai Großjohann committed
538
(defcustom tramp-shell-prompt-pattern
539
  ;; Allow a prompt to start right after a ^M since it indeed would be
540 541
  ;; displayed at the beginning of the line (and Zsh uses it).  This
  ;; regexp works only for GNU Emacs.
Michael Albinus's avatar
Michael Albinus committed
542 543
  ;; Allow also [] style prompts.  They can appear only during
  ;; connection initialization; Tramp redefines the prompt afterwards.
544
  (concat (if (featurep 'xemacs) "" "\\(?:^\\|\r\\)")
Michael Albinus's avatar
Michael Albinus committed
545
	  "[^]#$%>\n]*#?[]#$%>] *\\(\e\\[[0-9;]*[a-zA-Z] *\\)*")
Kai Großjohann's avatar
Kai Großjohann committed
546 547 548 549 550 551
  "Regexp to match prompts from remote shell.
Normally, Tramp expects you to configure `shell-prompt-pattern'
correctly, but sometimes it happens that you are connecting to a
remote host which sends a different kind of shell prompt.  Therefore,
Tramp recognizes things matched by `shell-prompt-pattern' as prompt,
and also things matched by this variable.  The default value of this
552
variable is similar to the default value of `shell-prompt-pattern',
553 554 555 556
which should work well in many cases.

This regexp must match both `tramp-initial-end-of-output' and
`tramp-end-of-output'."
Kai Großjohann's avatar
Kai Großjohann committed
557 558 559
  :group 'tramp
  :type 'regexp)

Kai Großjohann's avatar
Kai Großjohann committed
560
(defcustom tramp-password-prompt-regexp
Michael Albinus's avatar
Michael Albinus committed
561 562 563 564
  (format "^.*\\(%s\\).*:\^@? *"
	  (if (boundp 'password-word-equivalents)
	      (regexp-opt (symbol-value 'password-word-equivalents))
	    "password\\|passphrase"))
565
  "Regexp matching password-like prompts.
Kai Großjohann's avatar
Kai Großjohann committed
566
The regexp should match at end of buffer.
Kai Großjohann's avatar
Kai Großjohann committed
567 568

The `sudo' program appears to insert a `^@' character into the prompt."
569
  :version "24.4"
Kai Großjohann's avatar
Kai Großjohann committed
570 571 572 573
  :group 'tramp
  :type 'regexp)

(defcustom tramp-wrong-passwd-regexp
Kai Großjohann's avatar
Kai Großjohann committed
574 575
  (concat "^.*"
	  ;; These strings should be on the last line
576
	  (regexp-opt '("Permission denied"
Kai Großjohann's avatar
Kai Großjohann committed
577 578 579
			"Login incorrect"
			"Login Incorrect"
			"Connection refused"
580
			"Connection closed"
Michael Albinus's avatar
Michael Albinus committed
581
			"Timeout, server not responding."
Kai Großjohann's avatar
Kai Großjohann committed
582 583
			"Sorry, try again."
			"Name or service not known"
584
			"Host key verification failed."
585
			"No supported authentication methods left to try!") t)
Kai Großjohann's avatar
Kai Großjohann committed
586 587 588 589 590 591
	  ".*"
	  "\\|"
	  "^.*\\("
	  ;; Here comes a list of regexes, separated by \\|
	  "Received signal [0-9]+"
	  "\\).*")
592
  "Regexp matching a `login failed' message.
Kai Großjohann's avatar
Kai Großjohann committed
593 594 595 596 597
The regexp should match at end of buffer."
  :group 'tramp
  :type 'regexp)

(defcustom tramp-yesno-prompt-regexp
Kai Großjohann's avatar
Kai Großjohann committed
598 599 600 601
  (concat
   (regexp-opt '("Are you sure you want to continue connecting (yes/no)?") t)
   "\\s-*")
  "Regular expression matching all yes/no queries which need to be confirmed.
Kai Großjohann's avatar
Kai Großjohann committed
602
The confirmation should be done with yes or no.
Kai Großjohann's avatar
Kai Großjohann committed
603 604
The regexp should match at end of buffer.
See also `tramp-yn-prompt-regexp'."
Kai Großjohann's avatar
Kai Großjohann committed
605 606 607
  :group 'tramp
  :type 'regexp)

Kai Großjohann's avatar
Kai Großjohann committed
608
(defcustom tramp-yn-prompt-regexp
Michael Albinus's avatar
Michael Albinus committed
609 610 611 612
  (concat
   (regexp-opt '("Store key in cache? (y/n)"
		 "Update cached key? (y/n, Return cancels connection)") t)
   "\\s-*")
Kai Großjohann's avatar
Kai Großjohann committed
613 614 615 616 617 618
  "Regular expression matching all y/n queries which need to be confirmed.
The confirmation should be done with y or n.
The regexp should match at end of buffer.
See also `tramp-yesno-prompt-regexp'."
  :group 'tramp
  :type 'regexp)
Kai Großjohann's avatar
Kai Großjohann committed
619 620 621 622 623 624 625 626 627 628 629 630

(defcustom tramp-terminal-prompt-regexp
  (concat "\\("
	  "TERM = (.*)"
	  "\\|"
	  "Terminal type\\? \\[.*\\]"
	  "\\)\\s-*")
  "Regular expression matching all terminal setting prompts.
The regexp should match at end of buffer.
The answer will be provided by `tramp-action-terminal', which see."
  :group 'tramp
  :type 'regexp)
Kai Großjohann's avatar
Kai Großjohann committed
631

Michael Albinus's avatar
Michael Albinus committed
632 633 634 635 636 637 638 639 640
(defcustom tramp-operation-not-permitted-regexp
  (concat "\\(" "preserving times.*" "\\|" "set mode" "\\)" ":\\s-*"
	  (regexp-opt '("Operation not permitted") t))
  "Regular expression matching keep-date problems in (s)cp operations.
Copying has been performed successfully already, so this message can
be ignored safely."
  :group 'tramp
  :type 'regexp)

641 642 643 644 645 646 647 648 649 650 651
(defcustom tramp-copy-failed-regexp
  (concat "\\(.+: "
          (regexp-opt '("Permission denied"
                        "not a regular file"
                        "is a directory"
                        "No such file or directory") t)
          "\\)\\s-*")
  "Regular expression matching copy problems in (s)cp operations."
  :group 'tramp
  :type 'regexp)

652
(defcustom tramp-process-alive-regexp
653
  ""
654
  "Regular expression indicating a process has finished.
655 656
In fact this expression is empty by intention, it will be used only to
check regularly the status of the associated process.
Kai Großjohann's avatar
Kai Großjohann committed
657
The answer will be provided by `tramp-action-process-alive',
658
`tramp-action-out-of-band', which see."
659 660 661
  :group 'tramp
  :type 'regexp)

662
(defconst tramp-temp-name-prefix "tramp."
663
  "Prefix to use for temporary files.
Kai Großjohann's avatar
Kai Großjohann committed
664 665
If this is a relative file name (such as \"tramp.\"), it is considered
relative to the directory name returned by the function
666
`tramp-compat-temporary-file-directory' (which see).  It may also be an
Kai Großjohann's avatar
Kai Großjohann committed
667
absolute file name; don't forget to include a prefix for the filename
668
part, though.")
Kai Großjohann's avatar
Kai Großjohann committed
669

670 671 672 673
(defconst tramp-temp-buffer-name " *tramp temp*"
  "Buffer name for a temporary buffer.
It shall be used in combination with `generate-new-buffer-name'.")

674 675 676 677
(defvar tramp-temp-buffer-file-name nil
  "File name of a persistent local temporary file.
Useful for \"rsync\" like methods.")
(make-variable-buffer-local 'tramp-temp-buffer-file-name)
678
(put 'tramp-temp-buffer-file-name 'permanent-local t)
679

680 681 682 683 684 685 686 687 688
;; XEmacs is distributed with few Lisp packages.  Further packages are
;; installed using EFS.  If we use a unified filename format, then
;; Tramp is required in addition to EFS.  (But why can't Tramp just
;; disable EFS when Tramp is loaded?  Then XEmacs can ship with EFS
;; just like before.)  Another reason for using a separate filename
;; syntax on XEmacs is that EFS hooks into XEmacs in many places, but
;; Tramp only knows how to deal with `file-name-handler-alist', not
;; the other places.

Michael Albinus's avatar
Michael Albinus committed
689
;; Currently, we have the choice between 'ftp and 'sep.
690 691 692 693 694 695 696
;;;###autoload
(defcustom tramp-syntax
  (if (featurep 'xemacs) 'sep 'ftp)
  "Tramp filename syntax to be used.

It can have the following values:

697 698
  `ftp' -- Ange-FTP respective EFS like syntax (GNU Emacs default)
  `sep' -- Syntax as defined for XEmacs."
699
  :group 'tramp
Michael Albinus's avatar
Michael Albinus committed
700 701 702
  :version "24.4"
  :type `(choice (const :tag  ,(if (featurep 'xemacs) "EFS" "Ange-FTP") ftp)
		 (const :tag "XEmacs" sep)))
703 704 705 706 707

(defconst tramp-prefix-format
  (cond ((equal tramp-syntax 'ftp) "/")
	((equal tramp-syntax 'sep) "/[")
	(t (error "Wrong `tramp-syntax' defined")))
708
  "String matching the very beginning of Tramp file names.
709
Used in `tramp-make-tramp-file-name'.")
710

711
(defconst tramp-prefix-regexp
712
  (concat "^" (regexp-quote tramp-prefix-format))
713
  "Regexp matching the very beginning of Tramp file names.
714
Should always start with \"^\". Derived from `tramp-prefix-format'.")
715

716
(defconst tramp-method-regexp
717
  "[a-zA-Z_0-9-]+"
718
  "Regexp matching methods identifiers.")
719

720 721 722 723
(defconst tramp-postfix-method-format
  (cond ((equal tramp-syntax 'ftp) ":")
	((equal tramp-syntax 'sep) "/")
	(t (error "Wrong `tramp-syntax' defined")))
724
  "String matching delimiter between method and user or host names.
725
Used in `tramp-make-tramp-file-name'.")
726

727 728
(defconst tramp-postfix-method-regexp
  (regexp-quote tramp-postfix-method-format)
729
  "Regexp matching delimiter between method and user or host names.
730
Derived from `tramp-postfix-method-format'.")
731

Michael Albinus's avatar
Michael Albinus committed
732
(defconst tramp-user-regexp "[^/|: \t]+"
733
  "Regexp matching user names.")
734

735
;;;###tramp-autoload
736
(defconst tramp-prefix-domain-format "%"
737
  "String matching delimiter between user and domain names.")
738

739
;;;###tramp-autoload
740 741
(defconst tramp-prefix-domain-regexp
  (regexp-quote tramp-prefix-domain-format)
742
  "Regexp matching delimiter between user and domain names.
743 744
Derived from `tramp-prefix-domain-format'.")

745
(defconst tramp-domain-regexp "[-a-zA-Z0-9_.]+"
746
  "Regexp matching domain names.")
747 748 749 750 751

(defconst tramp-user-with-domain-regexp
  (concat "\\(" tramp-user-regexp "\\)"
	        tramp-prefix-domain-regexp
	  "\\(" tramp-domain-regexp "\\)")
752
  "Regexp matching user names with domain names.")
753

754
(defconst tramp-postfix-user-format "@"
755
  "String matching delimiter between user and host names.
756
Used in `tramp-make-tramp-file-name'.")
757

758
(defconst tramp-postfix-user-regexp
759
  (regexp-quote tramp-postfix-user-format)
760
  "Regexp matching delimiter between user and host names.
761 762
Derived from `tramp-postfix-user-format'.")

763
(defconst tramp-host-regexp "[a-zA-Z0-9_.-]+"
764
  "Regexp matching host names.")
765

766 767 768 769
(defconst tramp-prefix-ipv6-format
  (cond ((equal tramp-syntax 'ftp) "[")
	((equal tramp-syntax 'sep) "")
	(t (error "Wrong `tramp-syntax' defined")))
770
  "String matching left hand side of IPv6 addresses.
771 772 773 774
Used in `tramp-make-tramp-file-name'.")

(defconst tramp-prefix-ipv6-regexp
  (regexp-quote tramp-prefix-ipv6-format)
775
  "Regexp matching left hand side of IPv6 addresses.
776 777
Derived from `tramp-prefix-ipv6-format'.")

778 779 780
;; The following regexp is a bit sloppy.  But it shall serve our
;; purposes.  It covers also IPv4 mapped IPv6 addresses, like in
;; "::ffff:192.168.0.1".
781
(defconst tramp-ipv6-regexp
782
  "\\(?:\\(?:[a-zA-Z0-9]+\\)?:\\)+[a-zA-Z0-9.]+"
783
  "Regexp matching IPv6 addresses.")
784 785 786 787 788

(defconst tramp-postfix-ipv6-format
  (cond ((equal tramp-syntax 'ftp) "]")
	((equal tramp-syntax 'sep) "")
	(t (error "Wrong `tramp-syntax' defined")))
789
  "String matching right hand side of IPv6 addresses.
790 791 792 793
Used in `tramp-make-tramp-file-name'.")

(defconst tramp-postfix-ipv6-regexp
  (regexp-quote tramp-postfix-ipv6-format)
794
  "Regexp matching right hand side of IPv6 addresses.
795 796
Derived from `tramp-postfix-ipv6-format'.")

797 798 799 800
(defconst tramp-prefix-port-format
  (cond ((equal tramp-syntax 'ftp) "#")
	((equal tramp-syntax 'sep) "#")
	(t (error "Wrong `tramp-syntax' defined")))
801
  "String matching delimiter between host names and port numbers.")
802 803 804

(defconst tramp-prefix-port-regexp
  (regexp-quote tramp-prefix-port-format)
805
  "Regexp matching delimiter between host names and port numbers.
806 807
Derived from `tramp-prefix-port-format'.")

808
(defconst tramp-port-regexp "[0-9]+"
809
  "Regexp matching port numbers.")
810 811 812 813 814

(defconst tramp-host-with-port-regexp
  (concat "\\(" tramp-host-regexp "\\)"
	        tramp-prefix-port-regexp
	  "\\(" tramp-port-regexp "\\)")
815
  "Regexp matching host names with port numbers.")
816

Michael Albinus's avatar
Michael Albinus committed
817 818 819 820 821 822 823 824
(defconst tramp-postfix-hop-format "|"
  "String matching delimiter after ad-hoc hop definitions.")

(defconst tramp-postfix-hop-regexp
  (regexp-quote tramp-postfix-hop-format)
  "Regexp matching delimiter after ad-hoc hop definitions.
Derived from `tramp-postfix-hop-format'.")

825 826 827 828
(defconst tramp-postfix-host-format
  (cond ((equal tramp-syntax 'ftp) ":")
	((equal tramp-syntax 'sep) "]")
	(t (error "Wrong `tramp-syntax' defined")))
829
  "String matching delimiter between host names and localnames.
830
Used in `tramp-make-tramp-file-name'.")
831

832
(defconst tramp-postfix-host-regexp
833
  (regexp-quote tramp-postfix-host-format)
834
  "Regexp matching delimiter between host names and localnames.
835
Derived from `tramp-postfix-host-format'.")
836

837
(defconst tramp-localname-regexp ".*$"
838
  "Regexp matching localnames.")
839

840
;;; File name format:
841

Michael Albinus's avatar
Michael Albinus committed
842 843 844 845 846
(defconst tramp-remote-file-name-spec-regexp
  (concat
   "\\(?:" "\\("   tramp-method-regexp "\\)" tramp-postfix-method-regexp "\\)?"
   "\\(?:" "\\("   tramp-user-regexp   "\\)" tramp-postfix-user-regexp   "\\)?"
   "\\("   "\\(?:" tramp-host-regexp   "\\|"
847
	           tramp-prefix-ipv6-regexp  "\\(?:" tramp-ipv6-regexp "\\)?"
Michael Albinus's avatar
Michael Albinus committed
848 849 850 851
		 			     tramp-postfix-ipv6-regexp "\\)"
	   "\\(?:" tramp-prefix-port-regexp  tramp-port-regexp "\\)?" "\\)?")
"Regular expression matching a Tramp file name between prefix and postfix.")

852
(defconst tramp-file-name-structure
853 854 855
  (list
   (concat
    tramp-prefix-regexp
Michael Albinus's avatar
Michael Albinus committed
856 857 858
    "\\(" "\\(?:" tramp-remote-file-name-spec-regexp
                  tramp-postfix-hop-regexp "\\)+" "\\)?"
    tramp-remote-file-name-spec-regexp tramp-postfix-host-regexp
859
    "\\(" tramp-localname-regexp "\\)")
Michael Albinus's avatar
Michael Albinus committed
860 861
   5 6 7 8 1)
  "List of six elements (REGEXP METHOD USER HOST FILE HOP), detailing \
862
the Tramp file name structure.
Kai Großjohann's avatar
Kai Großjohann committed
863

864
The first element REGEXP is a regular expression matching a Tramp file
Kai Großjohann's avatar
Kai Großjohann committed
865 866 867 868 869 870 871
name.  The regex should contain parentheses around the method name,
the user name, the host name, and the file name parts.

The second element METHOD is a number, saying which pair of
parentheses matches the method name.  The third element USER is
similar, but for the user name.  The fourth element HOST is similar,
but for the host name.  The fifth element FILE is for the file name.
Michael Albinus's avatar
Michael Albinus committed
872 873 874
The last element HOP is the ad-hoc hop definition, which could be a
cascade of several hops.

Kai Großjohann's avatar
Kai Großjohann committed
875 876 877
These numbers are passed directly to `match-string', which see.  That
means the opening parentheses are counted to identify the pair.

878
See also `tramp-file-name-regexp'.")
Kai Großjohann's avatar
Kai Großjohann committed
879 880

;;;###autoload
881
(defconst tramp-file-name-regexp-unified
882
  (if (memq system-type '(cygwin windows-nt))