blob: 7d32d0e31128a6bcff178a434cc3b0a79af25617 [file] [log] [blame]
Junxiao Shi6c135622016-11-21 14:30:33 +00001nfdc-strategy
2=============
3
4SYNOPSIS
5--------
6| nfdc strategy [list]
Junxiao Shi5d3e4812017-04-05 16:52:59 +00007| nfdc strategy show [prefix] <PREFIX>
Junxiao Shif0dfb332017-02-02 05:32:25 +00008| nfdc set-strategy <PREFIX> <STRATEGY>
9| nfdc unset-strategy <PREFIX>
Junxiao Shi6c135622016-11-21 14:30:33 +000010
11DESCRIPTION
12-----------
13In NFD, packet forwarding behavior is determined by forwarding pipelines and forwarding strategies.
14The forwarding pipelines define general steps of packet processing.
15Forwarding strategies provide the intelligence to make decision on whether, when, and where
16to forward Interests.
17
18NFD contains multiple forwarding strategy implementations.
19The strategy choice table determines which strategy is used in forwarding an Interest.
20
Junxiao Shi5d3e4812017-04-05 16:52:59 +000021The **nfdc strategy list** command shows a list of strategy choices.
22
23The **nfdc strategy show** command shows the effective strategy choice for a specific name.
Junxiao Shi6c135622016-11-21 14:30:33 +000024
25The **nfdc set-strategy** command sets the strategy for a name prefix.
26
27The **nfdc unset-strategy** command clears the strategy choice at a name prefix,
28so that a strategy choice at a shorter prefix or the default strategy will be used.
29It undoes a prior **nfdc set-strategy** command on the same name prefix.
30
31OPTIONS
32-------
Junxiao Shif0dfb332017-02-02 05:32:25 +000033<PREFIX>
Junxiao Shi6c135622016-11-21 14:30:33 +000034 The name prefix of a strategy choice.
35 The strategy choice is effective for all Interests under the name prefix,
36 unless overridden by another strategy choice.
37 Specifying ``ndn:/`` as the prefix in **nfdc set-strategy** changes the default strategy.
38 Specifying ``ndn:/`` as the prefix in **nfdc unset-strategy** is disallowed,
39 because NFD must always have a default strategy.
40
Junxiao Shif0dfb332017-02-02 05:32:25 +000041<STRATEGY>
Junxiao Shi6c135622016-11-21 14:30:33 +000042 A name that identifies the forwarding strategy.
43 Consult NFD Developer's Guide for a complete list of all implemented strategies.
44
Junxiao Shi5d3e4812017-04-05 16:52:59 +000045EXIT CODES
46----------
47
480: Success
49
501: An unspecified error occurred
51
522: Malformed command line
53
Junxiao Shi6c135622016-11-21 14:30:33 +000054SEE ALSO
55--------
56nfd(1), nfdc(1)