git.sur5r.net Git - openldap/blob - libraries/liblmdb/mdb_copy.1

   1 .TH MDB_COPY 1 "2012/12/12" "LMDB 0.9.5"
   2 .\" Copyright 2012 Howard Chu, Symas Corp. All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .SH NAME
   5 mdb_copy \- LMDB environment copy tool
   6 .SH SYNOPSIS
   7 .B mdb_copy
   8 [\c
   9 .BR \-n ]
  10 .B srcpath
  11 [\c
  12 .BR dstpath ]
  13 .SH DESCRIPTION
  14 The
  15 .B mdb_copy
  16 utility copies an LMDB environment. The environment can
  17 be copied regardless of whether it is currently in use.
  18 No lockfile is created, since it gets recreated at need.
  19
  20 If
  21 .I dstpath
  22 is specified it must be the path of an empty directory
  23 for storing the backup. Otherwise, the backup will be
  24 written to stdout.
  25
  26 .SH OPTIONS
  27 .BR \-n
  28 Open LDMB environment(s) which do not use subdirectories.
  29
  30 .SH DIAGNOSTICS
  31 Exit status is zero if no errors occur.
  32 Errors result in a non-zero exit status and
  33 a diagnostic message being written to standard error.
  34 .SH CAVEATS
  35 This utility can trigger significant file size growth if run
  36 in parallel with write transactions, because pages which they
  37 free during copying cannot be reused until the copy is done.
  38 .SH "SEE ALSO"
  39 .BR mdb_stat (1)
  40 .SH AUTHOR
  41 Howard Chu of Symas Corporation <http://www.symas.com>