From dc7b11653d7ac7cb0b08eaf224fe2bd7ee4941e8 Mon Sep 17 00:00:00 2001 From: Axel Burri Date: Tue, 22 Feb 2022 20:36:49 +0100 Subject: [PATCH] documentation: adapt ssh_identity and ssh_user option also mention ssh-agent for ssh_identity option. --- doc/btrbk.conf.5.asciidoc | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/doc/btrbk.conf.5.asciidoc b/doc/btrbk.conf.5.asciidoc index 08571f8..6f3071f 100644 --- a/doc/btrbk.conf.5.asciidoc +++ b/doc/btrbk.conf.5.asciidoc @@ -242,15 +242,18 @@ set to ``all'' (the default). === SSH Options -*ssh_identity* :: - Absolute path to a ssh identity file (private key). Note that if - the private key is password protected, btrbk will prompt for user - input, which is usually not desired. +*ssh_identity* |no:: + Absolute path to a ssh identity file (private key). If not set, + the ssh default is used (see ssh(1), "-i identity_file"). Note + that if the identity key is password protected and no + authentication agent is used, btrbk will prompt for user input on + every connection attempt. -*ssh_user* :: +*ssh_user* |no:: Remote username for ssh. Defaults to ``root''. Make sure the remote user is able to run "btrfs" with root privileges (see - option 'backend' for details). + option 'backend' for details). If set to ``no'', the ssh default + is used. *ssh_compression* yes|no:: Enables or disables the compression of ssh connections. Defaults