blob: 1f36263b3ed3fba561113b2881d6336fed52e435 [file] [log] [blame]
Junxiao Shi2219a052015-05-28 02:53:48 -07001ndnpeek
2=======
3
4Usage
5-----
6
7::
8
9 ndnpeek [-h] [-f] [-r] [-m min] [-M max] [-l lifetime] [-p] [-w timeout] name
10
11Description
12-----------
13
14``ndnpeek`` is a simple consumer program that sends one Interest and expects one Data
15packet in response. The full Data packet (in TLV format) is written to stdout. The
16program terminates with return code 0 if Data arrives, and with return code 1 when timeout
17occurs.
18
19``name`` is interpreted as the Interest name.
20
21Options
22-------
23
24``-h``
25 Print help and exit
26
27``-f``
28 If specified, set ``MustBeFresh`` selector in the Interest packet.
29
30``-r``
31 Set ``ChildSelector=1`` (the rightmost child) selector.
32
33``-m``
34 Set ``min`` as the ``MinSuffixComponents`` selector.
35
36``-M``
37 Set ``max`` as the ``MaxSuffixComponents`` selector.
38
39``-l``
40 Set ``lifetime`` (in milliseconds) as the ``InterestLifetime``.
41
42``-p``
43 If specified, print the received payload only, not the full packet.
44
45``-w``
46 Timeout after ``timeout`` milliseconds.
47
48
49Examples
50--------
51
52Send Interest for ``ndn:/app1/video`` and print the received payload only
53
54::
55
56 ndnpeek -p ndn:/app1/video