NFD: Named Data Networking Forwarding Daemon
============================================

.. toctree::
   :hidden:
   :maxdepth: 3

   overview
   INSTALL
   FAQ
   manpages

.. toctree::
   :hidden:
   :maxdepth: 1

   release-notes
   releases

**NFD** is a network forwarder that implements and evolves together with the Named Data
Networking (NDN) `protocol <https://named-data.net/doc/NDN-packet-spec/current/>`__.
NFD is a core component of the `NDN Platform <https://named-data.net/codebase/platform/>`__.

Documentation
-------------

* :doc:`overview`

  A brief overview of NFD and its major modules.

* :doc:`INSTALL`

  Instructions for obtaining, installing, and running NFD.

* :doc:`FAQ`

  Suggestions for configuring and running non-standard NFD setups.

* :doc:`manpages`
* :doc:`release-notes`
* :doc:`releases`

For developers
^^^^^^^^^^^^^^

* `NFD Developer's Guide <https://named-data.net/publications/techreports/ndn-0021-11-nfd-guide/>`__

  A comprehensive guide to the design and implementation of NFD. The developer's guide
  also contains suggestions and hints for anyone wanting to modify or extend NFD.

* `NDN Software Contributor's Guide <https://github.com/named-data/.github/blob/main/CONTRIBUTING.md>`__
  (guide for newcomers to the NDN community of software)

* `NFD Wiki <https://redmine.named-data.net/projects/nfd/wiki>`__

  The NFD Wiki contains detailed protocol specifications and information for building
  on unsupported platforms.

  + `NFD management protocol <https://redmine.named-data.net/projects/nfd/wiki/Management>`__
  + `NDNLPv2 link protocol <https://redmine.named-data.net/projects/nfd/wiki/NDNLPv2>`__

* `API documentation (doxygen) <doxygen/annotated.html>`__

Issues
------

Please submit any bugs or feature requests to the
`NFD issue tracker <https://redmine.named-data.net/projects/nfd/issues>`__.

License
-------

NFD is a free and open-source software package licensed under the GPL version 3 and
is the centerpiece of our committement to making NDN's core technology free and open
to all Internet users and developers. For more information about licensing, refer to
`COPYING.md <https://github.com/named-data/NFD/blob/master/COPYING.md>`__.