Gitiles
Code Review Sign In
gerrit.named-data.net / ndns / fee7ee372cc98df7940b8d4cc92251a0e9e2f44e / . / docs / INSTALL.rst
blob: 771a07c28111a6427cb347af326f50fd90020c83 [file] [log] [blame]
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]1.. _NDNS Installation Instructions:
2
3NDNS Installation Instructions
4==============================
5
6Prerequisites
7-------------
8
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]9Install the `ndn-cxx library <https://named-data.net/doc/ndn-cxx/current/INSTALL.html>`_
10and its prerequisites.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]11
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]12Optionally, to build manpages and API documentation the following additional dependencies
13need to be installed:
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]14
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]15- doxygen
16- graphviz
17- sphinx
18- sphinxcontrib-doxylink
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]19
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]20Build
21-----
22
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]23The following basic commands should be used to build NDNS on Ubuntu::
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]24
25 ./waf configure
26 ./waf
27 sudo ./waf install
28
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]29Refer to ``./waf --help`` for more options that can be used during the ``configure`` stage.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]30
31Debug symbols
32+++++++++++++
33
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]34The default compiler flags include debug symbols in binaries. This should provide
35more meaningful debugging information if NDNS or other tools happen to crash.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]36
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]37If this is undesirable, the default flags can be overridden to disable debug symbols.
38The following example shows how to completely disable debug symbols and configure
39NDNS to be installed into ``/usr`` with configuration in the ``/etc`` directory.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]40
41::
42
43 CXXFLAGS="-O2" ./waf configure --prefix=/usr --sysconfdir=/etc
44 ./waf
45 sudo ./waf install
46
47Building documentation
48----------------------
49
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]50NDNS tutorials and API documentation can be built using the following commands::
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]51
52 # Full set of documentation (tutorials + API) in build/docs
53 ./waf docs
54
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]55 # Only tutorials in build/docs
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]56 ./waf sphinx
57
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]58 # Only API docs in build/docs/doxygen
59 ./waf doxygen
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]60
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]61If ``sphinx-build`` is detected during ``./waf configure``, manpages will automatically
62be built and installed during the normal build process (i.e., during ``./waf`` and
63``./waf install``). By default, manpages will be installed into ``${PREFIX}/share/man``
64(the default value for ``PREFIX`` is ``/usr/local``). This location can be changed
65during the ``./waf configure`` stage using the ``--prefix``, ``--datarootdir``, or
66``--mandir`` options.
Alexander Afanasyevbd5b67a2014-09-02 16:06:21 -0700[diff] [blame]67
Davide Pesaventofee7ee32020-04-15 02:45:07 -0400[diff] [blame^]68For further details, please refer to ``./waf --help``.