NAME

       bmaptool - create block map (bmap) for a file or copy a file using bmap

SYNOPSIS

       bmaptool [--help] [--version] [--quiet] <subcommand> [<args>]

DESCRIPTION

       Bmaptool  is a generic tool for creating the block map (bmap) for a file and copying files
       using the block map. The idea is that large files, like raw system  image  files,  can  be
       copied  or  flashed  a  lot faster with bmaptool than with traditional tools, like "dd" or
       "cp".

       Bmaptool supports 2 subcommands:
         1. copy - copy a file to another file using bmap or flash an image to a block device
         2. create - create a bmap for a file

       Please,      find      full       documentation       for       the       project       at
       https://source.tizen.org/documentation/reference/bmaptool

OPTIONS

       --version
         Print bmaptool version and exit.

       -h, --help
         Print short help text and exit.

       -q, --quiet
         Be quiet, do not print extra information.

COMMANDS

   copy [options] IMAGE DEST
         Copy  file  IMAGE to the destination regular file or block device DEST using bmap. IMAGE
         may either be a local path or an URL. DEST may either be  a  regular  file  or  a  block
         device (only local).

         Unless  the  bmap  file  is  explicitly  specified  with  the  "--bmap" option, bmaptool
         automatically discovers it by looking for a file with the same  basename  as  IMAGE  but
         with  the  ".bmap"  extension. The bmap file is only looked for in IMAGE's directory (or
         base URL, in case IMAGE was specified as an  URL).  If  the  bmap  file  is  not  found,
         bmaptool fails. To copy without bmap, use the "--nobmap" option.

         Both  IMAGE  and  the  bmap  file may be specified as an URL (http://, ftp://, https://,
         file://, ssh://). In order to make bmaptool use a  proxy  server,  please,  specify  the
         proxy  using  the  standard  "$http_proxy",  "$https_proxy", "$ftp_proxy" or "$no_proxy"
         environment variables.

         If the server requires authentication, user name and password may be  specified  in  the
         URL,     for     example     "https://user:password@my.server.org/image.raw.bz2",     or
         "ssh://user:password@host:path/to/image.raw".

         IMAGE may be compressed,  in  which  case  bmaptool  decompresses  it  on-the-fly.   The
         compression  type  is detected by the file extension and the following compression types
         are supported: ".bz2", ".gz", ".tar.gz" or ".tgz", and ".tar.bz2". If IMAGE has none  of
         these extensions, it is assumed to be uncompressed.

         If  DEST is a block device node (e.g., "/dev/sdg"), bmaptool opens it in exclusive mode.
         This means that it will fail if any other process has IMAGE block  device  node  opened.
         This  also  means  that  no  other  processes  will be able to open IMAGE until bmaptool
         finishes the copying. Please, see  semantics  of  the  "O_EXCL"  flag  of  the  "open()"
         syscall.

         OPTIONS
           -h, --help
             Print short help text about the "copy" subcommand and exit.

           --bmap BMAP
             Use bmap file "BMAP" for copying. If this option is not specified, bmaptool tries to
             automatically discover the bmap file.

           --nobmap
             Disable automatic bmap file discovery and force flashing entire IMAGE without bmap.

           --no-verify
             Do not verify SHA1 checksums when  copying  (not  recommended).  The  checksums  are
             stored  in  the  bmap  file,  and  normally bmaptool verifies that the data in IMAGE
             matches the checksums.

         EXAMPLES
           bmaptool copy --bmap image.bmap image.raw /dev/sdg
             Copy non-compressed local file "image.raw" to block  device  "/dev/sdg"  using  bmap
             file "image.bmap".

           bmaptool copy image.raw.bz2 /dev/sdg
             Copy bz2-compressed local file "image.raw.bz2" to block device "/dev/sdg". The image
             file is uncompressed on-the-fly. The bamap file is discovered automatically.

           bmaptool copy http://my-server.com/files/image.raw.bz2 $HOME/tmp/file
             Copy bz2-compressed remote "image.raw.bz2" to regular  file  "$HOME/tmp/file".   The
             image file is uncompressed on-the-fly. The bamap file is discovered automatically.

   create [options] IMAGE
       Generate  bmap  for  a  regular  file  IMAGE.  Internally,  this subcommand uses the Linux
       "FIEMAP" ioctl to find out which IMAGE blocks are mapped. By default, the  resulting  bmap
       file is printed to stdout, unless the "--output" option is used.

         OPTIONS
           -h, --help
             Print short help text about the "create" subcommand and exit.

           -o, --output OUTPUT
             Save  the  generated  bmap  in  the  OUTPUT  file (by default the bmap is printed to
             stdout).

           --no-checksum
             Generate a bmap file without SHA1 checksums (not recommended).

         EXAMPLES
           bmaptool create image.raw
             Generate bmap for the "image.raw" file and print it to stdout.

           bmaptool create -o image.bmap image.raw
             Generate bmap for the "image.raw" file and save it in "image.bmap".

AUTHOR

       Artem Bityutskiy <artem.bityutskiy@linux.intel.com>.

REPORTING BUGS

       Please, report bugs to Artem Bityutskiy <artem.bityutskiy@linux.intel.com>.