Merge remote-tracking branch 'origin/mdb.master' into OPENLDAP_REL_ENG_2_5

[openldap] / libraries / liblmdb / mdb_copy.1

diff --git a/libraries/liblmdb/mdb_copy.1 b/libraries/liblmdb/mdb_copy.1
index 2c925a73ef4f7e8a9525d1347769ef2d69186b07..9b053f97d518be547fdf2665338086fb9e67306a 100644 (file)
--- a/libraries/liblmdb/mdb_copy.1
+++ b/libraries/liblmdb/mdb_copy.1
@@ -4,17 +4,29 @@
 .SH NAME
 mdb_copy \- LMDB environment copy tool
 .SH SYNOPSIS
-.B mdb_stat
-.I srcpath\ dstpath
+.B mdb_copy
+.I srcpath\ [dstpath]
 .SH DESCRIPTION
 The
 .B mdb_copy
 utility copies an LMDB environment. The environment can
 be copied regardless of whether it is currently in use.
+No lockfile is created, since it gets recreated at need.
+
+If
+.I dstpath
+is specified it must be the path of an empty directory
+for storing the backup. Otherwise, the backup will be
+written to stdout.
+
 .SH DIAGNOSTICS
 Exit status is zero if no errors occur.
 Errors result in a non-zero exit status and
 a diagnostic message being written to standard error.
+.SH CAVEATS
+This utility can trigger significant file size growth if run
+in parallel with write transactions, because pages which they
+free during copying cannot be reused until the copy is done.
 .SH "SEE ALSO"
 .BR mdb_stat (1)
 .SH AUTHOR