Documentation/bup-ls.md

   1 % bup-ls(1) Bup %BUP_VERSION%
   2 % Avery Pennarun <apenwarr@gmail.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-ls - list the contents of a bup repository
   8
   9 # SYNOPSIS
  10
  11 bup ls [-s] [-a] <paths...>
  12
  13 # DESCRIPTION
  14
  15 `bup ls` lists files and directories in your bup repository
  16 using the same directory hierarchy as they would have with
  17 `bup-fuse`(1).
  18
  19 The top level directory contains the branch (corresponding to
  20 the `-n` option in `bup save`), the next level is the date
  21 of the backup, and subsequent levels correspond to files in
  22 the backup.
  23
  24 Note that `bup ls` doesn't show hidden files by default and one needs to use
  25 the `-a` option to show them. Files are hidden when their name begins with a
  26 dot. For example, on the topmost level, the special directories named `.commit`
  27 and `.tag` are hidden directories.
  28
  29 Once you have identified the file you want using `bup ls`,
  30 you can view its contents using `bup join` or `git show`.
  31
  32 # OPTIONS
  33
  34 -s, --hash
  35 :   show hash for each file/directory.
  36
  37 -a, --all
  38 :   show hidden files.
  39
  40 # EXAMPLE
  41
  42     bup ls /myserver/latest/etc/profile
  43
  44     bup ls -a /
  45
  46 # SEE ALSO
  47
  48 `bup-join`(1), `bup-fuse`(1), `bup-ftp`(1), `bup-save`(1), `git-show`(1)
  49
  50 # BUP
  51
  52 Part of the `bup`(1) suite.