aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkaotisk <kaotisk@arching-kaos.org>2024-05-16 14:42:26 +0300
committerkaotisk <kaotisk@arching-kaos.org>2024-05-16 14:42:26 +0300
commitf8e99709712c62bf9ecd125b4bd747acdced165a (patch)
tree544008950e71c7078a50bbe1e121db44871df46b
parent69caf17805a3f22c8ce6d92a40871c909263a500 (diff)
downloadarching-kaos-tools-f8e99709712c62bf9ecd125b4bd747acdced165a.tar.gz
arching-kaos-tools-f8e99709712c62bf9ecd125b4bd747acdced165a.tar.bz2
arching-kaos-tools-f8e99709712c62bf9ecd125b4bd747acdced165a.zip
More descriptions
-rw-r--r--README4
-rwxr-xr-xbin/ak7
-rwxr-xr-xbin/ak-zblock15
3 files changed, 22 insertions, 4 deletions
diff --git a/README b/README
index fa33a36..1030ea7 100644
--- a/README
+++ b/README
@@ -196,8 +196,8 @@ Next things to come are:
zblocks.
- [X] - zchain rebase-like procedure to move the zblocks to another seed or set
another previous block (e.g. join chains)
-- [ ] - Clean up installation and filesystem usage
-- [ ] - Log rotate to gzip archives
+- [x] - Clean up installation and filesystem usage
+- [x] - Log rotate to gzip archives
- [ ] - Filters for log searching for IPFS hashes or names
- [ ] - Use of IPFS file system to store/pin sub chains, previous chains or
other chains
diff --git a/bin/ak b/bin/ak
index 1697913..bb991a1 100755
--- a/bin/ak
+++ b/bin/ak
@@ -1,5 +1,12 @@
#!/bin/bash
##
+## Arching Kaos CLI tool is the main executable script to use for exploring,
+## creating and distributing local blockchain(s) called zchain(s).
+##
+## It is accompanied with several utilities that help to create new blocks,
+## reference them, export blocks to HTML pages, "roll-back" your zchain to an
+## older block, reset your zchain and more.
+##
## -h, --help Prints this help message
##
## Run with no arguments to see available commands
diff --git a/bin/ak-zblock b/bin/ak-zblock
index d657ba5..47a6905 100755
--- a/bin/ak-zblock
+++ b/bin/ak-zblock
@@ -1,14 +1,25 @@
#!/bin/bash
##
-## Brief description
+## Performs various operations on a zblock. Additionally, it can also pack one
+## from given information, which can be added on top of your zchain.
##
## Usage:
##
## -h, --help Prints this help message
##
+## -s, --show Shows the zblock provided
+##
+## -x, --gen-html Generates an HTML document for a given zblock
+##
+## -c, --cache Caches a zblock
+##
+## -p, --pack Packs a zblock
+##
+## -a, --announce Announces a zblock
+##
fullprogrampath="$(realpath $0)"
PROGRAM=$(basename $0)
-descriptionString="Quick description"
+descriptionString="Various zblock operations"
# At least these
source $AK_LIBDIR/_ak_log