comparison man/tramp.texi @ 46366:93ea423da06e

Index entries.

46365:4ad453c26cf3

@xref{Bug Reports}.


@subsubheading Behind the scenes
@cindex behind the scenes

This section tries to explain what goes on behind the scenes when you
access a remote file through @tramp{}.

Suppose you type @kbd{C-x C-f} and enter part of an @tramp{} file name,

@table @asis
@item @option{rm}  ---  @command{rsh} with @command{mimencode}
@cindex method rm
@cindex rm method
@cindex method using rsh

Connect to the remote host with @command{rsh} and use base64 encoding to
transfer files between the machines.

This requires the @command{mimencode} command that is part of the

@item @option{sm}  ---  @command{ssh} with @command{mimencode}
@cindex method sm
@cindex sm method
@cindex method using ssh
@cindex ssh
@cindex mimencode
@cindex base-64 encoding

Connect to the remote host with @command{ssh} and use base64 encoding to
transfer files between the machines.

This is identical to the previous option except that the @command{ssh}

@item @option{tm}  ---  @command{telnet} with @command{mimencode}
@cindex method tm
@cindex tm method
@cindex method using telnet
@cindex telnet
@cindex mimencode
@cindex base-64 encoding

Connect to the remote host with @command{telnet} and use base64 encoding
to transfer files between the machines.

This requires the @command{mimencode} command that is part of the

@item @option{ru}  ---  @command{rsh} with @command{uuencode}
@cindex method ru
@cindex ru method
@cindex method using rsh
@cindex rsh
@cindex uuencode

Connect to the remote host with @command{rsh} and use the
@command{uuencode} and @command{uudecode} commands to transfer files
between the machines.


@item @option{su}  ---  @command{ssh} with @command{uuencode}
@cindex method su
@cindex su method
@cindex method using ssh
@cindex ssh
@cindex uuencode

Connect to the remote host with @command{ssh} and use the
@command{uuencode} and @command{uudecode} commands to transfer files
between the machines.

@item @option{tu}  ---  @command{telnet} with @command{uuencode}
@cindex tu method
@cindex method tu
@cindex method using telnet
@cindex telnet
@cindex uuencode

Connect to the remote host with @command{telnet} and use the
@command{uuencode} and @command{uudecode} commands to transfer files
between the machines.


@item @option{sum} --- @command{su} with @command{mimencode}
@cindex method sum
@cindex sum method
@cindex method using su
@cindex su
@cindex mimencode
@cindex base-64 encoding

This method does not connect to a remote host at all, rather it uses the
@command{su} program to allow you to edit files as another user.  Uses
base64 encoding to transfer the file contents.


@item @option{suu} --- @command{su} with @command{uuencode}
@cindex method suu
@cindex suu method
@cindex method using su
@cindex su
@cindex uuencode

Like @option{sum}, this uses the @command{su} program to allow you to
edit files on the local host as another user.  Uses @command{uuencode}
and @command{uudecode} to transfer the file contents.


@item @option{sudm} --- @command{sudo} with @command{mimencode}
@cindex method sudm
@cindex sudm method
@cindex method using sudo
@cindex sudo
@cindex mimencode
@cindex base-64 encoding

This is similar to the @option{sum} method, but it uses @command{sudo}
rather than @command{su} to become a different user.

Note that @command{sudo} must be configured to allow you to start a

@item @option{sudu} --- @command{sudo} with @command{uuencode}
@cindex method sudu
@cindex sudu method
@cindex method using sudo
@cindex sudo
@cindex uuencode

This is similar to the @option{suu} method, but it uses @command{sudo}
rather than @command{su} to become a different user.


@item @option{smx} --- @command{ssh} with @command{mimencode}
@cindex method smx
@cindex smx method
@cindex method using ssh
@cindex ssh
@cindex mimencode
@cindex base-64 encoding
@cindex Cygwin

As you expect, this is similar to @option{sm}, only a little
different.  Whereas @option{sm} opens a normal interactive shell on
the remote host, this option uses @samp{ssh -t -t @var{host} -l
@var{user} /bin/sh} tp open a connection.  This is useful for users

@item @option{km} --- @command{krlogin} with @command{mimencode}
@cindex method km
@cindex km method
@cindex krlogin
@cindex Kerberos
@cindex mimencode
@cindex base-64 encoding

This method is also similar to @option{sm}.  It only uses the
@command{krlogin -x} command to log in to the remote host.


@item @option{plinku} --- @command{plink} with @command{uuencode}
@cindex method plinku
@cindex plinku method
@cindex method using plink
@cindex plink
@cindex uuencode

