From: Michael Albinus <michael.albinus@gmx.de>
Date: Sun, 14 Apr 2019 17:53:02 +0000 (+0200)
Subject: Explain ad-hoc multi-hop in the Tramp Quick Start Guide
X-Git-Tag: emacs-27.0.90~3256
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=98a5958f77f56c3de529fe04d3f1c85c037f49e6;p=emacs.git

Explain ad-hoc multi-hop in the Tramp Quick Start Guide

* doc/misc/tramp.texi (Quick Start Guide): New section "Combining
@option{ssh} or @option{plink} with @option{su} or @option{sudo}".
---

diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index 3dfd5224ecd..b272c385d1c 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -467,6 +467,27 @@ The method @option{sg} stands for ``switch group''; the changed group
 must be used here as user name.  The default host name is the same.
 
 
+@anchor{Quick Start Guide: @option{ssh}, @option{plink}, @option{su}, @option{sudo} and @option{sg} methods}
+@section Combining @option{ssh} or @option{plink} with @option{su} or @option{sudo}
+@cindex method @option{ssh}
+@cindex @option{ssh} method
+@cindex method @option{plink}
+@cindex @option{plink} method
+@cindex method @option{su}
+@cindex @option{su} method
+@cindex method @option{sudo}
+@cindex @option{sudo} method
+
+If the @option{su} or @option{sudo} option shall be performed on
+another host, it could be comnbined with a leading @option{ssh} or
+@option{plink} option.  That means, @value{tramp} connects first to
+the other host with non-administrative credentials, and changes to
+administrative credentials on that host afterwards.  In a simple case,
+the syntax looks like
+@file{@value{prefix}ssh@value{postfixhop}user@@host|sudo@value{postfixhop}@value{postfix}/path/to/file}.
+@xref{Ad-hoc multi-hops}.
+
+
 @anchor{Quick Start Guide: @option{sudoedit} method}
 @section Using @command{sudoedit}
 @cindex method @option{sudoedit}