]> git.sur5r.net Git - openldap/blobdiff - libraries/liblmdb/mdb_copy.1
ITS#8329
[openldap] / libraries / liblmdb / mdb_copy.1
index 11a0042df45fdb3669585037a68be398be46da9e..1e2a97694fb402a9291371184b1d91d383dcf71a 100644 (file)
@@ -1,16 +1,25 @@
-.TH MDB_COPY 1 "2012/12/12" "LMDB 0.9.5"
-.\" Copyright 2012 Howard Chu, Symas Corp. All Rights Reserved.
+.TH MDB_COPY 1 "2014/06/20" "LMDB 0.9.14"
+.\" Copyright 2012-2015 Howard Chu, Symas Corp. All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .SH NAME
 mdb_copy \- LMDB environment copy tool
 .SH SYNOPSIS
 .B mdb_copy
-.I srcpath\ [dstpath]
+[\c
+.BR \-V ]
+[\c
+.BR \-c ]
+[\c
+.BR \-n ]
+.B srcpath
+[\c
+.BR 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
@@ -18,15 +27,27 @@ is specified it must be the path of an empty directory
 for storing the backup. Otherwise, the backup will be
 written to stdout.
 
-Note: currently, if the copy is interrupted a stale lock
-will be left in the LMDB environment. This may be fixed
-in a future release, but until then you must not
-interrupt the copy process.
+.SH OPTIONS
+.TP
+.BR \-V
+Write the library version number to the standard output, and exit.
+.TP
+.BR \-c
+Compact while copying. Only current data pages will be copied; freed
+or unused pages will be omitted from the copy. This option will
+slow down the backup process as it is more CPU-intensive.
+.TP
+.BR \-n
+Open LDMB environment(s) which do not use subdirectories.
 
 .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