tools: Automatically start ndn-autoconfig in nfd-start, if enabled in autoconfig.conf
Change-Id: I09d3fff87f00ce8684e6e304e8327f9d03ca18bf
Refs: #2716
diff --git a/docs/conf.py b/docs/conf.py
index f50b01b..8fbda38 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -242,9 +242,11 @@
man_pages = [
('manpages/nfd', 'nfd', u'Named Data Networking Forwarding Daemon', None, 1),
('manpages/ndn-autoconfig-server', 'ndn-autoconfig-server',
- u'NFD Auto-configuration Server', None, 1),
+ u'NDN auto-configuration server', None, 1),
('manpages/ndn-autoconfig', 'ndn-autoconfig',
- u'NFD Auto-configuration Client', None, 1),
+ u'NDN auto-configuration client', None, 1),
+ ('manpages/ndn-autoconfig.conf', 'ndn-autoconfig.conf',
+ u'NDN auto-configuration client configuration file', None, 5),
('manpages/nfdc', 'nfdc',
u'NFD utility to manipulate the forwarding table (FIB)', None, 1),
('manpages/ndn-tlv-peek', 'ndn-tlv-peek', u'NFD consumer', None, 1),
diff --git a/docs/manpages.rst b/docs/manpages.rst
index f945bf1..d3d97a5 100644
--- a/docs/manpages.rst
+++ b/docs/manpages.rst
@@ -10,6 +10,7 @@
schema
manpages/nfd-status-http-server
manpages/ndn-autoconfig
+ manpages/ndn-autoconfig.conf
manpages/ndn-autoconfig-server
misc/local-prefix-discovery
manpages/nfd-autoreg
diff --git a/docs/manpages/ndn-autoconfig.conf.rst b/docs/manpages/ndn-autoconfig.conf.rst
new file mode 100644
index 0000000..c3fa015
--- /dev/null
+++ b/docs/manpages/ndn-autoconfig.conf.rst
@@ -0,0 +1,22 @@
+.. _ndn-autoconfig.conf:
+
+autoconfig.conf
+===============
+
+Overview
+--------
+
+Configuration of NDN auto-configuration client daemon in INI format. Comments in the
+configuration file must be prefixed with ``#``.
+
+Example of ``autoconfig.conf``:
+
+.. literalinclude:: ../../autoconfig.conf.sample
+
+Options
+-------
+
+``enabled``
+ (default: false) Enable or disable automatic NDN auto-configuration client daemon.
+
+ When enabled, NDN auto-configuration client daemon is automatically started by ``nfd-start``.
diff --git a/docs/manpages/ndn-autoconfig.rst b/docs/manpages/ndn-autoconfig.rst
index b436c61..f4fbc20 100644
--- a/docs/manpages/ndn-autoconfig.rst
+++ b/docs/manpages/ndn-autoconfig.rst
@@ -8,13 +8,33 @@
::
- ndn-autoconfig
+ ndn-autoconfig [options]
Description
-----------
Client tool to run :ref:`NDN hub discovery procedure`.
+Options
+-------
+
+``-h`` or ``--help``
+ Print usage information.
+
+``-d`` or ``--daemon``
+ Run ndn-autoconfig in daemon mode, detecting network change events and re-running
+ auto-discovery procedure. In addition, the auto-discovery procedure is unconditionally
+ re-run every hour.
+
+ NOTE: if connection to NFD fails, the daemon will be terminated.
+
+``-c [FILE]`` or ``--config=[FILE]``
+ Use the specified configuration file. If `enabled = true` is not specified in the
+ configuration file, no actions will be performed.
+
+``-V`` or ``--version``
+ Print version information.
+
.. _NDN hub discovery procedure:
NDN hub discovery procedure
@@ -40,8 +60,8 @@
After connecting to an NDN router, two prefixes will be automatically registered:
-- /ndn
-- /localhop/nfd --- this to inform RIB manager that there is connectivity to the hub
+- ``/ndn``
+- ``/localhop/nfd`` --- this to inform RIB manager that there is connectivity to the hub
Stage 1: multicast discovery
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -131,4 +151,4 @@
See also
--------
-:ref:`ndn-autoconfig-server`
+:ref:`ndn-autoconfig-server`, :doc:`ndn-autoconfig.conf`