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] [--profile] \<path\>
  12
  13 # DESCRIPTION
  14
  15 `bup drecurse` traverses files in the filesystem in a way
  16 similar to `find`(1).  In most cases, you should use
  17 `find`(1) instead.
  18
  19 This program is useful mainly for testing the file
  20 traversal algorithm used in `bup-index`(1).
  21
  22 Note that filenames are returned in reverse alphabetical
  23 order, as in `bup-index`(1).  This is important because you
  24 can't generate the hash of a parent directory until you
  25 have generated the hashes of all its children.  When
  26 listing files in reverse order, the parent directory will
  27 come after its children, making this easy.
  28
  29 # OPTIONS
  30
  31 -x, --xdev, --one-file-system
  32 :   don't cross filesystem boundaries.
  33
  34 -q, --quiet
  35 :   don't print filenames as they are encountered.  Useful
  36     when testing performance of the traversal algorithms.
  37
  38 --profile
  39 :   print profiling information upon completion.  Useful
  40     when testing performance of the traversal algorithms.
  41
  42 # EXAMPLE
  43
  44     bup drecurse -x /
  45
  46 # SEE ALSO
  47
  48 `bup-index`(1)
  49
  50 # BUP
  51
  52 Part of the `bup`(1) suite.