docs: Improving documentation for NLSR
Change-Id: Iada3c9bbc56b53fb66bfea1c99ef2204afaf9039
diff --git a/docs/GETTING-STARTED.rst b/docs/GETTING-STARTED.rst
index f2bd2d9..aa83b24 100644
--- a/docs/GETTING-STARTED.rst
+++ b/docs/GETTING-STARTED.rst
@@ -71,8 +71,18 @@
FATAL fatal (will be logged unconditionally)
To obtain logs for NLSR, set the NDN_LOG environment variable with the correct prefix and
-log-level settings. For example, running the command `export NDN_LOG=nlsr.*=TRACE && nlsr`
-will display all log messages in NLSR with a DEBUG level or below. If the user is presented
-with an error message `User does not have read and write permission on the directory` it can
-be circumvented by running the application with sudo: `sudo env NDN_LOG=nlsr.*=DEBUG nlsr`.
+log-level settings. For example, running the following command will display all log
+messages in NLSR with a DEBUG level or below.
+
+::
+
+ NDN_LOG='nlsr.*=DEBUG' nlsr
+
+If the user is presented with an error message `User does not have read and write
+permission on the directory` it can be circumvented by running the application with sudo:
+
+::
+
+ sudo env NDN_LOG='nlsr.*=DEBUG' nlsr
+
Use `man ndn-log` for more detailed instructions.
diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst
index d99a3b9..d567598 100644
--- a/docs/INSTALL.rst
+++ b/docs/INSTALL.rst
@@ -12,7 +12,10 @@
Refer to `Getting started with NFD <https://named-data.net/doc/NFD/current/INSTALL.html>`_
for detailed installation and running instruction.
-- ChronoSync library
+- ChronoSync library:
+
+Download the ChronoSync library and build it according to the instructions at the following
+address:
::
diff --git a/docs/ROUTER-CONFIG.rst b/docs/ROUTER-CONFIG.rst
index 277d7a3..ca8ee77 100644
--- a/docs/ROUTER-CONFIG.rst
+++ b/docs/ROUTER-CONFIG.rst
@@ -35,6 +35,9 @@
We will walk through setting up the faces and creating the configuration file for
``/ndn/edu/memphis/%C1.Router/router1``.
+It is recommended to configure security as described at :doc:`SECURITY-CONFIG`, before
+starting router configuration.
+
Step 1. Ensuring nfd is running
-------------------------------
@@ -48,6 +51,15 @@
``nfd`` is not running. Follow the instructions in `Getting started with NFD
<http://named-data.net/doc/NFD/current/INSTALL.html>`_ to run nfd.
+Since v0.4.0, NLSR no longer creates Faces for the neighbors that are
+specified in ``nlsr.conf``. Instead, it relies on the pre-existence of
+the Faces in NFD. NLSR will obtain this information from NFD, and
+configure its neighbors using this information.
+
+To create faces it is now necessary to use the ``nfdc`` command. Its documentation can
+be found `here
+<https://named-data.net/doc/NFD/current/manpages/nfdc.html>`_
+
Step 2. Determining FaceUri
---------------------------
diff --git a/docs/SECURITY-CONFIG.rst b/docs/SECURITY-CONFIG.rst
index 048ee15..b456d56 100644
--- a/docs/SECURITY-CONFIG.rst
+++ b/docs/SECURITY-CONFIG.rst
@@ -35,12 +35,15 @@
NLSR /\<network\>/\<site\>/%C1.Router/\<router-name\>/NLSR /ndn/edu/ucla/%C1.Router/rt1/NLSR /ndn/edu/ucla/%C1.Router/rt1/NLSR/KEY/5/%00/%01
======== ===================================================== ================================= ===============================================
-Users should create keys according to the naming and signing hierarchies above.
+Users should create keys according to the naming and signing hierarchies above. The
+``%C1.Operator`` and ``%C1.Router`` labels are NDN keywords that should not be modified
+by the user.
.. note::
- Detailed information about key setup is given in NLSR Developer's Guide.
+ Detailed information about key setup is given in NLSR Developer's Guide and the
+ :doc:`beginners-guide`.
Certificate Publishing
----------------------
diff --git a/docs/index.rst b/docs/index.rst
index f13d470..aa2102d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -31,8 +31,8 @@
GETTING-STARTED
INSTALL
- ROUTER-CONFIG
SECURITY-CONFIG
+ ROUTER-CONFIG
RELEASE-NOTES
releases
manpages
@@ -40,8 +40,8 @@
- :doc:`GETTING-STARTED`
- :doc:`INSTALL`
-- :doc:`ROUTER-CONFIG`
- :doc:`SECURITY-CONFIG`
+- :doc:`ROUTER-CONFIG`
- :doc:`RELEASE-NOTES`
- :doc:`releases`
- :doc:`manpages`