X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=Documentation%2Fbup-join.md;h=e1a708bfd31c1a6d3ac283cd748683f46d290237;hb=ba8ed092989c05c30e2b190bb8a7e94853148757;hp=921b92fcb0f8bbfadb97c67774ffe279e8977c77;hpb=8f7bd67638e5ca99d4eccb382e5c759944aa7ab8;p=bup.git

diff --git a/Documentation/bup-join.md b/Documentation/bup-join.md
index 921b92f..e1a708b 100644
--- a/Documentation/bup-join.md
+++ b/Documentation/bup-join.md
@@ -25,14 +25,16 @@ join` reads them from stdin instead.
 
 # OPTIONS
 
--r, --remote=*host*:*path*
-:   Retrieves objects from the given remote repository
-    instead of the local one. *path* may be blank, in which
-    case the default remote repository is used.
-
-
-# EXAMPLE
-
+-r, \--remote=*host*:*path*
+:   Retrieves objects from the given remote repository instead of the
+    local one. *path* may be blank, in which case the default remote
+    repository is used.  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.  Even though the data source is remote, a
+    local bup repository is still required.
+
+# EXAMPLES
     # split and then rejoin a file using its tree id
     TREE=$(tar -cvf - /etc | bup split -t)
     bup join $TREE | tar -tf -
@@ -46,7 +48,7 @@ join` reads them from stdin instead.
 
 # SEE ALSO
 
-`bup-split`(1), `bup-save`(1)
+`bup-split`(1), `bup-save`(1), `bup-cat-file`, `ssh_config`(5)
 
 # BUP