From ccf8a09487b2d58a836fa27681bb8128b133ea07 Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Tue, 21 Apr 2015 16:54:20 -0400 Subject: [PATCH] specify that the sudo detection is for remote commands on the Connection class Signed-off-by: Alfredo Deza --- README.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.rst b/README.rst index 622c926..baa8af5 100644 --- a/README.rst +++ b/README.rst @@ -136,3 +136,13 @@ connecting to). If the local host has the same as the remote hostname, a local connection (via `Popen`) will be opened and that will be used instead of `ssh`, and avoiding the issues of being able to ssh into the same host. + +Automatic detection for using `sudo` +------------------------------------ +This magical detection can be enabled by using the `detect_sudo` flag in the +`Connection` class. It is disabled by default. + +When enabled, it will prefix any command with `sudo`. This is useful for +libraries that need super user permissions and want to avoid passing `sudo` +everywhere, which can be non-trivial if dealing with `root` users that are +connecting via SSH. -- 2.47.3