From 460a05bf787d06220c60c8c021b2b73e164447ab Mon Sep 17 00:00:00 2001 From: Howard Chu Date: Wed, 19 Dec 2012 13:09:56 -0800 Subject: [PATCH] Add initial mdb utility manpages --- libraries/liblmdb/mdb_copy.1 | 21 ++++++++++++++++ libraries/liblmdb/mdb_stat.1 | 46 ++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+) create mode 100644 libraries/liblmdb/mdb_copy.1 create mode 100644 libraries/liblmdb/mdb_stat.1 diff --git a/libraries/liblmdb/mdb_copy.1 b/libraries/liblmdb/mdb_copy.1 new file mode 100644 index 0000000000..2c925a73ef --- /dev/null +++ b/libraries/liblmdb/mdb_copy.1 @@ -0,0 +1,21 @@ +.TH MDB_COPY 1 "2012/12/12" "LMDB 0.9.5" +.\" Copyright 2012 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_stat +.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. +.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 "SEE ALSO" +.BR mdb_stat (1) +.SH AUTHOR +Howard Chu of Symas Corporation diff --git a/libraries/liblmdb/mdb_stat.1 b/libraries/liblmdb/mdb_stat.1 new file mode 100644 index 0000000000..205fc88dee --- /dev/null +++ b/libraries/liblmdb/mdb_stat.1 @@ -0,0 +1,46 @@ +.TH MDB_STAT 1 "2012/12/12" "LMDB 0.9.5" +.\" Copyright 2012 Howard Chu, Symas Corp. All Rights Reserved. +.\" Copying restrictions apply. See COPYRIGHT/LICENSE. +.SH NAME +mdb_stat \- LMDB environment status tool +.SH SYNOPSIS +.B mdb_stat +.BR \ envpath +[\c +.BR \-e ] +[\c +.BR \-f [ f ]] +[\c +.BR \-n ] +[\c +.BR \-a \ | +.BI \-s \ subdb\fR] +.SH DESCRIPTION +The +.B mdb_stat +utility displays the status of an LMDB environment. +.SH OPTIONS +.TP +.BR \-e +Display information about the database environment. +.TP +.BR \-f +Display information about the environment freelist. If \fB\-ff\fP is given, +display the full list of page IDs in the freelist. +.TP +.BR \-n +Display the status of an LMDB database which does not use subdirectories. +.TP +.BR \-a +Display the status of all of the subdatabases in the environment. +.TP +.BR \-s \ subdb +Display the status of a specific subdatabase. +.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 "SEE ALSO" +.BR mdb_copy (1) +.SH AUTHOR +Howard Chu of Symas Corporation