Improved configuration info in docs

docs/manual/_sources/gettingstartedfast.rst.txt

@@ -86,7 +86,7 @@ Creating a Network With Reticulum
 =============================================
 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
-default is located at ``~/.config/reticulum/config``. You can edit this file by hand,
+default is located at ``~/.reticulum/config``. You can edit this file by hand,
 or use the interactive ``rnsconfig`` utility. 
 
 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,
     # and immediately exit. Make any necessary changes to the file:
-    nano ~/.config/reticulum/config
+    nano ~/.reticulum/config
 
     # ... and launch the example again.
     python3 Examples/Echo.py -s

docs/manual/_sources/networks.rst.txt

@@ -82,7 +82,7 @@ communications channels as the underlying carrier for Reticulum.
 However, most real-world networks will probably involve either some form of
 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
-located at ``~/.config/reticulum/config``. See the :ref:`Supported Interfaces<interfaces-main>`
+located at ``~/.reticulum/config``. See the :ref:`Supported Interfaces<interfaces-main>`
 chapter of this manual for interface configuration examples.
 
 Any number of interfaces can be configured, and Reticulum will automatically

docs/manual/_sources/using.rst.txt

@@ -7,9 +7,11 @@ Using Reticulum on Your System
 Reticulum is not installed as a driver or kernel module, as one might expect
 of a networking stack. Instead, Reticulum is distributed as a Python module.
 This means that no special privileges are required to install or use it. It
-is also very light-weight, and easy to transfer to and install on new systems.
-Any program or application that uses Reticulum will automatically load and
-initialise Reticulum when it starts.
+is also very light-weight, and easy to transfer to, and install on new systems.
+
+When you have Reticulum installed, any program or application that uses Reticulum
+will automatically load and initialise Reticulum when it starts, if it is not
+already running.
 
 In many cases, this approach is sufficient. When any program needs to use
 Reticulum, it is loaded, initialised, interfaces are brought up, and the
@@ -22,11 +24,22 @@ are other options.
 Configuration & Data
 --------------------
 
-A Reticulum stores all information that it needs to function in a single file-
-system directory. By default, this directory is ``~/.config/reticulum``, but you can
-use any directory you wish. You can also run multiple separate Reticulum
-instances on the same physical system, in complete isolation from each other,
-or connected together.
+Reticulum stores all information that it needs to function in a single file-system
+directory. When Reticulum is started, it will look for a valid configuration
+directory in the following places:
+
+- ``/etc/reticulum``
+- ``~/.config/reticulum``
+- ``~/.reticulum``
+
+If no existing configuration directory is found, the directory ``~/.reticulum``
+is created, and the default configuration will be automatically created here.
+You can move it to one of the other locations if you wish.
+
+It is also possible to use completely arbitrary configuration directories by
+specifying the relevant command-line parameters when running Reticulum-based
+programs. You can also run multiple separate Reticulum instances on the same
+physical system, either in isolation from each other, or connected together.
 
 In most cases, a single physical system will only need to run one Reticulum
 instance. This can either be launched at boot, as a system service, or simply
@@ -34,8 +47,8 @@ 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,
 if the configuration allows for it, which it does by default.
 
-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
+The entire configuration of Reticulum is found in the ``~/.reticulum/config``
+file. When Reticulum is first started on a new system, a basic, but fully functional
 configuration file is created. The default configuration looks like this:
 
 .. code::
@@ -371,7 +384,7 @@ output.
   rnx 7a55144adf826958a9529a3bcf08b149 -x
 
   # The default identity file is stored in
-  # ~/.config/reticulum/identities/rnx, but you can use
+  # ~/.reticulum/identities/rnx, but you can use
   # another one, which will be created if it does
   # not already exist
   rnx 7a55144adf826958a9529a3bcf08b149 -i /path/to/identity -x

docs/manual/gettingstartedfast.html

