Documentation/bup-server.md

   1 % bup-server(1) Bup %BUP_VERSION%
   2 % Avery Pennarun <apenwarr@gmail.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-server - the server side of the bup client-server relationship
   8
   9 # SYNOPSIS
  10
  11 bup server
  12
  13 # DESCRIPTION
  14
  15 `bup server` is the server side of a remote bup session.
  16 If you use `bup-split`(1) or `bup-save`(1) with the `-r`
  17 option, they will ssh to the remote server and run `bup
  18 server` to receive the transmitted objects.
  19
  20 There is normally no reason to run `bup server` yourself.
  21
  22 # MODES
  23
  24 smart
  25 :   In this mode, the server checks each incoming object
  26     against the idx files in its repository.  If any object
  27     already exists, it tells the client about the idx file
  28     it was found in, allowing the client to download that
  29     idx and avoid sending duplicate data.
  30
  31 dumb
  32 :   In this mode, the server will not check its local index
  33     before writing an object.  To avoid writing duplicate
  34     objects, the server will tell the client to download all
  35     of its .idx files at the start of the session.  This
  36     mode is useful on low powered server hardware (ie
  37     router/slow NAS).
  38
  39 # FILES
  40
  41 $BUP_DIR/bup-dumb-server
  42 :   Activate dumb server mode, as discussed above.
  43
  44 # SEE ALSO
  45
  46 `bup-save`(1), `bup-split`(1)
  47
  48 # BUP
  49
  50 Part of the `bup`(1) suite.