diff --git a/docs/Reticulum Manual.pdf b/docs/Reticulum Manual.pdf index 5b7009a..9bdb6ef 100644 Binary files a/docs/Reticulum Manual.pdf and b/docs/Reticulum Manual.pdf differ diff --git a/docs/manual/_sources/interfaces.rst.txt b/docs/manual/_sources/interfaces.rst.txt index 7931c5a..60ee150 100644 --- a/docs/manual/_sources/interfaces.rst.txt +++ b/docs/manual/_sources/interfaces.rst.txt @@ -94,12 +94,12 @@ inbound traffic. Using the I2P interface, you will get a globally reachable, portable and persistent I2P address that your Reticulum instance can be reached -at. The I2P +at. To use the I2P interface, you must have an I2P router running on your system. The easiest way to acheive this is to download and install the `latest release `_ -of the ``ì2pd```package. For more details about I2P, see the +of the ``ì2pd`` package. For more details about I2P, see the `geti2p.net website `_.` When an I2P router is running on your system, you can simply add @@ -119,7 +119,7 @@ you should see I2P base32 address printed to your log file. You can also inspect the status of the interface using the ``rnstatus`` utility. To connect to other Reticulum instances over I2P, just add a comma-separated -list of I2P base32 addresses to the ``peers```option of the interface: +list of I2P base32 addresses to the ``peers`` option of the interface: .. code:: @@ -520,6 +520,11 @@ Common Interface Options A number of general options can be used to control various aspects of interface behaviour. +The ``interface_enabled`` option tells Reticulum whether or not +to bring up the interface. Defaults to ``False``. For any +interface to be brought up, the ``interface_enabled`` option +must be set to ``True`` or ``Yes``. + The ``outgoing`` option sets whether an interface is allowed to transmit. Defaults to ``True``. If set to ``False`` the interface will only receive data, and never transmit. @@ -540,8 +545,3 @@ behaviour of the interface from a number of options. be a radio interface serving a wide area, where users are expected to connect momentarily, use the network, and then disappear again. - -The ``interface_enabled`` option tells Reticulum whether or not -to bring up the interface. Defaults to ``False``. For any -interface to be brought up, the ``interface_enabled`` option -must be set to ``True`` or ``Yes``. diff --git a/docs/manual/interfaces.html b/docs/manual/interfaces.html index a7c0dc9..eb7acce 100644 --- a/docs/manual/interfaces.html +++ b/docs/manual/interfaces.html @@ -117,11 +117,11 @@ have a frequently changing IP address, or have firewalls blocking inbound traffic.

Using the I2P interface, you will get a globally reachable, portable and persistent I2P address that your Reticulum instance can be reached -at. The I2P

+at.

To use the I2P interface, you must have an I2P router running on your system. The easiest way to acheive this is to download and install the latest release -of the ``ì2pd```package. For more details about I2P, see the +of the ì2pd package. For more details about I2P, see the geti2p.net website.`

When an I2P router is running on your system, you can simply add an I2P interface to reticulum:

@@ -137,7 +137,7 @@ started, and is not yet well-connected to the I2P network. When ready, you should see I2P base32 address printed to your log file. You can also inspect the status of the interface using the rnstatus utility.

To connect to other Reticulum instances over I2P, just add a comma-separated -list of I2P base32 addresses to the ``peers```option of the interface:

+list of I2P base32 addresses to the peers option of the interface:

[[I2P]]
   type = I2PInterface
   interface_enabled = yes
@@ -487,6 +487,10 @@ beaconing functionality described above.

 
Common Interface Options

 
A number of general options can be used to control various
 aspects of interface behaviour.

+
The interface_enabled option tells Reticulum whether or not
+to bring up the interface. Defaults to False. For any
+interface to be brought up, the interface_enabled option
+must be set to True or Yes.

 
The outgoing option sets whether an interface is allowed
 to transmit. Defaults to True. If set to False the
 interface will only receive data, and never transmit.

@@ -508,10 +512,6 @@ expected to connect momentarily, use the network, and then
 disappear again.
-

The interface_enabled option tells Reticulum whether or not -to bring up the interface. Defaults to False. For any -interface to be brought up, the interface_enabled option -must be set to True or Yes.

diff --git a/docs/source/interfaces.rst b/docs/source/interfaces.rst index 7931c5a..60ee150 100644 --- a/docs/source/interfaces.rst +++ b/docs/source/interfaces.rst @@ -94,12 +94,12 @@ inbound traffic. Using the I2P interface, you will get a globally reachable, portable and persistent I2P address that your Reticulum instance can be reached -at. The I2P +at. To use the I2P interface, you must have an I2P router running on your system. The easiest way to acheive this is to download and install the `latest release `_ -of the ``ì2pd```package. For more details about I2P, see the +of the ``ì2pd`` package. For more details about I2P, see the `geti2p.net website `_.` When an I2P router is running on your system, you can simply add @@ -119,7 +119,7 @@ you should see I2P base32 address printed to your log file. You can also inspect the status of the interface using the ``rnstatus`` utility. To connect to other Reticulum instances over I2P, just add a comma-separated -list of I2P base32 addresses to the ``peers```option of the interface: +list of I2P base32 addresses to the ``peers`` option of the interface: .. code:: @@ -520,6 +520,11 @@ Common Interface Options A number of general options can be used to control various aspects of interface behaviour. +The ``interface_enabled`` option tells Reticulum whether or not +to bring up the interface. Defaults to ``False``. For any +interface to be brought up, the ``interface_enabled`` option +must be set to ``True`` or ``Yes``. + The ``outgoing`` option sets whether an interface is allowed to transmit. Defaults to ``True``. If set to ``False`` the interface will only receive data, and never transmit. @@ -540,8 +545,3 @@ behaviour of the interface from a number of options. be a radio interface serving a wide area, where users are expected to connect momentarily, use the network, and then disappear again. - -The ``interface_enabled`` option tells Reticulum whether or not -to bring up the interface. Defaults to ``False``. For any -interface to be brought up, the ``interface_enabled`` option -must be set to ``True`` or ``Yes``.