Doc: add some precisions for --remote and dumb mode

The -r/--remote argument to some of bup's commands currently doesn't
give enough information about how to customize options to SSH. Let's add
information about this so that users know how to customize options for
SSH connections.

Also, in bup-server's documentation, point out which mode is the default
one for more clarity.

Signed-off-by: Gabriel Filion <lelutin@gmail.com>

diff --git a/Documentation/bup-init.md b/Documentation/bup-init.md
index d3e645bc30c89ebe0303e1c24a8201d319ac3985..c53e7fbc8c146eec411a12e3acb96563da6a94ad 100644 (file)
--- a/Documentation/bup-init.md
+++ b/Documentation/bup-init.md
@@ -23,7 +23,10 @@ initialized automatically whenever you run any bup command.
 :   Initialize not only the local repository, but also the
     remote repository given by the *host* and *path*.  This is
     not necessary if you intend to back up to the default
-    location on the server (ie. a blank *path*).
+    location on the server (ie. a blank *path*).  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.
 
 
 # EXAMPLE
@@ -33,7 +36,7 @@ initialized automatically whenever you run any bup command.
 
 # SEE ALSO
 
-`bup-fsck`(1)
+`bup-fsck`(1), `ssh_config`(5)
 
 # BUP
 

diff --git a/Documentation/bup-join.md b/Documentation/bup-join.md
index 921b92fcb0f8bbfadb97c67774ffe279e8977c77..a16fbc0445b24e4f52a9cbce5debc4de4c32580a 100644 (file)
--- a/Documentation/bup-join.md
+++ b/Documentation/bup-join.md
@@ -28,7 +28,10 @@ join` reads them from stdin instead.
 -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.
+    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.
 
 
 # EXAMPLE
@@ -46,7 +49,7 @@ join` reads them from stdin instead.
 
 # SEE ALSO
 
-`bup-split`(1), `bup-save`(1)
+`bup-split`(1), `bup-save`(1), `ssh_config`(5)
 
 # BUP
 

diff --git a/Documentation/bup-save.md b/Documentation/bup-save.md
index b8edd8d1fce96b73d7077d051bd022082250cfb8..8ae40f17ee5451f61fdb6cec77256e665839e266 100644 (file)
--- a/Documentation/bup-save.md
+++ b/Documentation/bup-save.md
@@ -26,7 +26,10 @@ for `bup-index`(1).
 -r, --remote=*host*:*path*
 :   save the backup set to the given remote server.  If
     *path* is omitted, uses the default path on the remote
-    server (you still need to include the ':')
+    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.
 
 -t, --tree
 :   after creating the backup set, print out the git tree
@@ -145,7 +148,7 @@ for `bup-index`(1).
 # SEE ALSO
 
 `bup-index`(1), `bup-split`(1), `bup-on`(1),
-`bup-restore`(1)
+`bup-restore`(1), `ssh_config`(5)
 
 # BUP
 

diff --git a/Documentation/bup-server.md b/Documentation/bup-server.md
index 8badd335cf4fb806e56ec01988f1afe4908a5f0c..00c5df0a9db68e8b81194208215947e6cfe5745a 100644 (file)
--- a/Documentation/bup-server.md
+++ b/Documentation/bup-server.md
@@ -26,7 +26,8 @@ smart
     against the idx files in its repository.  If any object
     already exists, it tells the client about the idx file
     it was found in, allowing the client to download that
-    idx and avoid sending duplicate data.
+    idx and avoid sending duplicate data.  This is
+    `bup-server`'s default mode.
 
 dumb
 :   In this mode, the server will not check its local index
@@ -39,7 +40,8 @@ dumb
 # FILES
 
 $BUP_DIR/bup-dumb-server
-:   Activate dumb server mode, as discussed above.
+:   Activate dumb server mode, as discussed above.  This file is not created by
+    default in new repositories.
 
 # SEE ALSO
 

diff --git a/Documentation/bup-split.md b/Documentation/bup-split.md
index e0598e4b49089eadf2d7b964293fc6045c53cb78..c0c7406e08e77795826f9e28a473620cfbf86b7b 100644 (file)
--- a/Documentation/bup-split.md
+++ b/Documentation/bup-split.md
@@ -46,8 +46,11 @@ To get the data back, use `bup-join`(1).
 -r, --remote=*host*:*path*
 :   save the backup set to the given remote server.  If
     *path* is omitted, uses the default path on the remote
-    server (you still need to include the ':')
-    
+    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.
+
 -b, --blobs
 :   output a series of git blob ids that correspond to the
     chunks in the dataset.
@@ -143,7 +146,7 @@ To get the data back, use `bup-join`(1).
 
 # SEE ALSO
 
-`bup-join`(1), `bup-index`(1), `bup-save`(1), `bup-on`(1)
+`bup-join`(1), `bup-index`(1), `bup-save`(1), `bup-on`(1), `ssh_config`(5)
 
 # BUP