Documentation/bup-ftp.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 [-s] [-a] [*path*]
  31 :   print the contents of a directory. If no path argument
  32     is given, the current directory's contents are listed.
  33     If -a is given, also include hidden files (files which
  34     start with a `.` character). If -s is given, each file
  35     is displayed with its hash from the bup archive to its
  36     left.
  37
  38 cd *dirname*
  39 :   change to a different working directory
  40
  41 pwd
  42 :   print the path of the current working directory
  43
  44 cat *filenames...*
  45 :   print the contents of one or more files to stdout
  46
  47 get *filename* *localname*
  48 :   download the contents of *filename* and save it to disk
  49     as *localname*.  If *localname* is omitted, uses
  50     *filename* as the local name.
  51
  52 mget *filenames...*
  53 :   download the contents of the given *filenames* and
  54     stores them to disk under the same names.  The
  55     filenames may contain Unix filename globs (`*`, `?`,
  56     etc.)
  57
  58 help
  59 :   print a list of available commands
  60
  61 quit
  62 :   exit the `bup ftp` client
  63
  64
  65 # EXAMPLES
  66     $ bup ftp
  67     bup> ls
  68     mybackup/    yourbackup/
  69
  70     bup> cd mybackup/
  71     bup> ls
  72     2010-02-05-185507@   2010-02-05-185508@    latest@
  73
  74     bup> cd latest/
  75     bup> ls
  76       (...etc...)
  77
  78     bup> get myfile
  79     Saving 'myfile'
  80     bup> quit
  81
  82
  83 # SEE ALSO
  84
  85 `bup-fuse`(1), `bup-ls`(1), `bup-save`(1), `bup-restore`(1)
  86
  87
  88 # BUP
  89
  90 Part of the `bup`(1) suite.