tools: Add nlsrc command line tool
refs: #1834
Change-Id: Ifbe75a3f49e2689930e61ebfd348d9932b04c975
diff --git a/docs/conf.py b/docs/conf.py
index 83e251b..7314c6d 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -59,7 +59,7 @@
# General information about the project.
project = u'NLSR - Named Data Link State Routing Protocol'
-copyright = u'2014, Named Data Networking Project'
+copyright = u'2014-2015, Named Data Networking Project'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -239,6 +239,7 @@
man_pages = [
('manpages/nlsr', 'nlsr', u'Named Data Link State Routing Protocol Daemon', None, 1),
('manpages/nlsr.conf', 'nlsr.conf', u'Named Data Link State Routing Protocol Daemon config file', None, 5),
+ ('manpages/nlsrc', 'nlsrc', u'Command-line utility to interact with and collect statistics from NLSR', None, 1),
]
diff --git a/docs/manpages.rst b/docs/manpages.rst
index 40bd0de..e2e1582 100644
--- a/docs/manpages.rst
+++ b/docs/manpages.rst
@@ -6,4 +6,5 @@
.. toctree::
manpages/nlsr
manpages/nlsr.conf
+ manpages/nlsrc
:maxdepth: 1
diff --git a/docs/manpages/nlsrc.rst b/docs/manpages/nlsrc.rst
new file mode 100644
index 0000000..1db6cf3
--- /dev/null
+++ b/docs/manpages/nlsrc.rst
@@ -0,0 +1,55 @@
+nlsrc
+=====
+
+Usage
+-----
+
+::
+
+ nlsrc [-h] [-V] COMMAND [<Command Options>]
+
+
+Description
+-----------
+
+``nlsrc`` is a tool to retrieve link-state database (LSDB) status information from NLSR and
+announce/withdraw Name prefixes advertised by NLSR.
+
+Options
+-------
+
+``-h``
+ Print usage information
+
+``-V``
+ Show NLSRC version information
+
+``COMMAND``
+
+ ``status``
+ Retrieve LSDB status information
+
+ ``advertise``
+ Add a Name prefix to be advertised by NLSR
+
+ ``advertise <name>``
+
+ ``name``
+ The Name prefix to be advertised
+
+ ``withdraw``
+ Remove a Name prefix advertised through NLSR
+
+ ``withdraw <name>``
+
+ ``name``
+ The Name prefix to be withdrawn
+
+Exit Status
+-----------
+
+nlsrc exits with one of the following values:
+::
+
+ 0 nlsrc exited successfully
+ >0 An error occurred