]> arthur.barton.de Git - bup.git/commitdiff
bup-restore.md: document -r
authorRob Browning <rlb@defaultvalue.org>
Tue, 10 Oct 2017 00:35:14 +0000 (19:35 -0500)
committerRob Browning <rlb@defaultvalue.org>
Tue, 10 Oct 2017 00:35:34 +0000 (19:35 -0500)
Signed-off-by: Rob Browning <rlb@defaultvalue.org>
Tested-by: Rob Browning <rlb@defaultvalue.org>
Documentation/bup-restore.md

index 700f3d467dd0bb365b911bc460da51401531ab71..92643d9cd90a8d0893ea05dfccc7db878130026c 100644 (file)
@@ -8,7 +8,7 @@ bup-restore - extract files from a backup set
 
 # SYNOPSIS
 
-bup restore [\--outdir=*outdir*] [\--exclude-rx *pattern*]
+bup restore [-r *host*:[*path*]] [\--outdir=*outdir*] [\--exclude-rx *pattern*]
 [\--exclude-rx-from *filename*] [-v] [-q] \<paths...\>
 
 # DESCRIPTION
@@ -88,6 +88,14 @@ See the EXAMPLES section for a demonstration.
 
 # OPTIONS
 
+-r, \--remote=*host*:*path*
+:   restore the backup set from the given remote server.  If
+    *path* is omitted, uses the default path on the remote
+    server (you still need to include the ':').  The connection to the
+    remote server is made with SSH.  If you'd like to specify which port, user
+    or private key to use for the SSH connection, we recommend you use the
+    `~/.ssh/config` file.
+
 -C, \--outdir=*outdir*
 :   create and change to directory *outdir* before
     extracting the files.