Documentation/bup-cat-file.md

   1 % bup-cat-file(1) Bup %BUP_VERSION%
   2 % Rob Browning <rlb@defaultvalue.org>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-cat-file - extract archive content (low-level)
   8
   9 # SYNOPSIS
  10
  11 bup cat-file [--meta|--bupm] <*path*>
  12
  13 # DESCRIPTION
  14
  15 `bup cat-file` extracts content associated with *path* from the
  16 archive and dumps it to standard output.  If nothing special is
  17 requested, the actual data contained by *path* (which must be a
  18 regular file) will be dumped.
  19
  20 # OPTIONS
  21
  22 \--meta
  23 :   retrieve the metadata entry associated with *path*.  Note that
  24     currently this does not return the raw bytes for the entry
  25     recorded in the relevant .bupm in the archive, but rather a
  26     decoded and then re-encoded version.  When that matters, it should
  27     be possible (though awkward) to use `--bupm` on the parent
  28     directory and then find the relevant entry in the output.
  29
  30 \--bupm
  31 :   retrieve the .bupm file associated with *path*, which must be a
  32     directory.
  33
  34 # EXAMPLES
  35
  36     # Retrieve the content of somefile.
  37     $ bup cat-file /foo/latest/somefile > somefile-content
  38
  39     # Examine the metadata associated with something.
  40     $ bup cat-file --meta /foo/latest/something | bup meta -tvvf -
  41
  42     # Examine the metadata for somedir, including the items it contains.
  43     $ bup cat-file --bupm /foo/latest/somedir | bup meta -tvvf -
  44
  45 # SEE ALSO
  46
  47 `bup-join`(1), `bup-meta`(1)
  48
  49 # BUP
  50
  51 Part of the `bup`(1) suite.