docs: Adding manpages for the command-line tools
Change-Id: I3eba0d125f7da51696342edce1a2f1ee33a0471a
refs: #1446
diff --git a/docs/manpages/ndn-autoconfig.rst b/docs/manpages/ndn-autoconfig.rst
index 07233a5..8e56435 100644
--- a/docs/manpages/ndn-autoconfig.rst
+++ b/docs/manpages/ndn-autoconfig.rst
@@ -1,18 +1,28 @@
+.. _ndn-autoconfig:
+
ndn-autoconfig
==============
-Synopsis
---------
+Usage
+-----
::
ndn-autoconfig
+Description
+-----------
+
+Client tool to run :ref:`NDN hub discovery procedure`.
+
+.. _NDN hub discovery procedure:
NDN hub discovery procedure
---------------------------
-When an end host starts up, or detects a change in its network environment, it MAY use this procedure to discover a local or home NDN router, in order to gain connectivity to `the NDN research testbed <http://named-data.net/ndn-testbed/>`_.
+When an end host starts up, or detects a change in its network environment, it MAY use
+this procedure to discover a local or home NDN router, in order to gain connectivity to
+`the NDN research testbed <http://named-data.net/ndn-testbed/>`_.
Overview
^^^^^^^^
@@ -23,7 +33,7 @@
This is useful in a home or small office network.
2. Look for a local NDN router by DNS query with default suffix.
- This allows network administrator to configure a NDN router for a large enterprise network.
+ This allows network administrator to configure a NDN router in a large enterprise network.
3. Connect to the home NDN router according to user certificate.
This ensures connectivity from anywhere.
@@ -41,8 +51,9 @@
Response
++++++++
-A producer app on the HUB answer this Interest with a Data packet that contains a TLV-encoded `Uri` block.
-The value of this block is the URI for the HUB, preferrably a UDP tunnel.
+A producer app on the HUB answer this Interest with a Data packet that contains a
+TLV-encoded `Uri` block. The value of this block is the URI for the HUB, preferrably a
+UDP tunnel.
Stage 2: DNS query with default suffix
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -57,26 +68,32 @@
Response
++++++++
-The DNS server should answer with an SRV record that contains the hostname and UDP port number of the NDN router.
+The DNS server should answer with an SRV record that contains the hostname and UDP port
+number of the NDN router.
Stage 3: find home router
^^^^^^^^^^^^^^^^^^^^^^^^^
-This stage assumes that user has configured default certificate using `<http://ndncert.named-data.net/>`_ as described in `Certification Architecture <http://redmine.named-data.net/attachments/download/23/CertificationArchitecture.pptx>`_.
+This stage assumes that user has configured default certificate using
+`<http://ndncert.named-data.net/>`_ as described in `Certification Architecture
+<http://redmine.named-data.net/attachments/download/23/CertificationArchitecture.pptx>`_.
Request
+++++++
-The end host loads the default user identity (eg. ``/ndn/edu/ucla/cs/afanasev``), and converts it to DNS format.
+The end host loads the default user identity (eg. ``/ndn/edu/ucla/cs/afanasev``), and
+converts it to DNS format.
-The end host sends a DNS query for an SRV record of name ``_ndn._udp.`` + user identity in DNS format + ``_homehub._autoconf.named-data.net``. For example::
+The end host sends a DNS query for an SRV record of name ``_ndn._udp.`` + user identity in
+DNS format + ``_homehub._autoconf.named-data.net``. For example::
_ndn._udp.afanasev.cs.ucla.edu.ndn._homehub._autoconf.named-data.net
Response
++++++++
-The DNS server should answer with an SRV record that contains the hostname and UDP port number of the home NDN router of this user's site.
+The DNS server should answer with an SRV record that contains the hostname and UDP port
+number of the home NDN router of this user's site.
Client procedure
----------------
@@ -98,7 +115,15 @@
Stage 3
^^^^^^^
-* Load default user identity, and convert it to DNS format; if either fails, the auto-discovery fails.
+* Load default user identity, and convert it to DNS format; if either fails, the
+ auto-discovery fails.
* Send a DNS query to find home HUB.
- If this query is answered, connect to the home HUB and terminate auto-discovery. Otherwise, the auto-discovery fails.
+ If this query is answered, connect to the home HUB and terminate auto-discovery.
+ Otherwise, the auto-discovery fails.
+
+
+See also
+--------
+
+:ref:`ndn-autoconfig-server`