Gitiles
Code Review Sign In
gerrit.named-data.net / NFD / 3bc8e19a89f13b09b48b747b9faa223c0e96da37 / . / docs / index.rst
blob: c6e19a45fee78aa25621425678435fcae8620aee [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
Alexander Afanasyev49272f72014-04-06 21:49:46 -0700[diff] [blame]4.. toctree::
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]5 :hidden:
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]6 :maxdepth: 3
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]7
Steve DiBenedetto62a93942014-08-24 17:13:52 -0600[diff] [blame]8 overview
9 INSTALL
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]10 FAQ
Alexander Afanasyev49272f72014-04-06 21:49:46 -0700[diff] [blame]11 manpages
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]12
Alexander Afanasyev687dba82015-09-27 15:32:58 -0700[diff] [blame]13.. toctree::
14 :hidden:
15 :maxdepth: 1
16
Davide Pesavento3bc8e192022-12-31 01:40:11 -0500[diff] [blame^]17 release-notes
Alexander Afanasyev687dba82015-09-27 15:32:58 -0700[diff] [blame]18 releases
19
Davide Pesavento3bc8e192022-12-31 01:40:11 -0500[diff] [blame^]20**NFD** is a network forwarder that implements and evolves together with the Named Data
21Networking (NDN) `protocol <https://named-data.net/doc/NDN-packet-spec/current/>`__.
22NFD is a core component of the `NDN Platform <https://named-data.net/codebase/platform/>`__.
23
24Documentation
25-------------
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`
Davide Pesavento3bc8e192022-12-31 01:40:11 -0500[diff] [blame^]40* :doc:`release-notes`
41* :doc:`releases`
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]42
Davide Pesavento3bc8e192022-12-31 01:40:11 -0500[diff] [blame^]43For developers
44^^^^^^^^^^^^^^
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]45
Davide Pesavento3bc8e192022-12-31 01:40:11 -0500[diff] [blame^]46* `NFD Developer's Guide <https://named-data.net/publications/techreports/ndn-0021-11-nfd-guide/>`__
Alexander Afanasyev40ee3812014-07-01 00:25:21 -0700[diff] [blame]47
Davide Pesavento3bc8e192022-12-31 01:40:11 -0500[diff] [blame^]48 A comprehensive guide to the design and implementation of NFD. The developer's guide
49 also contains suggestions and hints for anyone wanting to modify or extend NFD.
Steve DiBenedetto62a93942014-08-24 17:13:52 -0600[diff] [blame]50
Davide Pesavento17521592020-05-14 19:01:32 -0400[diff] [blame]51* `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]52 (guide for newcomers to the NDN community of software)
53
Davide Pesavento17521592020-05-14 19:01:32 -0400[diff] [blame]54* `NFD Wiki <https://redmine.named-data.net/projects/nfd/wiki>`__
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]55
Davide Pesavento3bc8e192022-12-31 01:40:11 -0500[diff] [blame^]56 The NFD Wiki contains detailed protocol specifications and information for building
57 on unsupported platforms.
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]58
Davide Pesavento3bc8e192022-12-31 01:40:11 -0500[diff] [blame^]59 + `NFD management protocol <https://redmine.named-data.net/projects/nfd/wiki/Management>`__
60 + `NDNLPv2 link protocol <https://redmine.named-data.net/projects/nfd/wiki/NDNLPv2>`__
Davide Pesavento9f6a7d92020-10-06 15:21:48 -0400[diff] [blame]61
Davide Pesavento3bc8e192022-12-31 01:40:11 -0500[diff] [blame^]62* `API documentation (doxygen) <doxygen/annotated.html>`__
Alexander Afanasyev26181532014-05-07 23:38:51 -0700[diff] [blame]63
Davide Pesavento3bc8e192022-12-31 01:40:11 -0500[diff] [blame^]64Issues
65------
Alexander Afanasyev687dba82015-09-27 15:32:58 -0700[diff] [blame]66
Davide Pesavento3bc8e192022-12-31 01:40:11 -0500[diff] [blame^]67Please submit any bugs or feature requests to the
68`NFD issue tracker <https://redmine.named-data.net/projects/nfd/issues>`__.
Beichuan Zhang55b8ed42014-04-26 22:25:44 -0700[diff] [blame]69
70License
71-------
72
Davide Pesavento17521592020-05-14 19:01:32 -0400[diff] [blame]73NFD is a free and open-source software package licensed under the GPL version 3 and
74is the centerpiece of our committement to making NDN's core technology free and open
75to all Internet users and developers. For more information about licensing, refer to
76`COPYING.md <https://github.com/named-data/NFD/blob/master/COPYING.md>`__.