diff --git a/README.md b/README.md index 33b9976..a4f2996 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ## Available Tools * [tgsql](./modules/tgsql/cli) - Text based SQL client program. -* [tgdump](./modules/tgdump/cli) - Table Dump Tool. +* [tgdump](./modules/tgdump) - Table Dump Tool. ## Requirements diff --git a/modules/tgdump/cli/README.md b/modules/tgdump/README.md similarity index 63% rename from modules/tgdump/cli/README.md rename to modules/tgdump/README.md index e78f12e..3a6f7e1 100644 --- a/modules/tgdump/cli/README.md +++ b/modules/tgdump/README.md @@ -2,7 +2,33 @@ Tsurugi Table Dump Tool extracts the contents of table data and saves them on files. -## command specification +## Build and Install + +Execute the below command in this directory (`/modules/tgdump`): + +```sh +../../gradlew assemble +``` + +This will create the following distribution archives: + +* `cli/build/distributions/tgdump-.zip` +* `cli/build/distributions/tgdump-.tar.gz` +* `cli/build/distributions/tgdump--shadow.zip` +* `cli/build/distributions/tgdump--shadow.tar.gz` + +Each of the archives above contains the following contents: + +* `tgdump-(-shadow)/bin/tgdump` + * A script for executing the command + * Additionally, `tgdump.bat` is included for Windows users +* `tgdump-(-shadow)/lib/*.jar` + * Java libraries used by the command + * For the -shadow archives, the above is packaged into a single "Uber JAR" file + +Deploy the files mentioned above, and the tgdump command will be available for use. + +## Command specification ```sh tgdump [ [...]] --to --connection ...