Documentation/bup-init.md

   1 % bup-init(1) Bup %BUP_VERSION%
   2 % Avery Pennarun <apenwarr@gmail.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-init - initialize a bup repository
   8
   9 # SYNOPSIS
  10
  11 [BUP_DIR=*localpath*] bup init [-r *host*:*path*]
  12
  13 # DESCRIPTION
  14
  15 `bup init` initializes your local bup repository.  You
  16 usually don't need to run it unless you have set BUP_DIR
  17 explicitly.  By default, BUP_DIR is `~/.bup` and will be
  18 initialized automatically whenever you run any bup command.
  19
  20 # OPTIONS
  21
  22 -r, \--remote=*host*:*path*
  23 :   Initialize not only the local repository, but also the
  24     remote repository given by the *host* and *path*.  This is
  25     not necessary if you intend to back up to the default
  26     location on the server (ie. a blank *path*).  The connection to the
  27     remote server is made with SSH.  If you'd like to specify which port, user
  28     or private key to use for the SSH connection, we recommend you use the
  29     `~/.ssh/config` file.
  30
  31
  32 # EXAMPLE
  33
  34     bup init
  35
  36
  37 # SEE ALSO
  38
  39 `bup-fsck`(1), `ssh_config`(5)
  40
  41 # BUP
  42
  43 Part of the `bup`(1) suite.