From 2772a32907e9c52689f2d32b9be813f285685bce Mon Sep 17 00:00:00 2001
From: Jeff <jeff@i2p.rocks>
Date: Fri, 10 Dec 2021 10:38:10 -0500
Subject: [PATCH] * fix up lokinet cli help opts * document doxygen

---
 daemon/lokinet.cpp          | 25 +++++---------------
 docs/README                 |  5 ----
 docs/readme.md              | 34 +++++++++++++++++++++++++++
 docs/snap-config-options.md | 47 -------------------------------------
 4 files changed, 40 insertions(+), 71 deletions(-)
 delete mode 100644 docs/README
 create mode 100644 docs/readme.md
 delete mode 100644 docs/snap-config-options.md

diff --git a/daemon/lokinet.cpp b/daemon/lokinet.cpp
index 2c1a70794..ebddf84e1 100644
--- a/daemon/lokinet.cpp
+++ b/daemon/lokinet.cpp
@@ -401,19 +401,17 @@ lokinet_main(int argc, char* argv[])
       "and IP based onion routing network");
   // clang-format off
   options.add_options()
-      ("v,verbose", "Verbose", cxxopts::value<bool>())
 #ifdef _WIN32
       ("install", "install win32 daemon to SCM", cxxopts::value<bool>())
       ("remove", "remove win32 daemon from SCM", cxxopts::value<bool>())
 #endif
-      ("h,help", "help", cxxopts::value<bool>())("version", "version", cxxopts::value<bool>())
-      ("g,generate", "generate client config", cxxopts::value<bool>())
-      ("r,router", "run as router instead of client", cxxopts::value<bool>())
-      ("f,force", "overwrite", cxxopts::value<bool>())
+      ("h,help", "print this help message", cxxopts::value<bool>())
+      ("version", "print version string", cxxopts::value<bool>())
+      ("g,generate", "generate default configuration and exit", cxxopts::value<bool>())
+      ("r,router", "run in routing mode instead of client only mode", cxxopts::value<bool>())
+      ("f,force", "force writing config even if it already exists", cxxopts::value<bool>())
       ("c,colour", "colour output", cxxopts::value<bool>()->default_value("true"))
-      ("b,background", "background mode (start, but do not connect to the network)",
-       cxxopts::value<bool>())
-      ("config", "path to configuration file", cxxopts::value<std::string>())
+      ("config", "path to lokinet.ini configuration file", cxxopts::value<std::string>())
       ;
   // clang-format on
 
@@ -426,12 +424,6 @@ lokinet_main(int argc, char* argv[])
   {
     auto result = options.parse(argc, argv);
 
-    if (result.count("verbose") > 0)
-    {
-      SetLogLevel(llarp::eLogDebug);
-      llarp::LogDebug("debug logging activated");
-    }
-
     if (!result["colour"].as<bool>())
     {
       llarp::LogContext::Instance().logStream =
@@ -467,11 +459,6 @@ lokinet_main(int argc, char* argv[])
       genconfigOnly = true;
     }
 
-    if (result.count("background") > 0)
-    {
-      opts.background = true;
-    }
-
     if (result.count("router") > 0)
     {
       opts.isSNode = true;
diff --git a/docs/README b/docs/README
deleted file mode 100644
index f01a01d3b..000000000
--- a/docs/README
+++ /dev/null
@@ -1,5 +0,0 @@
-Protocol Specifications Directory
-
-All documents in this directory are licened CC0 and placed into the public domain.
-
-Please note that the reference implementation LokiNET is licensed under ZLIB license
diff --git a/docs/readme.md b/docs/readme.md
new file mode 100644
index 000000000..91899d771
--- /dev/null
+++ b/docs/readme.md
@@ -0,0 +1,34 @@
+# Lokinet Internals docs
+
+this is the area of the repo for documentation of lokinet internals
+
+
+
+
+
+## Doxygen
+
+building doxygen docs requires the following:
+
+* cmake
+* doxygen
+* sphinx-build
+* sphinx readthedocs theme
+* breathe
+* exhale
+
+install packages:
+
+    $ sudo apt install doxygen python3-sphinx python3-sphinx-rtd-theme python3-breathe python3-pip
+    $ pip3 install --user exhale
+    
+build docs:
+
+    $ mkdir -p build-docs
+    $ cd build-docs
+    $ cmake .. && make doc 
+
+serve built docs via http, will be served at http://127.0.0.1:8000/
+
+    $ python3 -m http.server -d docs/html
+    
diff --git a/docs/snap-config-options.md b/docs/snap-config-options.md
deleted file mode 100644
index 0979fe22a..000000000
--- a/docs/snap-config-options.md
+++ /dev/null
@@ -1,47 +0,0 @@
-
-# snapp config options
-
-## required
-
-### ifname
-network interface name 
-### ifaddr
-ip range of network interface
-
-## optional
-
-### keyfile
-the private key to persist address with.
-if not specified the address will be ephemeral.
-### reachable
-bool value that sets if we publish our snapp to the dht
-`true`: we are reachable via dht
-`false`: we are not reachable via dht
-### hops
-number of hops in a path, min is `1`, max is `8`, defaults to `4`
-### paths
-number of paths to maintain at any given time, defaults to `6`.
-### blacklist-snode
-adds a `.snode` to path build blacklist
-### exit-node
-specify a `.snode` or `.loki` address to use as an exit broker
-### local-dns
-address to bind local dns resoler to, defaults to `127.3.2.1:53`
-if port is omitted it uses port `53`
-### upstream-dns
-address to forward non lokinet related queries to. if not set lokinet dns will reply with srvfail.
-### mapaddr
-perma map `.loki` address to an ip owned by the snapp
-to map `whatever.loki` to `10.0.10.10` it can be specified via:
-```
-mapaddr=whatever.loki:10.0.10.10
-```
-
-## compile time optional features
-
-### on-up
-path to shell script to call when our interface is up
-### on-down
-path to shell script to call when our interface is down
-### on-ready
-path to shell script to call when snapp is first ready