Documentation of packaged executable

[ibnesayeed]

When the OpenWayback source is built using mvn package, build artifacts include a bin directory that contains various executable scripts. Only the cdx-indexer tool is mentioned in the documentation (without much details of its usage and options available). It would be nice to have a wiki page that describes each executable briefly.

I have added a wiki page and populated it with all the packaged scripts and their CLI usage output. However, each utility needs some description and the purpose as the CLI usage documentation is often not very helpful.

• [ ] bdb-client
• [ ] bin-search
• [ ] cdx-indexer
• [ ] cdx-sample
• [ ] create-test-arc
• [ ] location-client
• [ ] url-client
• [ ] warc-header
• [ ] zipline-manifest
• [ ] zl-bin-search

[ldko]

@ibnesayeed do you want to do the documentation?

[ibnesayeed]

@ldko, I really don't know much about those tools. However, I can create a template page where I would list all the tools that are provided, then someone can fill in the details.

[ldko]

@ibnesayeed ok, when you do that, if you want to also make a checklist on this issue of which tools need documentation, so we can check them off as they are done, that would be helpful too. Thanks!

[ibnesayeed]

@ldko, I have updated the first post with a checklist and a link to the newly created wiki page. I have already populated the page with corresponding CLI usage documentation.