@@ -287,7 +287,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 heading">#</a></h2>
 <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
-default is located at <code class="docutils literal notranslate"><span class="pre">~/.config/reticulum/config</span></code>. You can edit this file by hand,
+default is located at <code class="docutils literal notranslate"><span class="pre">~/.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>
 <p>When Reticulum is started for the first time, it will create a default
 configuration file, with one active interface. This default interface uses
@@ -432,7 +432,7 @@ don’t use pip, but try this recipe:</p>
 
 <span class="c1"># Unless you&#39;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="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="n">nano</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="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>

docs/manual/networks.html

@@ -319,7 +319,7 @@ communications channels as the underlying carrier for Reticulum.</p>
 <p>However, most real-world networks will probably involve either some form of
 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
-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>
+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>
 chapter of this manual for interface configuration examples.</p>
 <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

docs/manual/using.html

@@ -226,9 +226,10 @@
 <p>Reticulum is not installed as a driver or kernel module, as one might expect
 of a networking stack. Instead, Reticulum is distributed as a Python module.
 This means that no special privileges are required to install or use it. It
-is also very light-weight, and easy to transfer to and install on new systems.
-Any program or application that uses Reticulum will automatically load and
-initialise Reticulum when it starts.</p>
+is also very light-weight, and easy to transfer to, and install on new systems.</p>
+<p>When you have Reticulum installed, any program or application that uses Reticulum
+will automatically load and initialise Reticulum when it starts, if it is not
+already running.</p>
 <p>In many cases, this approach is sufficient. When any program needs to use
 Reticulum, it is loaded, initialised, interfaces are brought up, and the
 program can now communicate over any Reticulum networks available. If another
@@ -238,18 +239,28 @@ concurrently, and is very easy to use, but depending on your use case, there
 are other options.</p>
 <section id="configuration-data">
 <h2>Configuration &amp; Data<a class="headerlink" href="#configuration-data" title="Permalink to this heading">#</a></h2>
-<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">~/.config/reticulum</span></code>, but you can
-use any directory you wish. You can also run multiple separate Reticulum
-instances on the same physical system, in complete isolation from each other,
-or connected together.</p>
+<p>Reticulum stores all information that it needs to function in a single file-system
+directory. When Reticulum is started, it will look for a valid configuration
+directory in the following places:</p>
+<ul class="simple">
+<li><p><code class="docutils literal notranslate"><span class="pre">/etc/reticulum</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">~/.config/reticulum</span></code></p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">~/.reticulum</span></code></p></li>
+</ul>
+<p>If no existing configuration directory is found, the directory <code class="docutils literal notranslate"><span class="pre">~/.reticulum</span></code>
+is created, and the default configuration will be automatically created here.
+You can move it to one of the other locations if you wish.</p>
+<p>It is also possible to use completely arbitrary configuration directories by
+specifying the relevant command-line parameters when running Reticulum-based
+programs. You can also run multiple separate Reticulum instances on the same
+physical system, either in isolation from each other, or connected together.</p>
 <p>In most cases, a single physical system will only need to run one Reticulum
 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
 running on the same system will automatically share the same Reticulum instance,
 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">~/.config/reticulum/config</span></code>
-file. When Reticulum is first started on a new system, a basic, functional
+<p>The entire configuration of Reticulum is found in the <code class="docutils literal notranslate"><span class="pre">~/.reticulum/config</span></code>
+file. When Reticulum is first started on a new system, a basic, but fully functional
 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>
 <span class="c1"># You should probably edit it to include any additional,</span>
@@ -554,7 +565,7 @@ rnx 7a55144adf826958a9529a3bcf08b149 &quot;cat /proc/cpuinfo&quot;
 rnx 7a55144adf826958a9529a3bcf08b149 -x
 
 # The default identity file is stored in
