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*] [\--exclude-rx *pattern*]
  13 \ [\--exclude-rx-from *filename*] [\--profile] \<path\>
  14
  15 # DESCRIPTION
  16
  17 `bup drecurse` traverses files in the filesystem in a way
  18 similar to `find`(1).  In most cases, you should use
  19 `find`(1) instead.
  20
  21 This program is useful mainly for testing the file
  22 traversal algorithm used in `bup-index`(1).
  23
  24 Note that filenames are returned in reverse alphabetical
  25 order, as in `bup-index`(1).  This is important because you
  26 can't generate the hash of a parent directory until you
  27 have generated the hashes of all its children.  When
  28 listing files in reverse order, the parent directory will
  29 come after its children, making this easy.
  30
  31 # OPTIONS
  32
  33 -x, \--xdev, \--one-file-system
  34 :   don't cross filesystem boundaries -- though as with tar and rsync,
  35     the mount points themselves will still be reported.
  36
  37 -q, \--quiet
  38 :   don't print filenames as they are encountered.  Useful
  39     when testing performance of the traversal algorithms.
  40
  41 \--exclude=*path*
  42 :   exclude *path* from the backup (may be repeated).
  43
  44 \--exclude-from=*filename*
  45 :   read --exclude paths from *filename*, one path per-line (may be
  46     repeated).  Ignore completely empty lines.
  47
  48 \--exclude-rx=*pattern*
  49 :   exclude any path matching *pattern*.  See `bup-index`(1) for
  50     details, but note that unlike index, drecurse will produce
  51     relative paths if the drecurse target is a relative path. (may be
  52     repeated).
  53
  54 \--exclude-rx-from=*filename*
  55 :   read --exclude-rx patterns from *filename*, one pattern per-line
  56     (may be repeated).  Ignore completely empty lines.
  57
  58 \--profile
  59 :   print profiling information upon completion.  Useful
  60     when testing performance of the traversal algorithms.
  61
  62 # EXAMPLES
  63     bup drecurse -x /
  64
  65 # SEE ALSO
  66
  67 `bup-index`(1)
  68
  69 # BUP
  70
  71 Part of the `bup`(1) suite.