From 4229837170270928c02abd734f9e79504b8d5e70 Mon Sep 17 00:00:00 2001
From: Mark Qvist
Date: Thu, 21 Sep 2023 18:32:46 +0200
Subject: [PATCH] Updated documentation
---
docs/Reticulum Manual.epub | Bin 2489737 -> 2489737 bytes
docs/Reticulum Manual.pdf | Bin 2400198 -> 2400198 bytes
docs/manual/_sources/using.rst.txt | 59 +++++++++++++++++++++++++++--
docs/manual/genindex.html | 6 ++-
docs/manual/objects.inv | Bin 2436 -> 2445 bytes
docs/manual/reference.html | 16 ++++++++
docs/manual/searchindex.js | 2 +-
docs/manual/using.html | 50 ++++++++++++++++++++++--
docs/source/using.rst | 59 +++++++++++++++++++++++++++--
9 files changed, 180 insertions(+), 12 deletions(-)
diff --git a/docs/Reticulum Manual.epub b/docs/Reticulum Manual.epub
index 351dbc30607d0d3efd5486c0165a1178abc2d3a6..c97aa2ebe409ec84a71de11109b6533aea40f9dc 100644
GIT binary patch
delta 1505
zcmX}sdpy%?90zc-WX# Returns whether Transport is enabled for the running
+instance. When Transport is enabled, Reticulum will
+route traffic for other peers, respond to path requests
+and pass announces over the network. True if Transport is enabled, False if not.){+K%ne|(o9gsk9sy%4g46Dj(Bo<|TtL?jsSXkQ@`0^WJK3W>g-T!Z4_
JbXte({sj`3(ft4b
delta 1505
zcmX}sdpML?90zb?8ivUwJ0tgy*Jz26Ff`3jqG8E3_d=ynJ+4z@3KM0;ww1LRa%&@u
zsIg3Aa$6K_u0^a%a$A>>aUG#{&s+QKAD`#@J->6_=Q-~`CwY^NNCvnX2()IXspo|c
zdrze4BJ>ca(vBexv7UUq{dc$Dj%T{c#A3zZ(aGKtZ}|&+-#nAM8?I*?^tR*U-8omD
zzc7{c4@Pk!G>7m-3S0Hkqz)^u+{i8rU*WtKpXU;C^i$~QlFch#ro}swDwXPrvss7@
z)kier?QtV+-V*m7TI*9%ncND^4@Z>bMA)iUd`l)fKx%h7tFk&{)Q9qylqHW
+
diff --git a/docs/manual/objects.inv b/docs/manual/objects.inv
index 4efd025b81a47e5ffad583644cffcc67d3981a13..60a590fa8ed205a074504d12aff84795fbf68474 100644
GIT binary patch
delta 1230
zcmV;<1Tp)B6O9wF&;)-1rg4v9volwY0nXse<>;mfk7;~{q
+
+
+
+ Identity
ANNOUNCE_CAP
should_use_implicit_proof()
transport_enabled()
probe_destination_enabled()
Identity
Run rnsd
in service mode, ensuring all logging output is sent directly to file:
$ rnsd -s
+
Generate a verbose and detailed configuration example, with explanations of all the +various configuration options, and interface configuration examples:
+$ rnsd --exampleconfig
+
All Command-Line Options
usage: rnsd.py [-h] [--config CONFIG] [-v] [-q] [-s] [--exampleconfig] [--version]
@@ -600,18 +620,41 @@ options:
The rnprobe
utility lets you probe a destination for connectivity, similar
to the ping
program. Please note that probes will only be answered if the
specified destination is configured to send proofs for received packets. Many
-destinations will not have this option enabled, and will not be probable.
+destinations will not have this option enabled, so most destinations will not
+be probable.
+You can enable a probe-reply destination on Reticulum Transport Instances by
+setting the respond_to_probes
configuration directive. Reticulum will then
+print the probe destination to the log on Transport Instance startup.
Usage Examples
Probe a destination:
-$ rnprobe example_utilities.echo.request 2d03725b327348980d570f739a3a5708
+$ rnprobe rnstransport.probe 2d03725b327348980d570f739a3a5708
Sent 16 byte probe to <2d03725b327348980d570f739a3a5708>
Valid reply received from <2d03725b327348980d570f739a3a5708>
Round-trip time is 38.469 milliseconds over 2 hops
+Send a larger probe:
+$ rnprobe rnstransport.probe 2d03725b327348980d570f739a3a5708 -s 256
+
+Sent 16 byte probe to <2d03725b327348980d570f739a3a5708>
+Valid reply received from <2d03725b327348980d570f739a3a5708>
+Round-trip time is 38.781 milliseconds over 2 hops
+
+
+If the interface that receives the probe replies supports reporting radio
+parameters such as RSSI and SNR, the rnprobe
utility will print
+these as part of the result as well.
+$ rnprobe rnstransport.probe e7536ee90bd4a440e130490b87a25124
+
+Sent 16 byte probe to <e7536ee90bd4a440e130490b87a25124>
+Valid reply received from <e7536ee90bd4a440e130490b87a25124>
+Round-trip time is 1.809 seconds over 1 hop [RSSI -73 dBm] [SNR 12.0 dB]
+
+
All Command-Line Options
-usage: rnprobe [-h] [--config CONFIG] [--version] [-v] [full_name] [destination_hash]
+usage: rnprobe [-h] [--config CONFIG] [--version] [-v] [-s SIZE]
+ [full_name] [destination_hash]
Reticulum Probe Utility
@@ -622,6 +665,7 @@ positional arguments:
optional arguments:
-h, --help show this help message and exit
--config CONFIG path to alternative Reticulum config directory
+ -s SIZE, --size SIZE size of probe packet payload in bytes
--version show program's version number and exit
-v, --verbose
diff --git a/docs/source/using.rst b/docs/source/using.rst
index 2e5b0a0..a291e92 100644
--- a/docs/source/using.rst
+++ b/docs/source/using.rst
@@ -108,6 +108,17 @@ configuration file is created. The default configuration looks like this:
panic_on_interface_error = No
+ # When Transport is enabled, it is possible to allow the
+ # Transport Instance to respond to probe requests from
+ # the rnprobe utility. This can be a useful tool to test
+ # connectivity. When this option is enabled, the probe
+ # destination will be generated from the Identity of the
+ # Transport Instance, and printed to the log at startup.
+ # Optional, and disabled by default.
+
+ respond_to_probes = No
+
+
[logging]
# Valid log levels are 0 through 7:
# 0: Log only critical information
@@ -192,6 +203,19 @@ Run ``rnsd``:
[2023-08-18 17:59:56] [Notice] Started rnsd version 0.5.8
+Run ``rnsd`` in service mode, ensuring all logging output is sent directly to file:
+
+.. code:: text
+
+ $ rnsd -s
+
+Generate a verbose and detailed configuration example, with explanations of all the
+various configuration options, and interface configuration examples:
+
+.. code:: text
+
+ $ rnsd --exampleconfig
+
**All Command-Line Options**
.. code:: text
@@ -439,7 +463,12 @@ The rnprobe Utility
The ``rnprobe`` utility lets you probe a destination for connectivity, similar
to the ``ping`` program. Please note that probes will only be answered if the
specified destination is configured to send proofs for received packets. Many
-destinations will not have this option enabled, and will not be probable.
+destinations will not have this option enabled, so most destinations will not
+be probable.
+
+You can enable a probe-reply destination on Reticulum Transport Instances by
+setting the ``respond_to_probes`` configuration directive. Reticulum will then
+print the probe destination to the log on Transport Instance startup.
**Usage Examples**
@@ -447,17 +476,40 @@ Probe a destination:
.. code:: text
- $ rnprobe example_utilities.echo.request 2d03725b327348980d570f739a3a5708
+ $ rnprobe rnstransport.probe 2d03725b327348980d570f739a3a5708
Sent 16 byte probe to <2d03725b327348980d570f739a3a5708>
Valid reply received from <2d03725b327348980d570f739a3a5708>
Round-trip time is 38.469 milliseconds over 2 hops
+Send a larger probe:
+
+.. code:: text
+
+ $ rnprobe rnstransport.probe 2d03725b327348980d570f739a3a5708 -s 256
+
+ Sent 16 byte probe to <2d03725b327348980d570f739a3a5708>
+ Valid reply received from <2d03725b327348980d570f739a3a5708>
+ Round-trip time is 38.781 milliseconds over 2 hops
+
+If the interface that receives the probe replies supports reporting radio
+parameters such as **RSSI** and **SNR**, the ``rnprobe`` utility will print
+these as part of the result as well.
+
+.. code:: text
+
+ $ rnprobe rnstransport.probe e7536ee90bd4a440e130490b87a25124
+
+ Sent 16 byte probe to
+ Valid reply received from
+ Round-trip time is 1.809 seconds over 1 hop [RSSI -73 dBm] [SNR 12.0 dB]
+
**All Command-Line Options**
.. code:: text
- usage: rnprobe [-h] [--config CONFIG] [--version] [-v] [full_name] [destination_hash]
+ usage: rnprobe [-h] [--config CONFIG] [--version] [-v] [-s SIZE]
+ [full_name] [destination_hash]
Reticulum Probe Utility
@@ -468,6 +520,7 @@ Probe a destination:
optional arguments:
-h, --help show this help message and exit
--config CONFIG path to alternative Reticulum config directory
+ -s SIZE, --size SIZE size of probe packet payload in bytes
--version show program's version number and exit
-v, --verbose