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 [-a]
  31 :   print the contents of the current working directory.
  32     If -a is given, also include hidden files (files which
  33     start with a `.` character).
  34
  35 cd *dirname*
  36 :   change to a different working directory
  37
  38 pwd
  39 :   print the path of the current working directory
  40
  41 cat *filenames...*
  42 :   print the contents of one or more files to stdout
  43
  44 get *filename* *localname*
  45 :   download the contents of *filename* and save it to disk
  46     as *localname*.  If *localname* is omitted, uses
  47     *filename* as the local name.
  48
  49 mget *filenames...*
  50 :   download the contents of the given *filenames* and
  51     stores them to disk under the same names.  The
  52     filenames may contain Unix filename globs (`*`, `?`,
  53     etc.)
  54
  55 help
  56 :   print a list of available commands
  57
  58 quit
  59 :   exit the `bup ftp` client
  60
  61
  62 # EXAMPLE
  63
  64     $ bup ftp
  65     bup> ls
  66     mybackup/    yourbackup/
  67
  68     bup> cd mybackup/
  69     bup> ls
  70     2010-02-05-185507@   2010-02-05-185508@    latest@
  71
  72     bup> cd latest/
  73     bup> ls
  74       (...etc...)
  75
  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.