blob: 57db00ce98415dff11e9df8499c88332218d4d7a [file] [log] [blame]
Alexander Afanasyev49272f72014-04-06 21:49:46 -07001nfd
2===
3
Davide Pesavento9f6a7d92020-10-06 15:21:48 -04004Synopsis
5--------
Alexander Afanasyev49272f72014-04-06 21:49:46 -07006
Davide Pesavento543b1522024-06-25 17:00:32 -04007| **nfd** [**-c**\|\ **\--config** *file*]
8| **nfd** **-h**\|\ **\--help**
9| **nfd** **-m**\|\ **\--modules**
10| **nfd** **-V**\|\ **\--version**
Alexander Afanasyev49272f72014-04-06 21:49:46 -070011
Alexander Afanasyev49272f72014-04-06 21:49:46 -070012Description
13-----------
14
Davide Pesavento543b1522024-06-25 17:00:32 -040015NFD is a network forwarder that implements the Named Data Networking (NDN) protocol.
hilata6ee6e072014-04-20 17:10:18 -050016
Davide Pesavento59769b12017-11-12 23:52:06 -050017Options
18-------
hilata6ee6e072014-04-20 17:10:18 -050019
Davide Pesavento543b1522024-06-25 17:00:32 -040020.. option:: -c <file>, --config <file>
hilata6ee6e072014-04-20 17:10:18 -050021
Davide Pesavento543b1522024-06-25 17:00:32 -040022 Specify the path to NFD's configuration file.
Davide Pesavento59769b12017-11-12 23:52:06 -050023
Davide Pesavento543b1522024-06-25 17:00:32 -040024.. option:: -h, --help
Davide Pesavento59769b12017-11-12 23:52:06 -050025
Davide Pesavento543b1522024-06-25 17:00:32 -040026 Print help message and exit.
Davide Pesavento59769b12017-11-12 23:52:06 -050027
Davide Pesavento543b1522024-06-25 17:00:32 -040028.. option:: -m, --modules
29
30 List available logging modules.
31
32.. option:: -V, --version
33
34 Show version information and exit.
35
36Exit Status
Davide Pesavento59769b12017-11-12 23:52:06 -050037-----------
38
Davide Pesavento543b1522024-06-25 17:00:32 -0400390
40 No error.
Davide Pesavento59769b12017-11-12 23:52:06 -050041
Davide Pesavento543b1522024-06-25 17:00:32 -0400421
43 An unspecified error occurred.
Davide Pesavento59769b12017-11-12 23:52:06 -050044
Davide Pesavento543b1522024-06-25 17:00:32 -0400452
46 Malformed command line, e.g., invalid, missing, or unknown argument.
Davide Pesavento59769b12017-11-12 23:52:06 -050047
Davide Pesavento543b1522024-06-25 17:00:32 -0400484
49 Insufficient privileges.
Davide Pesavento59769b12017-11-12 23:52:06 -050050
hilata6ee6e072014-04-20 17:10:18 -050051Examples
52--------
53
Davide Pesavento543b1522024-06-25 17:00:32 -040054``sudo nfd --config nfd.conf``
55 Start NFD as super user with a configuration file from the current directory.
hilata6ee6e072014-04-20 17:10:18 -050056
Davide Pesavento543b1522024-06-25 17:00:32 -040057See Also
58--------
Alexander Afanasyev49272f72014-04-06 21:49:46 -070059
Davide Pesavento543b1522024-06-25 17:00:32 -040060:manpage:`nfdc(1)`