Update README.md
authorChristopher L. Shannon <christopher.l.shannon@gmail.com>
Mon, 13 Mar 2017 11:56:12 +0000 (07:56 -0400)
committerGitHub <noreply@github.com>
Mon, 13 Mar 2017 11:56:12 +0000 (07:56 -0400)
Updating README with usage instructions

README.md

index a843b8b..638460b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,3 +4,53 @@ Apache ActiveMQ Command Line Tools
 The ActiveMQ Command Line Tools project is home to several CLI based projects
 useful for users of the ActiveMQ and ActiveMQ Artemis messaging brokers
 
+##ActiveMQ KahaDB Export Tool##
+
+This tool can be used to export a KahaDB or MultiKahaDB store to Artemis XML format.  The resulting XML document can then be imported into an Artemis broker using the Artemis CLI tool.  See [Artemis CLI tool](https://activemq.apache.org/artemis/docs/1.5.3/tools.html)
+
+###Usage###
+```
+$ ./bin/export help
+usage: export <command> [<args>]
+
+The most commonly used export commands are:
+    help      Display help information
+    kahadb    Export a KahaDb store to Artemis XML
+    mkahadb   Export a MultiKahaDb store to Artemis XML
+
+See 'export help <command>' for more information on a specific command.
+```
+```
+$ ./bin/export help kahadb
+NAME
+        export kahadb - Export a KahaDb store to Artemis XML
+
+SYNOPSIS
+        export kahadb [-c] [-f]
+                [(--qp <queuePattern> | --queuePattern <queuePattern>)]
+                (-s <source> | --source <source>) (-t <target> | --target <target>)
+                [(--tp <topicPattern> | --topicPattern <topicPattern>)]
+
+OPTIONS
+        -c
+            Compress output xml file using gzip
+
+        -f
+            Force XML output and overwrite existing file
+
+        --qp <queuePattern>, --queuePattern <queuePattern>
+            Queue Export Pattern
+
+        -s <source>, --source <source>
+            Data store directory location
+
+        -t <target>, --target <target>
+            Xml output file location
+
+        --tp <topicPattern>, --topicPattern <topicPattern>
+            Topic Export Pattern
+```
+
+###Example:###
+
+`./bin/export kahadb --source /some/directory/kahadb/ --target ~/some/directory/output.xml`