summaryrefslogtreecommitdiff
path: root/tools/dbtool/docs/dbtool-readme.txt
diff options
context:
space:
mode:
Diffstat (limited to 'tools/dbtool/docs/dbtool-readme.txt')
-rw-r--r--tools/dbtool/docs/dbtool-readme.txt27
1 files changed, 27 insertions, 0 deletions
diff --git a/tools/dbtool/docs/dbtool-readme.txt b/tools/dbtool/docs/dbtool-readme.txt
new file mode 100644
index 0000000000..26721a0d6c
--- /dev/null
+++ b/tools/dbtool/docs/dbtool-readme.txt
@@ -0,0 +1,27 @@
+ Miranda Database Tool
+ ~~~~~~~~~~~~~~~~~~~~~
+
+ www: http://www.miranda-im.org
+ e-mail: info@miranda-im.org
+
+
+This is a thingy for compacting wasted space in your Miranda database and
+fixing inconsistencies that may have been introduced.
+
+To keep it simple and robust, Miranda will not by itself reclaim any blank
+space created by deleting information from its profile databases, so this tool
+will do that for you. It can also fix some problems that may occur in rare
+circumstances. Since it also re-writes the database in a more sensible order
+(a bit like defragmenting your hard disk) you may find that you get a speed
+improvement in Miranda by running your database through this tool.
+
+Todo: There is no support for any command line parameters to allow for
+unattended operation yet, and it would be helpful if there was better
+integration with Miranda to allow compaction when necessary. It's also
+possible to fix a larger range of faults than it currently can do, but that
+requires significantly more work.
+
+This programme is copyrighted by Richard Hughes 2001,2002,2003 and is covered
+under the terms of the GNU General Public License.
+
+Source code is available from the Miranda IM website.