Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-tools / 6a1396e2e0fae85168593827795f8118c4ede029 / . / manpages / ndnpeek.rst
blob: 0b6683e98cfc2a06e8a5fa5fd6f595cfce99c888 [file] [log] [blame]
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]1ndnpeek
2=======
3
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]4Synopsis
5--------
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]6
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]7**ndnpeek** [-h] [-P] [-f] [-l *lifetime*] [-p] [-w *timeout*] [-v] [-V] *name*
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]8
9Description
10-----------
11
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]12:program:`ndnpeek` is a simple consumer program that sends one Interest and
13expects one Data packet in response. By default, the full Data packet (in TLV
14format) is written to the standard output.
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]15
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]16*name* is interpreted as the Interest name.
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]17
18Options
19-------
20
Teng Liangd4ab87f2016-03-08 18:50:47 -0700[diff] [blame]21``-h, --help``
22 Print help and exit.
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]23
Junxiao Shib54aabd2018-04-16 19:36:24 +0000[diff] [blame]24``-P, --prefix``
25 If specified, include ``CanBePrefix`` element in the Interest packet.
26
Teng Liangd4ab87f2016-03-08 18:50:47 -0700[diff] [blame]27``-f, --fresh``
Junxiao Shib54aabd2018-04-16 19:36:24 +0000[diff] [blame]28 If specified, include ``MustBeFresh`` element in the Interest packet.
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]29
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]30``--link-file <file>``
Junxiao Shib54aabd2018-04-16 19:36:24 +0000[diff] [blame]31 Read Link object from ``file`` and add it as ``ForwardingHint`` to the Interest packet.
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]32
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]33``-l, --lifetime <lifetime>``
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]34 Set ``lifetime`` (in milliseconds) as the ``InterestLifetime``.
35
Teng Liangd4ab87f2016-03-08 18:50:47 -0700[diff] [blame]36``-p, --payload``
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]37 If specified, print the received payload only, not the full packet.
38
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]39``-w, --timeout <timeout>``
40 Quit the program after ``timeout`` milliseconds, even if no reply has been received.
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]41
Teng Liangd4ab87f2016-03-08 18:50:47 -0700[diff] [blame]42``-v, --verbose``
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]43 Turn on verbose output.
Teng Liangd4ab87f2016-03-08 18:50:47 -0700[diff] [blame]44
45``-V, --version``
46 Print version and exit.
47
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]48Exit Status
49-----------
Teng Liangd4ab87f2016-03-08 18:50:47 -0700[diff] [blame]50
510: Success
52
531: An unspecified error occurred
54
552: Malformed command line
56
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]573: Operation timed out
Teng Liangd4ab87f2016-03-08 18:50:47 -0700[diff] [blame]58
594: Nack received
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]60
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]61Example
62-------
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]63
Davide Pesavento65d11552019-06-09 19:15:50 -0400[diff] [blame]64Send Interest for ``/app1/video`` and print the received payload only::
Junxiao Shi2219a052015-05-28 02:53:48 -0700[diff] [blame]65
Davide Pesaventoe75861e2019-07-24 21:55:39 -0400[diff] [blame]66 ndnpeek -p /app1/video