X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/b6e66a5cc78e353ff9ae6cdd0807eefcf55b4934..821b6002127fba1e5b57d39e63eabd0ae189f6af:/doc/misc/tramp.texi diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index a245de8239..d9cb933cb6 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi @@ -66,7 +66,7 @@ @end ifclear @copying -Copyright @copyright{} 1999--2014 Free Software Foundation, Inc. +Copyright @copyright{} 1999--2015 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document @@ -1001,16 +1001,17 @@ name. This special method uses the Android Debug Bridge for accessing Android devices. The Android Debug Bridge must be installed locally. Some GNU/Linux distributions offer it for installation, otherwise it -can be installed as part of the Android SDK. If the @command{adb} +can be installed as part of the Android SDK@. If the @command{adb} program is not found via the @env{PATH} environment variable, the variable @var{tramp-adb-program} must point to its absolute path. -Tramp does not connect Android devices to @command{adb}. This must be -performed outside @value{emacsname}. If there is exactly one Android -device connected to @command{adb}, a host name is not needed in the -remote file name. The default @value{tramp} name to be used is -@file{@trampfn{adb, , ,}} therefore. Otherwise, one could find -potential host names with the command @command{adb devices}. +@value{tramp} does not connect Android devices to @command{adb}, +unless the customer option @option{tramp-adb-connect-if-not-connected} +is non-@code{nil}. If there is exactly one Android device connected +to @command{adb}, a host name is not needed in the remote file name. +The default @value{tramp} name to be used is @file{@trampfn{adb, , ,}}, +therefore. Otherwise, one could find potential host names with the +command @command{adb devices}. Usually, the @command{adb} method does not need any user name. It runs under the permissions of the @command{adbd} process on the @@ -1019,6 +1020,11 @@ Android device. If a user name is specified, @value{tramp} applies an devices, especially with unrooted ones. In that case, an error message is displayed. +If a device shall be connected via TCP/IP, it is possible to declare +the port number to be used like @file{device#42}. Without a port +number, the default value as declared in @command{adb} will be used. +Port numbers are not applicable to Android devices connected via USB. + @end table @@ -1081,6 +1087,7 @@ FUSE, it also needs the SYNCE-GVFS plugin. @end table +@vindex tramp-gvfs-methods @defopt tramp-gvfs-methods This customer option, a list, defines the external methods which shall be used with GVFS@. Per default, these are @option{dav}, @@ -1355,8 +1362,8 @@ bastion host. @vindex tramp-default-proxies-alist @defopt tramp-default-proxies-alist In order to specify multiple hops, it is possible to define a proxy -host to pass through, via the variable -@code{tramp-default-proxies-alist}. This variable keeps a list of +host to pass through, via the customer option +@option{tramp-default-proxies-alist}. This variable keeps a list of triples (@var{host} @var{user} @var{proxy}). The first matching item specifies the proxy host to be passed for a @@ -1470,9 +1477,9 @@ Sometimes they offer limited features only, like running @command{rbash} @vindex tramp-restricted-shell-hosts-alist @defopt tramp-restricted-shell-hosts-alist -This variable keeps a list of regular expressions, which denote hosts -running a registered shell like "rbash". Those hosts can be used as -proxies only. +This customer option keeps a list of regular expressions, which denote +hosts running a registered shell like @command{rbash}. Those hosts +can be used as proxies only. If the bastion host from the example above runs a restricted shell, you shall apply @@ -1788,8 +1795,9 @@ remote file access. @vindex tramp-own-remote-path @defopt tramp-remote-path When @value{tramp} connects to the remote host, it searches for the -programs that it can use. The variable @code{tramp-remote-path} -controls the directories searched on the remote host. +programs that it can use. The customer option +@option{tramp-remote-path} controls the directories searched on the +remote host. By default, this is set to a reasonable set of defaults for most hosts. The symbol @code{tramp-default-remote-path} is a place @@ -1798,7 +1806,7 @@ command @command{getconf PATH} on your remote host. For example, on Debian GNU/Linux this is @file{/bin:/usr/bin}, whereas on Solaris this is @file{/usr/xpg4/bin:/usr/ccs/bin:/usr/bin:/opt/SUNWspro/bin}. It is recommended to apply this symbol on top of -@code{tramp-remote-path}. +@option{tramp-remote-path}. It is possible, however, that your local (or remote ;) system administrator has put the tools you want in some obscure local @@ -2088,6 +2096,7 @@ parameter, you could overwrite the syntax with the following form: @noindent with @samp{192.168.0.1} being the IP address of your remote host (@pxref{Predefined connection information}). + @end table @@ -2591,11 +2600,12 @@ files by other processes. Therefore, during file name completion, the remote directory contents are reread regularly in order to detect such changes, which would be invisible otherwise (@pxref{Connection caching}). +@vindex tramp-completion-reread-directory-timeout @defopt tramp-completion-reread-directory-timeout -This variable defines the number of seconds since last remote command -before rereading a directory contents. A value of 0 would require an -immediate reread during file name completion, @code{nil} means to use -always cached values for the directory contents. +This customer option defines the number of seconds since last remote +command before rereading a directory contents. A value of 0 would +require an immediate reread during file name completion, @code{nil} +means to use always cached values for the directory contents. @end defopt @@ -2634,8 +2644,9 @@ remotehost, /path}} would be sufficient from now on. @vindex tramp-save-ad-hoc-proxies @defopt tramp-save-ad-hoc-proxies This customer option controls whether ad-hoc definitions are kept -persistently in @code{tramp-default-proxies-alist}. That means, those -definitions are available also for future @value{emacsname} sessions. +persistently in @option{tramp-default-proxies-alist}. That means, +those definitions are available also for future @value{emacsname} +sessions. @end defopt @@ -2711,6 +2722,21 @@ following code in your @file{.emacs}: (setq tramp-remote-process-environment process-environment)) @end lisp +When running @code{process-file} or @code{start-file-process} on a +remote @code{default-directory}, the default settings in +@code{process-environment} are not used as it is the case for local +processes. However, if you need environment variables other than set +in @code{tramp-remote-process-environment}, you can let-bind them to +@code{process-environment}. Only those variables will be set then: + +@lisp +(let ((process-environment (cons "HGPLAIN=1" process-environment))) + (process-file @dots{})) +@end lisp + +This works only for environment variables which are not set already in +@code{process-environment}. + If you use other @value{emacsname} packages which do not run out-of-the-box on a remote host, please let us know. We will try to integrate them as well. @xref{Bug Reports}. @@ -2828,7 +2854,7 @@ uid=0(root) gid=0(root) groups=0(root) @cindex gdb @cindex perldb -@file{gud.el} offers an unified interface to several symbolic +@file{gud.el} offers a unified interface to several symbolic debuggers @ifset emacs @ifinfo