Document ~/.ssh/config support for remote backups

2026-10-21 22:31:36 +02:00
parent dc50ef1b07
commit db4059ff36
2 changed files with 3 additions and 0 deletions
@@ -69,6 +69,7 @@ The only rsync error that is ignored is return code 24 (source files vanished du
 It's possible to use a remote server as destination for the backup. Just use the --ssh-user and --ssh-host arguments (or set them in the configuration file).
 Both are required: if only one of them is set, simple_backup exits with an error.
 For this to work, rsync must be installed on the server too.
+The host can be an alias from `~/.ssh/config`: its HostName, Port and IdentityFile are used (ProxyJump and ProxyCommand are not supported).

 The output directory is a path on the server. A leading '~' and relative paths refer to the user's home directory on the server.
 On the command line, quote '~' so that your local shell doesn't expand it:
@@ -152,6 +152,8 @@ Copy it to the default location ($HOME/.config/simple_backup) and edit it as nee
 It is possible to choose a directory on a remote server as destination for the backup. The files
 are copied by rsync through SSH. Server hostname and username must be specified, either in the
 configuration file, or on the command line (\(aq\-\-ssh\-host\(aq and \(aq\-\-ssh\-user\(aq options).
+The host can be an alias from \fI~/.ssh/config\fR: its HostName, Port and IdentityFile are used
+(ProxyJump and ProxyCommand are not supported).
 .P
 The output directory is a path on the server. A leading \(aq~\(aq and relative paths refer to the
 home directory of the user on the server. On the command line, quote \(aq~\(aq so that the local