Updated documentation and manual
This commit is contained in:
parent
18f450c58b
commit
0c47ff1ccc
Binary file not shown.
@ -86,7 +86,7 @@ Creating a Network With Reticulum
|
|||||||
=============================================
|
=============================================
|
||||||
To create a network, you will need to specify one or more *interfaces* for
|
To create a network, you will need to specify one or more *interfaces* for
|
||||||
Reticulum to use. This is done in the Reticulum configuration file, which by
|
Reticulum to use. This is done in the Reticulum configuration file, which by
|
||||||
default is located at ``~/.reticulum/config``. You can edit this file by hand,
|
default is located at ``~/.config/reticulum/config``. You can edit this file by hand,
|
||||||
or use the interactive ``rnsconfig`` utility.
|
or use the interactive ``rnsconfig`` utility.
|
||||||
|
|
||||||
When Reticulum is started for the first time, it will create a default
|
When Reticulum is started for the first time, it will create a default
|
||||||
@ -261,7 +261,7 @@ don't use pip, but try this recipe:
|
|||||||
|
|
||||||
# Unless you've manually created a config file, Reticulum will do so now,
|
# Unless you've manually created a config file, Reticulum will do so now,
|
||||||
# and immediately exit. Make any necessary changes to the file:
|
# and immediately exit. Make any necessary changes to the file:
|
||||||
nano ~/.reticulum/config
|
nano ~/.config/reticulum/config
|
||||||
|
|
||||||
# ... and launch the example again.
|
# ... and launch the example again.
|
||||||
python3 Examples/Echo.py -s
|
python3 Examples/Echo.py -s
|
||||||
|
@ -82,7 +82,7 @@ communications channels as the underlying carrier for Reticulum.
|
|||||||
However, most real-world networks will probably involve either some form of
|
However, most real-world networks will probably involve either some form of
|
||||||
wireless or direct hardline communications. To allow Reticulum to communicate
|
wireless or direct hardline communications. To allow Reticulum to communicate
|
||||||
over any type of medium, you must specify it in the configuration file, by default
|
over any type of medium, you must specify it in the configuration file, by default
|
||||||
located at ``~/.reticulum/config``. See the :ref:`Supported Interfaces<interfaces-main>`
|
located at ``~/.config/reticulum/config``. See the :ref:`Supported Interfaces<interfaces-main>`
|
||||||
chapter of this manual for interface configuration examples.
|
chapter of this manual for interface configuration examples.
|
||||||
|
|
||||||
Any number of interfaces can be configured, and Reticulum will automatically
|
Any number of interfaces can be configured, and Reticulum will automatically
|
||||||
|
@ -23,7 +23,7 @@ Configuration & Data
|
|||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
A Reticulum stores all information that it needs to function in a single file-
|
A Reticulum stores all information that it needs to function in a single file-
|
||||||
system directory. By default, this directory is ``~/.reticulum``, but you can
|
system directory. By default, this directory is ``~/.config/reticulum``, but you can
|
||||||
use any directory you wish. You can also run multiple separate Reticulum
|
use any directory you wish. You can also run multiple separate Reticulum
|
||||||
instances on the same physical system, in complete isolation from each other,
|
instances on the same physical system, in complete isolation from each other,
|
||||||
or connected together.
|
or connected together.
|
||||||
@ -34,7 +34,7 @@ be brought up when a program needs it. In either case, any number of programs
|
|||||||
running on the same system will automatically share the same Reticulum instance,
|
running on the same system will automatically share the same Reticulum instance,
|
||||||
if the configuration allows for it, which it does by default.
|
if the configuration allows for it, which it does by default.
|
||||||
|
|
||||||
The entire configuration of Reticulum is found in the ``~/.reticulum/config``
|
The entire configuration of Reticulum is found in the ``~/.config/reticulum/config``
|
||||||
file. When Reticulum is first started on a new system, a basic, functional
|
file. When Reticulum is first started on a new system, a basic, functional
|
||||||
configuration file is created. The default configuration looks like this:
|
configuration file is created. The default configuration looks like this:
|
||||||
|
|
||||||
@ -371,7 +371,7 @@ output.
|
|||||||
rnx 7a55144adf826958a9529a3bcf08b149 -x
|
rnx 7a55144adf826958a9529a3bcf08b149 -x
|
||||||
|
|
||||||
# The default identity file is stored in
|
# The default identity file is stored in
|
||||||
# ~/.reticulum/identities/rnx, but you can use
|
# ~/.config/reticulum/identities/rnx, but you can use
|
||||||
# another one, which will be created if it does
|
# another one, which will be created if it does
|
||||||
# not already exist
|
# not already exist
|
||||||
rnx 7a55144adf826958a9529a3bcf08b149 -i /path/to/identity -x
|
rnx 7a55144adf826958a9529a3bcf08b149 -i /path/to/identity -x
|
||||||
|
@ -107,7 +107,7 @@ network status and connectivity.</p>
|
|||||||
<h2>Creating a Network With Reticulum<a class="headerlink" href="#creating-a-network-with-reticulum" title="Permalink to this headline">¶</a></h2>
|
<h2>Creating a Network With Reticulum<a class="headerlink" href="#creating-a-network-with-reticulum" title="Permalink to this headline">¶</a></h2>
|
||||||
<p>To create a network, you will need to specify one or more <em>interfaces</em> for
|
<p>To create a network, you will need to specify one or more <em>interfaces</em> for
|
||||||
Reticulum to use. This is done in the Reticulum configuration file, which by
|
Reticulum to use. This is done in the Reticulum configuration file, which by
|
||||||
default is located at <code class="docutils literal notranslate"><span class="pre">~/.reticulum/config</span></code>. You can edit this file by hand,
|
default is located at <code class="docutils literal notranslate"><span class="pre">~/.config/reticulum/config</span></code>. You can edit this file by hand,
|
||||||
or use the interactive <code class="docutils literal notranslate"><span class="pre">rnsconfig</span></code> utility.</p>
|
or use the interactive <code class="docutils literal notranslate"><span class="pre">rnsconfig</span></code> utility.</p>
|
||||||
<p>When Reticulum is started for the first time, it will create a default
|
<p>When Reticulum is started for the first time, it will create a default
|
||||||
configuration file, with one active interface. This default interface uses
|
configuration file, with one active interface. This default interface uses
|
||||||
@ -252,7 +252,7 @@ don’t use pip, but try this recipe:</p>
|
|||||||
|
|
||||||
<span class="c1"># Unless you've manually created a config file, Reticulum will do so now,</span>
|
<span class="c1"># Unless you've manually created a config file, Reticulum will do so now,</span>
|
||||||
<span class="c1"># and immediately exit. Make any necessary changes to the file:</span>
|
<span class="c1"># and immediately exit. Make any necessary changes to the file:</span>
|
||||||
<span class="n">nano</span> <span class="o">~/.</span><span class="n">reticulum</span><span class="o">/</span><span class="n">config</span>
|
<span class="n">nano</span> <span class="o">~/.</span><span class="n">config</span><span class="o">/</span><span class="n">reticulum</span><span class="o">/</span><span class="n">config</span>
|
||||||
|
|
||||||
<span class="c1"># ... and launch the example again.</span>
|
<span class="c1"># ... and launch the example again.</span>
|
||||||
<span class="n">python3</span> <span class="n">Examples</span><span class="o">/</span><span class="n">Echo</span><span class="o">.</span><span class="n">py</span> <span class="o">-</span><span class="n">s</span>
|
<span class="n">python3</span> <span class="n">Examples</span><span class="o">/</span><span class="n">Echo</span><span class="o">.</span><span class="n">py</span> <span class="o">-</span><span class="n">s</span>
|
||||||
|
@ -139,7 +139,7 @@ communications channels as the underlying carrier for Reticulum.</p>
|
|||||||
<p>However, most real-world networks will probably involve either some form of
|
<p>However, most real-world networks will probably involve either some form of
|
||||||
wireless or direct hardline communications. To allow Reticulum to communicate
|
wireless or direct hardline communications. To allow Reticulum to communicate
|
||||||
over any type of medium, you must specify it in the configuration file, by default
|
over any type of medium, you must specify it in the configuration file, by default
|
||||||
located at <code class="docutils literal notranslate"><span class="pre">~/.reticulum/config</span></code>. See the <a class="reference internal" href="interfaces.html#interfaces-main"><span class="std std-ref">Supported Interfaces</span></a>
|
located at <code class="docutils literal notranslate"><span class="pre">~/.config/reticulum/config</span></code>. See the <a class="reference internal" href="interfaces.html#interfaces-main"><span class="std std-ref">Supported Interfaces</span></a>
|
||||||
chapter of this manual for interface configuration examples.</p>
|
chapter of this manual for interface configuration examples.</p>
|
||||||
<p>Any number of interfaces can be configured, and Reticulum will automatically
|
<p>Any number of interfaces can be configured, and Reticulum will automatically
|
||||||
decide which are suitable to use in any given situation, depending on where
|
decide which are suitable to use in any given situation, depending on where
|
||||||
|
@ -51,7 +51,7 @@
|
|||||||
<span id="api-reticulum"></span><h3>Reticulum<a class="headerlink" href="#reticulum" title="Permalink to this headline">¶</a></h3>
|
<span id="api-reticulum"></span><h3>Reticulum<a class="headerlink" href="#reticulum" title="Permalink to this headline">¶</a></h3>
|
||||||
<dl class="py class">
|
<dl class="py class">
|
||||||
<dt class="sig sig-object py" id="RNS.Reticulum">
|
<dt class="sig sig-object py" id="RNS.Reticulum">
|
||||||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">RNS.</span></span><span class="sig-name descname"><span class="pre">Reticulum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">configdir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loglevel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#RNS.Reticulum" title="Permalink to this definition">¶</a></dt>
|
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">RNS.</span></span><span class="sig-name descname"><span class="pre">Reticulum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">configdir</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loglevel</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logdest</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#RNS.Reticulum" title="Permalink to this definition">¶</a></dt>
|
||||||
<dd><p>This class is used to initialise access to Reticulum within a
|
<dd><p>This class is used to initialise access to Reticulum within a
|
||||||
program. You must create exactly one instance of this class before
|
program. You must create exactly one instance of this class before
|
||||||
carrying out any other RNS operations, such as creating destinations
|
carrying out any other RNS operations, such as creating destinations
|
||||||
|
File diff suppressed because one or more lines are too long
@ -59,7 +59,7 @@ are other options.</p>
|
|||||||
<div class="section" id="configuration-data">
|
<div class="section" id="configuration-data">
|
||||||
<h2>Configuration & Data<a class="headerlink" href="#configuration-data" title="Permalink to this headline">¶</a></h2>
|
<h2>Configuration & Data<a class="headerlink" href="#configuration-data" title="Permalink to this headline">¶</a></h2>
|
||||||
<p>A Reticulum stores all information that it needs to function in a single file-
|
<p>A Reticulum stores all information that it needs to function in a single file-
|
||||||
system directory. By default, this directory is <code class="docutils literal notranslate"><span class="pre">~/.reticulum</span></code>, but you can
|
system directory. By default, this directory is <code class="docutils literal notranslate"><span class="pre">~/.config/reticulum</span></code>, but you can
|
||||||
use any directory you wish. You can also run multiple separate Reticulum
|
use any directory you wish. You can also run multiple separate Reticulum
|
||||||
instances on the same physical system, in complete isolation from each other,
|
instances on the same physical system, in complete isolation from each other,
|
||||||
or connected together.</p>
|
or connected together.</p>
|
||||||
@ -68,7 +68,7 @@ instance. This can either be launched at boot, as a system service, or simply
|
|||||||
be brought up when a program needs it. In either case, any number of programs
|
be brought up when a program needs it. In either case, any number of programs
|
||||||
running on the same system will automatically share the same Reticulum instance,
|
running on the same system will automatically share the same Reticulum instance,
|
||||||
if the configuration allows for it, which it does by default.</p>
|
if the configuration allows for it, which it does by default.</p>
|
||||||
<p>The entire configuration of Reticulum is found in the <code class="docutils literal notranslate"><span class="pre">~/.reticulum/config</span></code>
|
<p>The entire configuration of Reticulum is found in the <code class="docutils literal notranslate"><span class="pre">~/.config/reticulum/config</span></code>
|
||||||
file. When Reticulum is first started on a new system, a basic, functional
|
file. When Reticulum is first started on a new system, a basic, functional
|
||||||
configuration file is created. The default configuration looks like this:</p>
|
configuration file is created. The default configuration looks like this:</p>
|
||||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># This is the default Reticulum config file.</span>
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># This is the default Reticulum config file.</span>
|
||||||
@ -374,7 +374,7 @@ rnx 7a55144adf826958a9529a3bcf08b149 "cat /proc/cpuinfo"
|
|||||||
rnx 7a55144adf826958a9529a3bcf08b149 -x
|
rnx 7a55144adf826958a9529a3bcf08b149 -x
|
||||||
|
|
||||||
# The default identity file is stored in
|
# The default identity file is stored in
|
||||||
# ~/.reticulum/identities/rnx, but you can use
|
# ~/.config/reticulum/identities/rnx, but you can use
|
||||||
# another one, which will be created if it does
|
# another one, which will be created if it does
|
||||||
# not already exist
|
# not already exist
|
||||||
rnx 7a55144adf826958a9529a3bcf08b149 -i /path/to/identity -x
|
rnx 7a55144adf826958a9529a3bcf08b149 -i /path/to/identity -x
|
||||||
|
@ -86,7 +86,7 @@ Creating a Network With Reticulum
|
|||||||
=============================================
|
=============================================
|
||||||
To create a network, you will need to specify one or more *interfaces* for
|
To create a network, you will need to specify one or more *interfaces* for
|
||||||
Reticulum to use. This is done in the Reticulum configuration file, which by
|
Reticulum to use. This is done in the Reticulum configuration file, which by
|
||||||
default is located at ``~/.reticulum/config``. You can edit this file by hand,
|
default is located at ``~/.config/reticulum/config``. You can edit this file by hand,
|
||||||
or use the interactive ``rnsconfig`` utility.
|
or use the interactive ``rnsconfig`` utility.
|
||||||
|
|
||||||
When Reticulum is started for the first time, it will create a default
|
When Reticulum is started for the first time, it will create a default
|
||||||
@ -261,7 +261,7 @@ don't use pip, but try this recipe:
|
|||||||
|
|
||||||
# Unless you've manually created a config file, Reticulum will do so now,
|
# Unless you've manually created a config file, Reticulum will do so now,
|
||||||
# and immediately exit. Make any necessary changes to the file:
|
# and immediately exit. Make any necessary changes to the file:
|
||||||
nano ~/.reticulum/config
|
nano ~/.config/reticulum/config
|
||||||
|
|
||||||
# ... and launch the example again.
|
# ... and launch the example again.
|
||||||
python3 Examples/Echo.py -s
|
python3 Examples/Echo.py -s
|
||||||
|
@ -82,7 +82,7 @@ communications channels as the underlying carrier for Reticulum.
|
|||||||
However, most real-world networks will probably involve either some form of
|
However, most real-world networks will probably involve either some form of
|
||||||
wireless or direct hardline communications. To allow Reticulum to communicate
|
wireless or direct hardline communications. To allow Reticulum to communicate
|
||||||
over any type of medium, you must specify it in the configuration file, by default
|
over any type of medium, you must specify it in the configuration file, by default
|
||||||
located at ``~/.reticulum/config``. See the :ref:`Supported Interfaces<interfaces-main>`
|
located at ``~/.config/reticulum/config``. See the :ref:`Supported Interfaces<interfaces-main>`
|
||||||
chapter of this manual for interface configuration examples.
|
chapter of this manual for interface configuration examples.
|
||||||
|
|
||||||
Any number of interfaces can be configured, and Reticulum will automatically
|
Any number of interfaces can be configured, and Reticulum will automatically
|
||||||
|
@ -23,7 +23,7 @@ Configuration & Data
|
|||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
A Reticulum stores all information that it needs to function in a single file-
|
A Reticulum stores all information that it needs to function in a single file-
|
||||||
system directory. By default, this directory is ``~/.reticulum``, but you can
|
system directory. By default, this directory is ``~/.config/reticulum``, but you can
|
||||||
use any directory you wish. You can also run multiple separate Reticulum
|
use any directory you wish. You can also run multiple separate Reticulum
|
||||||
instances on the same physical system, in complete isolation from each other,
|
instances on the same physical system, in complete isolation from each other,
|
||||||
or connected together.
|
or connected together.
|
||||||
@ -34,7 +34,7 @@ be brought up when a program needs it. In either case, any number of programs
|
|||||||
running on the same system will automatically share the same Reticulum instance,
|
running on the same system will automatically share the same Reticulum instance,
|
||||||
if the configuration allows for it, which it does by default.
|
if the configuration allows for it, which it does by default.
|
||||||
|
|
||||||
The entire configuration of Reticulum is found in the ``~/.reticulum/config``
|
The entire configuration of Reticulum is found in the ``~/.config/reticulum/config``
|
||||||
file. When Reticulum is first started on a new system, a basic, functional
|
file. When Reticulum is first started on a new system, a basic, functional
|
||||||
configuration file is created. The default configuration looks like this:
|
configuration file is created. The default configuration looks like this:
|
||||||
|
|
||||||
@ -371,7 +371,7 @@ output.
|
|||||||
rnx 7a55144adf826958a9529a3bcf08b149 -x
|
rnx 7a55144adf826958a9529a3bcf08b149 -x
|
||||||
|
|
||||||
# The default identity file is stored in
|
# The default identity file is stored in
|
||||||
# ~/.reticulum/identities/rnx, but you can use
|
# ~/.config/reticulum/identities/rnx, but you can use
|
||||||
# another one, which will be created if it does
|
# another one, which will be created if it does
|
||||||
# not already exist
|
# not already exist
|
||||||
rnx 7a55144adf826958a9529a3bcf08b149 -i /path/to/identity -x
|
rnx 7a55144adf826958a9529a3bcf08b149 -i /path/to/identity -x
|
||||||
|
Loading…
Reference in New Issue
Block a user