dissect: add README and manpage

refs #2931

Change-Id: Ia0418fbf50725f004ceb09bcff9a55fb6136a70c
This commit is contained in:
Junxiao Shi committed 2015-06-26 14:09:02 -07:00
1 parent 78c78cc91a
commit b2ff573fc4
3 files changed
+52

No files matched your search

+1
View File
@@ -10,4 +10,5 @@ man_pages = [
('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),
]
+38
View File
@@ -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
+13
View File
@@ -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.