]> arthur.barton.de Git - bup.git/blobdiff - Documentation/bup-init.md
get: adjust for python 3 and test there
[bup.git] / Documentation / bup-init.md
index d3e645bc30c89ebe0303e1c24a8201d319ac3985..d5d539e860a8e71427060a95c7088909fa6f5272 100644 (file)
@@ -12,28 +12,28 @@ bup-init - initialize a bup repository
 
 # DESCRIPTION
 
-`bup init` initializes your local bup repository.  You
-usually don't need to run it unless you have set BUP_DIR
-explicitly.  By default, BUP_DIR is `~/.bup` and will be
-initialized automatically whenever you run any bup command.
+`bup init` initializes your local bup repository.  By default, BUP_DIR
+is `~/.bup`.
 
 # OPTIONS
 
--r, --remote=*host*:*path*
+-r, \--remote=*host*:*path*
 :   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
-
+# EXAMPLES
     bup init
     
 
 # SEE ALSO
 
-`bup-fsck`(1)
+`bup-fsck`(1), `ssh_config`(5)
 
 # BUP