]> arthur.barton.de Git - bup.git/commitdiff
bup-ls(1): document support for --remote host:port
authorRob Browning <rlb@defaultvalue.org>
Wed, 25 Sep 2019 00:30:43 +0000 (19:30 -0500)
committerRob Browning <rlb@defaultvalue.org>
Sat, 28 Sep 2019 17:39:20 +0000 (12:39 -0500)
Signed-off-by: Rob Browning <rlb@defaultvalue.org>
Documentation/bup-ls.md

index bbad3dcb8e14170bbf85ef23dcb2509d1d856b26..2e820d69c4cf09ca55d897b24f167a3c5cf39f58 100644 (file)
@@ -8,7 +8,7 @@ bup-ls - list the contents of a bup repository
 
 # SYNOPSIS
 
-bup ls [OPTION...] \<paths...\>
+bup ls [-r *host*:[*path*]] [OPTION...] \<paths...\>
 
 # DESCRIPTION
 
@@ -39,6 +39,14 @@ you can view its contents using `bup join` or `git show`.
 
 # OPTIONS
 
+-r, \--remote=*host*:[*path*]
+:   list information for the repository at *path* on the indicated
+    *host*.  If *path* is omitted, uses the default path on the remote
+    server (you still need to include the ':').  The connection to the
+    remote server will be made by SSH.  If you'd like to specify the
+    port, user, or private key, we recommend you use the
+    `~/.ssh/config` file (`ssh_config(5)`).
+
 -s, \--hash
 :   show hash for each file/directory.
 
@@ -74,7 +82,8 @@ you can view its contents using `bup join` or `git show`.
 
 # SEE ALSO
 
-`bup-join`(1), `bup-fuse`(1), `bup-ftp`(1), `bup-save`(1), `git-show`(1)
+`bup-join`(1), `bup-fuse`(1), `bup-ftp`(1), `bup-save`(1),
+`git-show`(1), `ssh_config`(5)
 
 # BUP