aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkaotisk <kaotisk@arching-kaos.org>2024-06-24 04:16:45 +0300
committerkaotisk <kaotisk@arching-kaos.org>2024-06-24 04:16:45 +0300
commitd14dda9f79215ab44684e0f5a64327a079a6c58f (patch)
treecd6955ccffbc97d70f5f8abee9815f9424b64fbf
parent432acf6bf5cd42025a63266e77bacd8c5256c0a5 (diff)
downloadarching-kaos-tools-d14dda9f79215ab44684e0f5a64327a079a6c58f.tar.gz
arching-kaos-tools-d14dda9f79215ab44684e0f5a64327a079a6c58f.tar.bz2
arching-kaos-tools-d14dda9f79215ab44684e0f5a64327a079a6c58f.zip
minor updates in docs and formattings
-rw-r--r--NETWORKING2
-rw-r--r--README30
-rw-r--r--REQUIREMENTS2
-rwxr-xr-xlib/_ak_log2
4 files changed, 26 insertions, 10 deletions
diff --git a/NETWORKING b/NETWORKING
index 8306bda..a8df3cd 100644
--- a/NETWORKING
+++ b/NETWORKING
@@ -92,7 +92,7 @@ the machine you want to network with/from. Furthermore, you will also need the
cjdns-tools, laying under the tools folder in the cjdns repository to be in your
PATH.
-You then can use the `ak-cjdns-scanner` to find other akdaemon(s) running around
+You then can use the `ak network -s cjdns` to find other akdaemon(s) running in
your relative neighbourhood. `dumpLinks` is used to retrieve the nodes in this
area. You can find more intense scanning scripts around like `walk.sh` by ircerr
which is able to reach the whole public network of cjdns.
diff --git a/README b/README
index 369f174..1ce02e3 100644
--- a/README
+++ b/README
@@ -244,7 +244,7 @@ Schain tools
------------
- ak-mempool # TODO
- ak-miner-script PROTO Prototype miner
- - ak-network # TODO
+ - ak-network # Network Tools (connect to, scan for, dump peers)
- ak-sblock-show # Returns a mined SBLOCK
- ak-find-latest-mined-sblock # In a hay of SBLOCKS finds the latest
@@ -291,11 +291,25 @@ File splitters
- ak-sm-filejoiner # Joins a file from a map
- ak-sm-filesplitter # Splits a file to chunks and creates a map
-File system
------------
- - ak-fs-add # Adds a file to filesystem tree (returns root hash)
- - ak-fs-get # Constructs a file from root hash to filename
- - ak-fs-cat # Constructs a file from root hash to stdout
+FS tools
+--------
+ - ak-fs
+
+```bash
+$ ak fs --help
+
+Tools to add, get and cat files to/from the Arching Kaos File System
+
+Usage:
+
+ -h, --help Prints this help message
+
+ --add, --import <file> Adds/Imports a file to the AKFS system
+
+ --get, --export <hash> <output file> Exports a file from the AKFS system
+
+ --cat <hash> Concatenates from given hash
+```
Libraries
---------
@@ -303,8 +317,8 @@ Libraries
- lib/_ak_fs
- lib/_ak_gpg
- lib/_ak_newline
- - lib/_ak_script_description
- - lib/_ak_script_exit
+ - lib/_ak_network
+ - lib/_ak_script
- lib/_ak_log
IPFS Wrappers
diff --git a/REQUIREMENTS b/REQUIREMENTS
index e551afb..95d93c7 100644
--- a/REQUIREMENTS
+++ b/REQUIREMENTS
@@ -24,5 +24,5 @@ installation and if not found there is an attempt to install them.
IPFS command line tool is also needed but is installed as well during the
installation process.
-CJDNS can be used as a peering method. ak-cjdns-scanner can be used to retrieve
+CJDNS can be used as a peering method. `ak network -s cjdns` can be used to find
them. This requires CJDNS to be running and `dumpLinks` tool to be in your PATH.
diff --git a/lib/_ak_log b/lib/_ak_log
index 0674a45..a25ef00 100755
--- a/lib/_ak_log
+++ b/lib/_ak_log
@@ -106,3 +106,5 @@ _ak_log_error(){
_ak_log_info(){
_ak_log_message "$PROGRAM" "INFO" "$1"
}
+
+# vim: set syntax=bash