Documentation/bup-ftp.1.md

   1 % bup-ftp(1) Bup %BUP_VERSION%
   2 % Avery Pennarun <apenwarr@gmail.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-ftp - ftp-like client for navigating bup repositories
   8
   9 # SYNOPSIS
  10
  11 bup ftp
  12
  13 # DESCRIPTION
  14
  15 `bup ftp` is a command-line tool for navigating bup
  16 repositories.  It has commands similar to the Unix `ftp`(1)
  17 command.  The file hierarchy is the same as that shown by
  18 `bup-fuse`(1) and `bup-ls`(1).
  19
  20 Note: if your system has the python-readline library
  21 installed, you can use the \<tab\> key to complete filenames
  22 while navigating your backup data.  This will save you a
  23 lot of typing.
  24
  25
  26 # COMMANDS
  27
  28 The following commands are available inside `bup ftp`:
  29
  30 ls
  31 :   print the contents of the current working directory
  32
  33 cd *dirname*
  34 :   change to a different working directory
  35
  36 pwd
  37 :   print the path of the current working directory
  38
  39 cat *filenames...*
  40 :   print the contents of one or more files to stdout
  41
  42 get *filename* *localname*
  43 :   download the contents of *filename* and save it to disk
  44     as *localname*.  If *localname* is omitted, uses
  45     *filename* as the local name.
  46
  47 mget *filenames...*
  48 :   download the contents of the given *filenames* and
  49     stores them to disk under the same names.  The
  50     filenames may contain Unix filename globs (`*`, `?`,
  51     etc.)
  52
  53 help
  54 :   print a list of available commands
  55
  56 quit
  57 :   exit the `bup ftp` client
  58
  59
  60 # EXAMPLE
  61
  62     $ bup ftp
  63     bup> ls
  64     mybackup/
  65     yourbackup/
  66     bup> cd mybackup/
  67     bup> ls
  68     .2fe288dedbfab372c84b0502ee2bc1504270f3b3/
  69     .ae760aa4cfc13b689b46e3d2ce5ae50e92299c72/
  70     2010-02-05-185507@
  71     2010-02-05-185508@
  72     latest@
  73     bup> cd latest/
  74     bup> ls
  75       (...etc...)
  76     bup> get myfile
  77     Saving 'myfile'
  78     bup> quit
  79
  80
  81 # SEE ALSO
  82
  83 `bup-join`(1), `bup-fuse`(1), `bup-ls`(1), `bup-save`(1), `git-show`(1)
  84
  85
  86 # BUP
  87
  88 Part of the `bup`(1) suite.