From 241eac3e83faacb617310bee3c746a7fd1defdfb Mon Sep 17 00:00:00 2001 From: Sawood Alam Date: Fri, 29 Jun 2018 19:02:50 -0400 Subject: [PATCH] Update CLI documentation in the README, close #409 --- README.rst | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 9cde0ad9..e68a0186 100644 --- a/README.rst +++ b/README.rst @@ -160,33 +160,37 @@ Usage of sub-commands in ipwb can be accessed through providing the `-h` or `--h .. code-block:: bash $ ipwb index -h - usage: ipwb [-h] [-e] [-c] [--compressFirst] [--debug] + usage: ipwb [-h] [-e] [-c] [--compressFirst] [-o OUTFILE] [--debug] index [index ...] Index a WARC file for replay in ipwb positional arguments: - index Path to a WARC[.gz] file + index Path to a WARC[.gz] file optional arguments: - -h, --help show this help message and exit - -e Encrypt WARC content prior to adding to IPFS - -c Compress WARC content prior to adding to IPFS - --compressFirst Compress data before encryption, where applicable - --debug Convenience flag to help with testing and debugging + -h, --help show this help message and exit + -e Encrypt WARC content prior to adding to IPFS + -c Compress WARC content prior to adding to IPFS + --compressFirst Compress data before encryption, where applicable + -o OUTFILE, --outfile OUTFILE + Path to an output CDXJ file, defaults to STDOUT + --debug Convenience flag to help with testing and debugging .. code-block:: bash $ ipwb replay -h - usage: ipwb replay [-h] [index] + usage: ipwb replay [-h] [-P []] [index] Start the ipwb relay system positional arguments: - index path, URI, or multihash of file to use for replay + index path, URI, or multihash of file to use for replay optional arguments: - -h, --help show this help message and exit + -h, --help show this help message and exit + -P [], --proxy [] + Proxy URL Project History