dissect: add README and manpage
refs #2931
Change-Id: Ia0418fbf50725f004ceb09bcff9a55fb6136a70c
diff --git a/manpages/conf.py b/manpages/conf.py
index ea32680..9e67aa5 100644
--- a/manpages/conf.py
+++ b/manpages/conf.py
@@ -10,4 +10,5 @@
('ndnpoke', 'ndnpoke', 'simple producer to publish one Data', None, 1),
('ndnping', 'ndnping', 'reachability testing client', None, 1),
('ndnpingserver', 'ndnpingserver', 'reachability testing server', None, 1),
+ ('ndn-dissect', 'ndn-dissect', 'NDN packet format inspector', None, 1),
]
diff --git a/manpages/ndn-dissect.rst b/manpages/ndn-dissect.rst
new file mode 100644
index 0000000..be92682
--- /dev/null
+++ b/manpages/ndn-dissect.rst
@@ -0,0 +1,38 @@
+ndn-dissect
+===========
+
+Usage
+-----
+
+::
+
+ ndn-dissect [-hV] [input-file]
+
+Description
+-----------
+
+``ndn-dissect`` is an NDN packet format inspector.
+It reads zero or more NDN packets from either an input file or the standard input,
+and displays the Type-Length-Value (TLV) structure of those packets on the standard output.
+
+Options
+-------
+
+``-h``
+ Print help and exit.
+
+``-V``
+ Print version and exit.
+
+``input-file``
+ The file to read packets from.
+ If no :option:`input-file` is given, the standard input is used.
+
+Examples
+--------
+
+Inspect the response to Interest ``ndn:/app1/video``
+
+::
+
+ ndnpeek ndn:/app1/video | ndn-dissect
diff --git a/tools/dissect/README.md b/tools/dissect/README.md
new file mode 100644
index 0000000..b0da01a
--- /dev/null
+++ b/tools/dissect/README.md
@@ -0,0 +1,13 @@
+# ndn-dissect
+
+**ndn-dissect** is an NDN packet format inspector.
+It reads zero or more NDN packets from either an input file or the standard input,
+and displays the Type-Length-Value (TLV) structure of those packets on the standard output.
+
+Usage example:
+
+1. start NFD on local machine
+2. execute `echo 'HELLO WORLD' | ndnpoke ndn:/localhost/demo/hello`
+3. on another console, execute `ndnpeek ndn:/localhost/demo/hello | ndn-dissect`
+
+For more information, consult the manpage.