Debian Codegraph @

protolib/doc/doxygen/mainpages/buildingWithWaf.h

raw
1 /**
2 @page building_with_waf Building Protolib with WAF
3
4 @li @ref building_with_waf
5 @li @ref building_configuring_waf
6 @li @ref building_the_library
7 @li @ref building_installing
8 @li @ref building_uninstalling
9 @li @ref building_cleaning
10
11 <hr>
12 @section building_with_waf Building Protolib with WAF
13
14 Protolib can be built using the Waf build tool, included in the distribution.
15 To see a full list of options, run:
16
17 @verbatim
18 ./waf -h
19 @endverbatim
20
21 <hr>
22 @section building_configuring_waf Configuring WAF
23
24 To perform the configure checks, run:
25
26 @verbatim
27 ./waf configure
28 @endverbatim
29
30 Some options for the configure step:
31
32 @verbatim
33 --prefix=<DIR> - Directory to install files to (Default - /usr/local)
34
35 --debug - Builds a debug build (with debugging symbols), otherwise an
36 optimized library is built.
37 --static - Builds a statically linked library, otherwise a shared library
38 is built.
39
40 --build-python - Builds the Python ProtoPipe extension
41 --build-java - Builds the Java ProtoPipe extension
42 You must set the JAVA_HOME environment variable to the location of your
43 JDK directory
44 --build-ns3 - Builds the NS3 extensions
45 You must set the NS3_HOME environment variable to the location of your
46 NS3 directory
47
48 --disable-X - Disables the feature X (See ./waf -h for descriptions)
49 @endverbatim
50
51 <hr>
52 @section building_the_library Building the Library
53
54 To build the library, simply run:
55
56 @verbatim
57 ./waf
58 @endverbatim
59
60 To build examples along with the library, run:
61
62 @verbatim
63 ./waf --ex-XXX
64 @endverbatim
65
66 Where XXX is the name of the example you want to build (see ./waf -h).
67 Additionally, you can add the --ex-all flag to build all the example programs.
68
69 <hr>
70 @section building_installing Installing
71
72 To install, run:
73
74 @verbatim
75 ./waf install
76 @endverbatim
77
78 This will install the compiled library and headers to wherever your prefix was
79 specified. (See configure flags)
80
81 <hr>
82 @section building_uninstalling Uninstalling
83
84 Waf tracks the files it installs, so run:
85
86 @verbatim
87 ./waf uninstall
88 @endverbatim
89
90 to remove all files from a previous ./waf install
91
92 <hr>
93 @section building_cleaning Cleaning
94
95 @verbatim
96 ./waf clean
97 @endverbatim
98
99 will delete all compiled files and configuration settings.
100
101 @verbatim
102 ./waf distclean
103 @endverbatim
104
105 will do the same as clean, and additionally delete the waf cache files.
106
107 */
108