Next: Variable Aliases, Previous: Directory Local Variables, Up: Variables [Contents][Index]
Connection-local variables provide a general mechanism for different variable settings in buffers with a remote connection. They are bound and set depending on the remote connection a buffer is dedicated to.
This function defines a set of variable settings for the connection
profile, which is a symbol. You can later assign the connection
profile to one or more remote connections, and Emacs will apply those
variable settings to all process buffers for those connections. The
list in variables is an alist of the form
(name . value)
. Example:
(connection-local-set-profile-variables 'remote-bash '((shell-file-name . "/bin/bash") (shell-command-switch . "-c") (shell-interactive-switch . "-i") (shell-login-switch . "-l")))
(connection-local-set-profile-variables 'remote-ksh '((shell-file-name . "/bin/ksh") (shell-command-switch . "-c") (shell-interactive-switch . "-i") (shell-login-switch . "-l")))
(connection-local-set-profile-variables 'remote-null-device '((null-device . "/dev/null")))
This alist holds the connection profile symbols and the associated
variable settings. It is updated by
connection-local-set-profile-variables
.
This function assigns profiles, which are symbols, to all remote
connections identified by criteria. criteria is a plist
identifying a connection and the application using this connection.
Property names might be :application
, :protocol
,
:user
and :machine
. The property value of
:application
is a symbol, all other property values are
strings. All properties are optional; if criteria is nil
, it
always applies. Example:
(connection-local-set-profiles '(:application 'tramp :protocol "ssh" :machine "localhost") 'remote-bash 'remote-null-device)
(connection-local-set-profiles '(:application 'tramp :protocol "sudo" :user "root" :machine "localhost") 'remote-ksh 'remote-null-device)
If criteria is nil
, it applies for all remote connections.
Therefore, the example above would be equivalent to
(connection-local-set-profiles '(:application 'tramp :protocol "ssh" :machine "localhost") 'remote-bash)
(connection-local-set-profiles '(:application 'tramp :protocol "sudo" :user "root" :machine "localhost") 'remote-ksh)
(connection-local-set-profiles nil 'remote-null-device)
Any connection profile of profiles must have been already
defined by connection-local-set-profile-variables
.
This alist contains connection criteria and their assigned profile
names. The function connection-local-set-profiles
updates this
list.
This function collects applicable connection-local variables
associated with criteria in
connection-local-variables-alist
, without applying them.
Example:
(hack-connection-local-variables '(:application 'tramp :protocol "ssh" :machine "localhost"))
connection-local-variables-alist ⇒ ((null-device . "/dev/null") (shell-login-switch . "-l") (shell-interactive-switch . "-i") (shell-command-switch . "-c") (shell-file-name . "/bin/bash"))
This function looks for connection-local variables according to criteria, and immediately applies them in the current buffer.
All connection-local variables, which are specified by
default-directory
, are applied.
After that, body is executed, and the connection-local variables are unwound. Example:
(connection-local-set-profile-variables 'remote-perl '((perl-command-name . "/usr/local/bin/perl") (perl-command-switch . "-e %s")))
(connection-local-set-profiles '(:application 'tramp :protocol "ssh" :machine "remotehost") 'remote-perl)
(let ((default-directory "/ssh:remotehost:/working/dir/")) (with-connection-local-variables do something useful))
If nil
, connection-local variables are ignored. This variable
shall be changed temporarily only in special modes.
Next: Variable Aliases, Previous: Directory Local Variables, Up: Variables [Contents][Index]