-# ~/.config/reticulum/identities/rnx, but you can use
+# ~/.reticulum/identities/rnx, but you can use
 # another one, which will be created if it does
 # not already exist
 rnx 7a55144adf826958a9529a3bcf08b149 -i /path/to/identity -x

docs/source/gettingstartedfast.rst

@@ -86,7 +86,7 @@ Creating a Network With Reticulum
 =============================================
 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
-default is located at ``~/.config/reticulum/config``. You can edit this file by hand,
+default is located at ``~/.reticulum/config``. You can edit this file by hand,
 or use the interactive ``rnsconfig`` utility. 
 
 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,
     # and immediately exit. Make any necessary changes to the file:
-    nano ~/.config/reticulum/config
+    nano ~/.reticulum/config
 
     # ... and launch the example again.
     python3 Examples/Echo.py -s

docs/source/networks.rst

@@ -82,7 +82,7 @@ communications channels as the underlying carrier for Reticulum.
 However, most real-world networks will probably involve either some form of
 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
-located at ``~/.config/reticulum/config``. See the :ref:`Supported Interfaces<interfaces-main>`
+located at ``~/.reticulum/config``. See the :ref:`Supported Interfaces<interfaces-main>`
 chapter of this manual for interface configuration examples.
 
 Any number of interfaces can be configured, and Reticulum will automatically

docs/source/using.rst

@@ -7,9 +7,11 @@ Using Reticulum on Your System
 Reticulum is not installed as a driver or kernel module, as one might expect
 of a networking stack. Instead, Reticulum is distributed as a Python module.
 This means that no special privileges are required to install or use it. It
-is also very light-weight, and easy to transfer to and install on new systems.
-Any program or application that uses Reticulum will automatically load and
-initialise Reticulum when it starts.
+is also very light-weight, and easy to transfer to, and install on new systems.
+
+When you have Reticulum installed, any program or application that uses Reticulum
+will automatically load and initialise Reticulum when it starts, if it is not
+already running.
 
 In many cases, this approach is sufficient. When any program needs to use
 Reticulum, it is loaded, initialised, interfaces are brought up, and the
@@ -22,11 +24,22 @@ are other options.
 Configuration & Data
 --------------------
 
-A Reticulum stores all information that it needs to function in a single file-
-system directory. By default, this directory is ``~/.config/reticulum``, but you can
-use any directory you wish. You can also run multiple separate Reticulum
-instances on the same physical system, in complete isolation from each other,
-or connected together.
+Reticulum stores all information that it needs to function in a single file-system
+directory. When Reticulum is started, it will look for a valid configuration
+directory in the following places:
+
+- ``/etc/reticulum``
+- ``~/.config/reticulum``
+- ``~/.reticulum``
+
+If no existing configuration directory is found, the directory ``~/.reticulum``
+is created, and the default configuration will be automatically created here.
+You can move it to one of the other locations if you wish.
+
+It is also possible to use completely arbitrary configuration directories by
+specifying the relevant command-line parameters when running Reticulum-based
+programs. You can also run multiple separate Reticulum instances on the same
+physical system, either in isolation from each other, or connected together.
 
 In most cases, a single physical system will only need to run one Reticulum
 instance. This can either be launched at boot, as a system service, or simply
@@ -34,8 +47,8 @@ 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,
 if the configuration allows for it, which it does by default.
 
-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
+The entire configuration of Reticulum is found in the ``~/.reticulum/config``
+file. When Reticulum is first started on a new system, a basic, but fully functional
 configuration file is created. The default configuration looks like this:
 
 .. code::
@@ -371,7 +384,7 @@ output.
   rnx 7a55144adf826958a9529a3bcf08b149 -x
 
   # The default identity file is stored in
-  # ~/.config/reticulum/identities/rnx, but you can use
+  # ~/.reticulum/identities/rnx, but you can use
   # another one, which will be created if it does
   # not already exist
   rnx 7a55144adf826958a9529a3bcf08b149 -i /path/to/identity -x