This method is mostly interesting for Windows users using the PuTTY
implementation of SSH.  It uses @samp{plink -ssh} to log in to the
remote host.

will support that, anyway.

@item @option{plinkm} --- @command{plink} with @command{mimencode}
@cindex method plinkm
@cindex plinkm method
@cindex method using plink
@cindex plink
@cindex mimencode
@cindex base-64 encoding

Like @option{plinku}, but uses base64 encoding instead of uu encoding.

@end table

@table @asis
@item @option{rcp}  ---  @command{rsh} and @command{rcp}
@cindex method rcp
@cindex rcp method
@cindex rcp
@cindex rsh

This method uses the @command{rsh} and @command{rcp} commands to connect
to the remote machine and transfer files. This is probably the fastest
connection method available.


@item @option{scp}  ---  @command{ssh} and @command{scp}
@cindex method scp
@cindex scp method
@cindex scp
@cindex ssh

Using @command{ssh} to connect to the remote host and @command{scp} to
transfer files between the machines is the best method for securely
connecting to a remote machine and accessing files.

@item @option{rsync}  ---  @command{ssh} and @command{rsync}
@cindex method rsync
@cindex rsync method
@cindex rsync
@cindex ssh

Using the @command{ssh} command to connect securely to the remote
machine and the @command{rsync} command to transfer files is almost
identical to the @option{scp} method.

@item @option{scpx} --- @command{ssh} and @command{scp}
@cindex method scpx
@cindex scpx method
@cindex scp
@cindex ssh
@cindex Cygwin

As you expect, this is similar to @option{scp}, only a little
different.  Whereas @option{scp} opens a normal interactive shell on
the remote host, this option uses @samp{ssh -t -t @var{host} -l
@var{user} /bin/sh} to open a connection.  This is useful for users

@item @option{pscp} --- @command{plink} and @command{pscp}
@cindex method pscp
@cindex pscp method
@cindex pscp
@cindex plink
@cindex PuTTY

This method is similar to @option{scp}, but it uses the
@command{plink} command to connect to the remote host, and it uses
@command{pscp} for transferring the files.  These programs are part
of PuTTY, an SSH implementation for Windows.

@item @option{fcp} --- @command{fsh} and @command{fcp}
@cindex method fcp
@cindex fcp method
@cindex fsh
@cindex fcp

This method is similar to @option{scp}, but it uses the @command{fsh}
command to connect to the remote host, and it uses @command{fcp} for
transferring the files.  @command{fsh/fcp} are a front-end for
@command{ssh} which allow for reusing the same @command{ssh} session

This method uses the command @samp{fsh @var{host} -l @var{user}
/bin/sh -i} to establish the connection, it does not work to just say
@command{fsh @var{host} -l @var{user}}.

There is no inline method using @command{fsh} as the multiplexing
provided by the program is not very useful in our context.  @tramp{}
opens just one connection to the remote host and then keeps it open,
anyway.

@table @asis
@item @option{multi} --- base64 encoding with @command{mimencode}
@cindex method multi
@cindex multi method
@cindex base-64 encoding
@cindex mimencode

The file is transferred through the connection in base64 encoding.  Uses
the @command{mimencode} program for doing encoding and decoding, but
uses an Emacs internal implementation on the local host if available.

@item @option{multiu} --- use commands @command{uuencode} and @command{uudecode}
@cindex method multiu
@cindex multiu method
@cindex uuencode

