From 2e47de20b046d72d566896d7578cb1e753a9e533 Mon Sep 17 00:00:00 2001 From: Gabriel Filion Date: Mon, 2 May 2011 19:12:34 -0400 Subject: [PATCH] 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 --- Documentation/bup-init.md | 7 +++++-- Documentation/bup-join.md | 7 +++++-- Documentation/bup-save.md | 7 +++++-- Documentation/bup-server.md | 6 ++++-- Documentation/bup-split.md | 9 ++++++--- 5 files changed, 25 insertions(+), 11 deletions(-) diff --git a/Documentation/bup-init.md b/Documentation/bup-init.md index d3e645b..c53e7fb 100644 --- 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 921b92f..a16fbc0 100644 --- 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 b8edd8d..8ae40f1 100644 --- 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 8badd33..00c5df0 100644 --- 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 e0598e4..c0c7406 100644 --- 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 -- 2.39.2