Documentation/bup-drecurse.md

   1 % bup-drecurse(1) Bup %BUP_VERSION%
   2 % Avery Pennarun <apenwarr@gmail.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-drecurse - recursively list files in your filesystem
   8
   9 # SYNOPSIS
  10
  11 bup drecurse [-x] [-q] [\--exclude *path*]
  12 [\--exclude-from *filename*] [\--profile] \<path\>
  13
  14 # DESCRIPTION
  15
  16 `bup drecurse` traverses files in the filesystem in a way
  17 similar to `find`(1).  In most cases, you should use
  18 `find`(1) instead.
  19
  20 This program is useful mainly for testing the file
  21 traversal algorithm used in `bup-index`(1).
  22
  23 Note that filenames are returned in reverse alphabetical
  24 order, as in `bup-index`(1).  This is important because you
  25 can't generate the hash of a parent directory until you
  26 have generated the hashes of all its children.  When
  27 listing files in reverse order, the parent directory will
  28 come after its children, making this easy.
  29
  30 # OPTIONS
  31
  32 -x, \--xdev, \--one-file-system
  33 :   don't cross filesystem boundaries -- though as with tar and rsync,
  34     the mount points themselves will still be reported.
  35
  36 -q, \--quiet
  37 :   don't print filenames as they are encountered.  Useful
  38     when testing performance of the traversal algorithms.
  39
  40 \--exclude=*path*
  41 :   a path to exclude from the backup (can be used more
  42     than once)
  43
  44 \--exclude-from=*filename*
  45 :   a file that contains exclude paths (can be used more
  46     than once)
  47
  48 \--profile
  49 :   print profiling information upon completion.  Useful
  50     when testing performance of the traversal algorithms.
  51
  52 # EXAMPLE
  53
  54     bup drecurse -x /
  55
  56 # SEE ALSO
  57
  58 `bup-index`(1)
  59
  60 # BUP
  61
  62 Part of the `bup`(1) suite.