The file is transferred through the connection in `uu' encoding.  Uses
the @command{uuencode} and @command{uudecode} programs for encoding and
decoding, but uses a Lisp implementation for decoding on the local host
if available.

@node Remote shell setup
@comment  node-name,  next,  previous,  up
@section Remote shell setup hints
@cindex remote shell setup
@cindex .profile file
@cindex .login file
@cindex shell init files

As explained in the @ref{Overview} section, @tramp{} connects to the
remote host and talks to the shell it finds there.  Of course, when you
log in, the shell executes its init files.  Suppose your init file

@end table


@node Windows setup hints
@section Issues with Cygwin ssh
@cindex Cygwin

This section needs a lot of work!  Please help.

@cindex method smx with Cygwin
@cindex smx method with Cygwin

46366:93ea423da06e

@xref{Bug Reports}.


@subsubheading Behind the scenes
@cindex behind the scenes
@cindex details of operation
@cindex how it works

This section tries to explain what goes on behind the scenes when you
access a remote file through @tramp{}.

Suppose you type @kbd{C-x C-f} and enter part of an @tramp{} file name,

@table @asis
@item @option{rm}  ---  @command{rsh} with @command{mimencode}
@cindex method rm
@cindex rm method
@cindex method using rsh (rm)

Connect to the remote host with @command{rsh} and use base64 encoding to
transfer files between the machines.

This requires the @command{mimencode} command that is part of the

@item @option{sm}  ---  @command{ssh} with @command{mimencode}
@cindex method sm
@cindex sm method
@cindex method using ssh (sm)
@cindex ssh (with sm method)
@cindex mimencode (with sm method)
@cindex base-64 encoding (with sm method)

Connect to the remote host with @command{ssh} and use base64 encoding to
transfer files between the machines.

This is identical to the previous option except that the @command{ssh}

@item @option{tm}  ---  @command{telnet} with @command{mimencode}
@cindex method tm
@cindex tm method
@cindex method using telnet (tm)
@cindex telnet (with tm method)
@cindex mimencode (with tm method)
@cindex base-64 encoding (with tm method)

Connect to the remote host with @command{telnet} and use base64 encoding
to transfer files between the machines.

This requires the @command{mimencode} command that is part of the

@item @option{ru}  ---  @command{rsh} with @command{uuencode}
@cindex method ru
@cindex ru method
@cindex method using rsh
@cindex rsh (with ru method)
@cindex uuencode (with ru method)

Connect to the remote host with @command{rsh} and use the
@command{uuencode} and @command{uudecode} commands to transfer files
between the machines.


@item @option{su}  ---  @command{ssh} with @command{uuencode}
@cindex method su
@cindex su method
@cindex method using ssh (su)
@cindex ssh (with su method)
@cindex uuencode (with su method)

Connect to the remote host with @command{ssh} and use the
@command{uuencode} and @command{uudecode} commands to transfer files
between the machines.

@item @option{tu}  ---  @command{telnet} with @command{uuencode}
@cindex tu method
@cindex method tu
@cindex method using telnet (tu)
@cindex telnet (with tu method)
@cindex uuencode (with tu method)

Connect to the remote host with @command{telnet} and use the
@command{uuencode} and @command{uudecode} commands to transfer files
between the machines.


@item @option{sum} --- @command{su} with @command{mimencode}
@cindex method sum
@cindex sum method
@cindex method using su (sum)
@cindex su (with sum method)
@cindex mimencode (with sum method)
@cindex base-64 encoding (with sum method)

This method does not connect to a remote host at all, rather it uses the
@command{su} program to allow you to edit files as another user.  Uses
base64 encoding to transfer the file contents.


@item @option{suu} --- @command{su} with @command{uuencode}
@cindex method suu
@cindex suu method
@cindex method using su (suu)
@cindex su (with suu method)
@cindex uuencode (with suu method)

Like @option{sum}, this uses the @command{su} program to allow you to
edit files on the local host as another user.  Uses @command{uuencode}
and @command{uudecode} to transfer the file contents.


@item @option{sudm} --- @command{sudo} with @command{mimencode}
@cindex method sudm
@cindex sudm method
@cindex method using sudo (sudm)
@cindex sudo (with sudm method)
@cindex mimencode (with sudm method)
@cindex base-64 encoding (with sudm method)

This is similar to the @option{sum} method, but it uses @command{sudo}
rather than @command{su} to become a different user.

Note that @command{sudo} must be configured to allow you to start a

@item @option{sudu} --- @command{sudo} with @command{uuencode}
@cindex method sudu
@cindex sudu method
@cindex method using sudo (sudu)
@cindex sudo (with sudu method)
@cindex uuencode (with sudu method)

This is similar to the @option{suu} method, but it uses @command{sudo}
rather than @command{su} to become a different user.


@item @option{smx} --- @command{ssh} with @command{mimencode}
@cindex method smx
@cindex smx method
@cindex method using ssh (smx)
@cindex ssh (with smx method)
@cindex mimencode (with smx method)
@cindex base-64 encoding (with smx method)
@cindex Cygwin (with smx method)

As you expect, this is similar to @option{sm}, only a little
different.  Whereas @option{sm} opens a normal interactive shell on
the remote host, this option uses @samp{ssh -t -t @var{host} -l
@var{user} /bin/sh} tp open a connection.  This is useful for users

@item @option{km} --- @command{krlogin} with @command{mimencode}
@cindex method km
@cindex km method
@cindex krlogin (with km method)
@cindex Kerberos (with km method)
@cindex mimencode (with km method)
@cindex base-64 encoding (with km method)

This method is also similar to @option{sm}.  It only uses the
@command{krlogin -x} command to log in to the remote host.


@item @option{plinku} --- @command{plink} with @command{uuencode}
@cindex method plinku
@cindex plinku method
@cindex method using plink (plinku)
@cindex plink (with plinku method)
@cindex uuencode (with plinku method)

This method is mostly interesting for Windows users using the PuTTY
implementation of SSH.  It uses @samp{plink -ssh} to log in to the
remote host.

will support that, anyway.

@item @option{plinkm} --- @command{plink} with @command{mimencode}
@cindex method plinkm
@cindex plinkm method
@cindex method using plink (plinkm)
@cindex plink (with plinkm method)
@cindex mimencode (with plinkm method)
@cindex base-64 encoding (with plinkm method)

Like @option{plinku}, but uses base64 encoding instead of uu encoding.

@end table

@table @asis
@item @option{rcp}  ---  @command{rsh} and @command{rcp}
@cindex method rcp
@cindex rcp method
@cindex rcp (with rcp method)
@cindex rsh (with rcp method)

This method uses the @command{rsh} and @command{rcp} commands to connect
to the remote machine and transfer files. This is probably the fastest
connection method available.


@item @option{scp}  ---  @command{ssh} and @command{scp}
@cindex method scp
@cindex scp method
@cindex scp (with scp method)
@cindex ssh (with scp method)

Using @command{ssh} to connect to the remote host and @command{scp} to
transfer files between the machines is the best method for securely
connecting to a remote machine and accessing files.

@item @option{rsync}  ---  @command{ssh} and @command{rsync}
@cindex method rsync
@cindex rsync method
@cindex rsync (with rsync method)
@cindex ssh (with rsync method)

Using the @command{ssh} command to connect securely to the remote
machine and the @command{rsync} command to transfer files is almost
identical to the @option{scp} method.

@item @option{scpx} --- @command{ssh} and @command{scp}
@cindex method scpx
@cindex scpx method
@cindex scp (with scpx method)
@cindex ssh (with scpx method)
@cindex Cygwin (with scpx method)

As you expect, this is similar to @option{scp}, only a little
different.  Whereas @option{scp} opens a normal interactive shell on
the remote host, this option uses @samp{ssh -t -t @var{host} -l
@var{user} /bin/sh} to open a connection.  This is useful for users

@item @option{pscp} --- @command{plink} and @command{pscp}
@cindex method pscp
@cindex pscp method
@cindex pscp (with pscp method)
@cindex plink (with pscp method)
@cindex PuTTY (with pscp method)

This method is similar to @option{scp}, but it uses the
@command{plink} command to connect to the remote host, and it uses
@command{pscp} for transferring the files.  These programs are part
of PuTTY, an SSH implementation for Windows.

@item @option{fcp} --- @command{fsh} and @command{fcp}
@cindex method fcp
@cindex fcp method
@cindex fsh (with fcp method)
@cindex fcp (with fcp method)

This method is similar to @option{scp}, but it uses the @command{fsh}
command to connect to the remote host, and it uses @command{fcp} for
transferring the files.  @command{fsh/fcp} are a front-end for
@command{ssh} which allow for reusing the same @command{ssh} session

This method uses the command @samp{fsh @var{host} -l @var{user}
/bin/sh -i} to establish the connection, it does not work to just say
@command{fsh @var{host} -l @var{user}}.

@cindex method fsh
@cindex fsh method
There is no inline method using @command{fsh} as the multiplexing
provided by the program is not very useful in our context.  @tramp{}
opens just one connection to the remote host and then keeps it open,
anyway.

@table @asis
@item @option{multi} --- base64 encoding with @command{mimencode}
@cindex method multi
@cindex multi method
@cindex mimencode (with multi method)
@cindex base-64 encoding (with multi method)

The file is transferred through the connection in base64 encoding.  Uses
the @command{mimencode} program for doing encoding and decoding, but
uses an Emacs internal implementation on the local host if available.

@item @option{multiu} --- use commands @command{uuencode} and @command{uudecode}
@cindex method multiu
@cindex multiu method
@cindex uuencode (with multiu method)

The file is transferred through the connection in `uu' encoding.  Uses
the @command{uuencode} and @command{uudecode} programs for encoding and
decoding, but uses a Lisp implementation for decoding on the local host
if available.

@node Remote shell setup
@comment  node-name,  next,  previous,  up
@section Remote shell setup hints
@cindex remote shell setup
@cindex @file{.profile} file
@cindex @file{.login} file
@cindex shell init files

As explained in the @ref{Overview} section, @tramp{} connects to the
remote host and talks to the shell it finds there.  Of course, when you
log in, the shell executes its init files.  Suppose your init file

@end table


@node Windows setup hints
@section Issues with Cygwin ssh
@cindex Cygwin, issues

This section needs a lot of work!  Please help.

@cindex method smx with Cygwin
@cindex smx method with Cygwin