| 1 |
/** |
| 2 |
@page building_examples_with_waf Building Protolib Examples with WAF |
| 3 |
|
| 4 |
@li @ref building_with_waf |
| 5 |
@li @ref building_configuring_waf |
| 6 |
@li @ref building_the_examples |
| 7 |
@li @ref building_cleaning |
| 8 |
|
| 9 |
<hr> |
| 10 |
@section building_with_waf Building with WAF |
| 11 |
|
| 12 |
Protolib examples can be built using the Waf build tool, included in the distribution. |
| 13 |
To see a full list of example programs, run: |
| 14 |
|
| 15 |
@verbatim |
| 16 |
./waf -h |
| 17 |
@endverbatim |
| 18 |
|
| 19 |
<hr> |
| 20 |
@section building_configuring_waf Configuring WAF |
| 21 |
|
| 22 |
To perform the configure checks, run: |
| 23 |
|
| 24 |
@verbatim |
| 25 |
./waf configure |
| 26 |
@endverbatim |
| 27 |
|
| 28 |
Some options for the configure step: |
| 29 |
|
| 30 |
@verbatim |
| 31 |
--prefix=<DIR> - Directory to install files to (Default - /usr/local) |
| 32 |
|
| 33 |
--debug - Builds a debug build (with debugging symbols), otherwise an |
| 34 |
optimized library is built. |
| 35 |
--static - Builds a statically linked library, otherwise a shared library |
| 36 |
is built. |
| 37 |
|
| 38 |
--build-python - Builds the Python ProtoPipe extension |
| 39 |
--build-java - Builds the Java ProtoPipe extension |
| 40 |
You must set the JAVA_HOME environment variable to the location of your |
| 41 |
JDK directory |
| 42 |
--build-ns3 - Builds the NS3 extensions |
| 43 |
You must set the NS3_HOME environment variable to the location of your |
| 44 |
NS3 directory |
| 45 |
|
| 46 |
--disable-X - Disables the feature X (See ./waf -h for descriptions) |
| 47 |
@endverbatim |
| 48 |
|
| 49 |
<hr> |
| 50 |
@section building_the_examples Building the Examples |
| 51 |
|
| 52 |
To build all the examples, simply run: |
| 53 |
|
| 54 |
@verbatim |
| 55 |
./waf -ex-all |
| 56 |
@endverbatim |
| 57 |
|
| 58 |
To build a specific example, run: |
| 59 |
|
| 60 |
@verbatim |
| 61 |
./waf --ex-XXX |
| 62 |
@endverbatim |
| 63 |
|
| 64 |
Where XXX is the name of the example you want to build (see ./waf -h). |
| 65 |
|
| 66 |
<hr> |
| 67 |
@section building_cleaning Cleaning |
| 68 |
|
| 69 |
@verbatim |
| 70 |
./waf clean |
| 71 |
@endverbatim |
| 72 |
|
| 73 |
will delete all compiled files and configuration settings. |
| 74 |
|
| 75 |
@verbatim |
| 76 |
./waf distclean |
| 77 |
@endverbatim |
| 78 |
|
| 79 |
will do the same as clean, and additionally delete the waf cache files. |
| 80 |
|
| 81 |
*/ |
| 82 |
|