Gitiles
Code Review Sign In
gerrit.named-data.net / NFD / 9f6a7d97bc0a7732b03826b9f10c900edf94b262 / . / docs / index.rst
blob: e54fc95b71ebd0c86ca1f4764b2725ea30b95a41 [file] [log] [blame]
Davide Pesavento9f6a7d92020-10-06 15:21:48 -0400[diff] [blame^]1NFD: Named Data Networking Forwarding Daemon
2============================================
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]3
Davide Pesavento9f6a7d92020-10-06 15:21:48 -0400[diff] [blame^]4**NFD** is a network forwarder that implements and evolves together with the Named Data
5Networking (NDN) `protocol <https://named-data.net/doc/NDN-packet-spec/current/>`__.
6NFD is a core component of the `NDN Platform <https://named-data.net/codebase/platform/>`__.
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]7
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]8NFD Documentation
9-----------------
Alexander Afanasyev49272f72014-04-06 21:49:46 -0700[diff] [blame]10
Alexander Afanasyev49272f72014-04-06 21:49:46 -0700[diff] [blame]11.. toctree::
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]12 :hidden:
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]13 :maxdepth: 3
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]14
Steve DiBenedetto62a93942014-08-24 17:13:52 -0600[diff] [blame]15 overview
16 INSTALL
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]17 FAQ
Alexander Afanasyev49272f72014-04-06 21:49:46 -0700[diff] [blame]18 manpages
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]19
Alexander Afanasyev687dba82015-09-27 15:32:58 -0700[diff] [blame]20.. toctree::
21 :hidden:
22 :maxdepth: 1
23
24 RELEASE_NOTES
25 releases
26
Steve DiBenedetto62a93942014-08-24 17:13:52 -0600[diff] [blame]27* :doc:`overview`
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]28
Steve DiBenedetto62a93942014-08-24 17:13:52 -0600[diff] [blame]29 A brief overview of NFD and its major modules.
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]30
Steve DiBenedetto62a93942014-08-24 17:13:52 -0600[diff] [blame]31* :doc:`INSTALL`
32
33 Instructions for obtaining, installing, and running NFD.
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]34
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]35* :doc:`FAQ`
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]36
Steve DiBenedetto62a93942014-08-24 17:13:52 -0600[diff] [blame]37 Suggestions for configuring and running non-standard NFD setups.
38
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]39* :doc:`manpages`
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]40
Davide Pesavento9f6a7d92020-10-06 15:21:48 -0400[diff] [blame^]41Additional Documentation
42^^^^^^^^^^^^^^^^^^^^^^^^
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]43
Davide Pesavento17521592020-05-14 19:01:32 -0400[diff] [blame]44* `NFD Developer's Guide <https://named-data.net/publications/techreports/ndn-0021-10-nfd-developer-guide/>`__
Alexander Afanasyev40ee3812014-07-01 00:25:21 -0700[diff] [blame]45
Steve DiBenedetto62a93942014-08-24 17:13:52 -0600[diff] [blame]46 A comprehensive guide to the design and implementation of NFD. The developer's guide also contains
47 suggestions and hints for anyone wanting to modify or extend NFD.
48
Davide Pesavento17521592020-05-14 19:01:32 -0400[diff] [blame]49* `NDN Software Contributor's Guide <https://github.com/named-data/.github/blob/master/CONTRIBUTING.md>`__
Nick Gordon3257af22017-12-21 14:15:55 -0600[diff] [blame]50 (guide for newcomers to the NDN community of software)
51
Davide Pesavento17521592020-05-14 19:01:32 -0400[diff] [blame]52* `NFD Wiki <https://redmine.named-data.net/projects/nfd/wiki>`__
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]53
Steve DiBenedetto62a93942014-08-24 17:13:52 -0600[diff] [blame]54 The NFD Wiki contains detailed protocol specifications and
55 information for building on unsupported platforms.
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]56
Davide Pesavento9f6a7d92020-10-06 15:21:48 -0400[diff] [blame^]57 + `NFD Management protocol <https://redmine.named-data.net/projects/nfd/wiki/Management>`__
58 + `NFD configuration file format <https://redmine.named-data.net/projects/nfd/wiki/ConfigFileFormat>`__
59
Davide Pesavento17521592020-05-14 19:01:32 -0400[diff] [blame]60* `API Documentation (doxygen) <doxygen/annotated.html>`__
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]61
Alexander Afanasyev687dba82015-09-27 15:32:58 -0700[diff] [blame]62* :doc:`RELEASE_NOTES`
63
64* :doc:`releases`
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]65
66License
67-------
68
Davide Pesavento17521592020-05-14 19:01:32 -0400[diff] [blame]69NFD is a free and open-source software package licensed under the GPL version 3 and
70is the centerpiece of our committement to making NDN's core technology free and open
71to all Internet users and developers. For more information about licensing, refer to
72`COPYING.md <https://github.com/named-data/NFD/blob/master/COPYING.md>`__.