Git-Mirrors/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2024-12-25 15:39:32 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Mark Qvist 2022-05-14 22:21:59 +02:00
parent d66c31b4e9
commit ff74b5a0af
4 changed files with 37 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/manual/_sources/using.rst.txt
View File

@ -135,21 +135,22 @@ destinations on the Reticulum network.
.. code:: text .. code:: text
usage: rnpath [-h] [--config CONFIG] [--version] [-t] [-d] [-w seconds] [-v] usage: rnpath.py [-h] [--config CONFIG] [--version] [-t] [-r] [-d] [-D] [-w seconds] [-v] [destination]
[destination]
Reticulum Path Discovery Utility Reticulum Path Discovery Utility
positional arguments: positional arguments:
destination hexadecimal hash of the destination destination hexadecimal hash of the destination
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
--config CONFIG path to alternative Reticulum config directory --config CONFIG path to alternative Reticulum config directory
--version show program's version number and exit --version show program's version number and exit
-t, --table show all known paths -t, --table show all known paths
-d, --drop remove the path to a destination -r, --rates show announce rate info
-w seconds timeout before giving up -d, --drop remove the path to a destination
-D, --drop-announces drop all queued announces
-w seconds timeout before giving up
-v, --verbose -v, --verbose

2
docs/manual/searchindex.js
View File

File diff suppressed because one or more lines are too long

19
docs/manual/using.html
View File

@ -156,21 +156,22 @@ rnpath eca6f4e4dc26ae329e61
Path found, destination <eca6f4e4dc26ae329e61> is 4 hops away via <56b115c30cd386cad69c> on TCPInterface[Testnet/frankfurt.rns.unsigned.io:4965] Path found, destination <eca6f4e4dc26ae329e61> is 4 hops away via <56b115c30cd386cad69c> on TCPInterface[Testnet/frankfurt.rns.unsigned.io:4965]
</pre></div> </pre></div>
</div> </div>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage: rnpath [-h] [--config CONFIG] [--version] [-t] [-d] [-w seconds] [-v] <div class="highlight-text notranslate"><div class="highlight"><pre><span></span>usage: rnpath.py [-h] [--config CONFIG] [--version] [-t] [-r] [-d] [-D] [-w seconds] [-v] [destination]
[destination]
Reticulum Path Discovery Utility Reticulum Path Discovery Utility
positional arguments: positional arguments:
destination hexadecimal hash of the destination destination hexadecimal hash of the destination
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
--config CONFIG path to alternative Reticulum config directory --config CONFIG path to alternative Reticulum config directory
--version show program&#39;s version number and exit --version show program&#39;s version number and exit
-t, --table show all known paths -t, --table show all known paths
-d, --drop remove the path to a destination -r, --rates show announce rate info
-w seconds timeout before giving up -d, --drop remove the path to a destination
-D, --drop-announces drop all queued announces
-w seconds timeout before giving up
-v, --verbose -v, --verbose
</pre></div> </pre></div>
</div> </div>

19
docs/source/using.rst
View File

@ -135,21 +135,22 @@ destinations on the Reticulum network.
.. code:: text .. code:: text
usage: rnpath [-h] [--config CONFIG] [--version] [-t] [-d] [-w seconds] [-v] usage: rnpath.py [-h] [--config CONFIG] [--version] [-t] [-r] [-d] [-D] [-w seconds] [-v] [destination]
[destination]
Reticulum Path Discovery Utility Reticulum Path Discovery Utility
positional arguments: positional arguments:
destination hexadecimal hash of the destination destination hexadecimal hash of the destination
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
--config CONFIG path to alternative Reticulum config directory --config CONFIG path to alternative Reticulum config directory
--version show program's version number and exit --version show program's version number and exit
-t, --table show all known paths -t, --table show all known paths
-d, --drop remove the path to a destination -r, --rates show announce rate info
-w seconds timeout before giving up -d, --drop remove the path to a destination
-D, --drop-announces drop all queued announces
-w seconds timeout before giving up
-v, --verbose -v, --verbose