blob: 856d4768b700ca50fb286898b7c8dd369965bef6 [file] [log] [blame]
Davide Pesavento9907cc12025-04-20 23:30:06 -04001ndndissect
2==========
Junxiao Shib2ff5732015-06-26 14:09:02 -07003
Davide Pesaventoa420e972021-02-25 00:56:25 -05004Synopsis
5--------
Junxiao Shib2ff5732015-06-26 14:09:02 -07006
Davide Pesavento9907cc12025-04-20 23:30:06 -04007**ndndissect** [**-h**] [**-c**] [**-V**] [*file*]
Junxiao Shib2ff5732015-06-26 14:09:02 -07008
9Description
10-----------
11
Davide Pesavento9907cc12025-04-20 23:30:06 -040012:program:`ndndissect` is an NDN packet format inspector.
Davide Pesaventoa420e972021-02-25 00:56:25 -050013It reads zero or more NDN packets from either an input file or the standard
14input, and displays the Type-Length-Value (TLV) structure of those packets
15on the standard output.
Junxiao Shib2ff5732015-06-26 14:09:02 -070016
17Options
18-------
19
Davide Pesaventoa420e972021-02-25 00:56:25 -050020.. option:: -h, --help
Alexander Afanasyev20c85cb2018-03-09 17:50:14 -050021
Davide Pesaventoa420e972021-02-25 00:56:25 -050022 Print help and exit.
Junxiao Shib2ff5732015-06-26 14:09:02 -070023
Davide Pesaventoa420e972021-02-25 00:56:25 -050024.. option:: -c, --content
Alexander Afanasyev20c85cb2018-03-09 17:50:14 -050025
Davide Pesaventoa420e972021-02-25 00:56:25 -050026 Dissect the value of Content elements as well. By default, the value of a
27 Content element is treated as an opaque blob and is not dissected further.
Junxiao Shib2ff5732015-06-26 14:09:02 -070028
Davide Pesaventoa420e972021-02-25 00:56:25 -050029.. option:: -V, --version
Alexander Afanasyev20c85cb2018-03-09 17:50:14 -050030
Davide Pesaventoa420e972021-02-25 00:56:25 -050031 Print program version and exit.
32
33.. option:: file
34
35 The file to read packets from.
36 If no *file* is given, or if *file* is "-", the standard input is used.
Junxiao Shib2ff5732015-06-26 14:09:02 -070037
38Examples
39--------
40
Davide Pesaventoa420e972021-02-25 00:56:25 -050041Inspect the response to Interest ``/app1/video``::
Junxiao Shib2ff5732015-06-26 14:09:02 -070042
Davide Pesavento9907cc12025-04-20 23:30:06 -040043 ndnpeek /app1/video | ndndissect