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.  By default, BUP_DIR
  16 is `~/.bup`.
  17
  18 # OPTIONS
  19
  20 -r, \--remote=*host*:*path*
  21 :   Initialize not only the local repository, but also the
  22     remote repository given by the *host* and *path*.  This is
  23     not necessary if you intend to back up to the default
  24     location on the server (ie. a blank *path*).  The connection to the
  25     remote server is made with SSH.  If you'd like to specify which port, user
  26     or private key to use for the SSH connection, we recommend you use the
  27     `~/.ssh/config` file.
  28
  29
  30 # EXAMPLE
  31
  32     bup init
  33
  34
  35 # SEE ALSO
  36
  37 `bup-fsck`(1), `ssh_config`(5)
  38
  39 # BUP
  40
  41 Part of the `bup`(1) suite.