@end verbatim

@end verbatim

to build the project.  So now if you look in the directory 

to build the project.  So now if you look in the directory 

above.  You can take a look at the contents of these files and find that they

above.  You can take a look at the contents of these files and find that they

do include all of the public include files in their respective modules.

do include all of the public include files in their respective modules.

We will use this statement as a convenient place to talk about our Doxygen

We will use this statement as a convenient place to talk about our Doxygen

documentation system.  If you look at the project web site, 

documentation system.  If you look at the project web site, 

taken to our documentation page.

taken to our documentation page.

Along the left side, you will find a graphical representation of the structure

Along the left side, you will find a graphical representation of the structure

@cindex tarball

@cindex tarball

The @command{ns-3} code is available in Mercurial repositories on the server

The @command{ns-3} code is available in Mercurial repositories on the server

@uref{http://www.nsnam.org/releases/}, or you can work with repositories

@uref{http://www.nsnam.org/releases/}, or you can work with repositories

using Mercurial.  We recommend using Mercurial unless there's a good reason

using Mercurial.  We recommend using Mercurial unless there's a good reason

not to.  See the end of this section for instructions on how to get a tarball

not to.  See the end of this section for instructions on how to get a tarball

@cindex repository

@cindex repository

The simplest way to get started using Mercurial repositories is to use the

The simplest way to get started using Mercurial repositories is to use the

@code{ns-3-allinone} environment.  This is a set of scripts that manages the 

@code{ns-3-allinone} environment.  This is a set of scripts that manages the 

recommend that you begin your @command{ns-3} adventures in this environment

recommend that you begin your @command{ns-3} adventures in this environment

as it can really simplify your life at this point.

as it can really simplify your life at this point.

the more constant ns-3-dev here in the tutorial, but you can replace the 

the more constant ns-3-dev here in the tutorial, but you can replace the 

string ``ns-3-dev'' with your choice of release (e.g., ns-3.4 and 

string ``ns-3-dev'' with your choice of release (e.g., ns-3.4 and 

ns-3.4-ref-traces) in the text below.  You can find the latest version  of the

ns-3.4-ref-traces) in the text below.  You can find the latest version  of the

Go ahead and change into the @code{ns-3-allinone} directory you created when

Go ahead and change into the @code{ns-3-allinone} directory you created when

you cloned that repository.  We are now going to use the @code{download.py} 

you cloned that repository.  We are now going to use the @code{download.py} 

Go ahead and type the following into your shell (remember you can substitute

Go ahead and type the following into your shell (remember you can substitute

the name of your chosen release number instead of @code{ns-3-dev} -- like

the name of your chosen release number instead of @code{ns-3-dev} -- like

  mkdir tarballs

  mkdir tarballs

  cd tarballs

  cd tarballs

  wget http://www.nsnam.org/releases/ns-allinone-3.4.tar.bz2

  wget http://www.nsnam.org/releases/ns-allinone-3.4.tar.bz2

@end verbatim 

@end verbatim 

If you change into the directory @code{ns-allinone-3.4} you should see a

If you change into the directory @code{ns-allinone-3.4} you should see a

number of files:

number of files:

@verbatim

@verbatim

@end verbatim 

@end verbatim 

You are now ready to build the @command{ns-3} distribution.

You are now ready to build the @command{ns-3} distribution.

@end verbatim

@end verbatim

Note the last part of the above output.  Some ns-3 options are not enabled by

Note the last part of the above output.  Some ns-3 options are not enabled by

For instance, to enable XmlTo, the library libxml-2.0 must be found on the

For instance, to enable XmlTo, the library libxml-2.0 must be found on the

system.  in the example above, this library was not found and the corresponding

system.  in the example above, this library was not found and the corresponding

feature was not enabled.  There is a feature to use sudo to set the suid bit of

feature was not enabled.  There is a feature to use sudo to set the suid bit of

available in waf.  To explore these options, type:

available in waf.  To explore these options, type:

@verbatim

@verbatim

@end verbatim

@end verbatim

We'll use some of the testing-related commands in the next section.

We'll use some of the testing-related commands in the next section.

@cindex regression tests

@cindex regression tests

You can also run our regression test suite to ensure that your distribution and

You can also run our regression test suite to ensure that your distribution and

known-good reference output files.  You downloaded these reference traces to 

known-good reference output files.  You downloaded these reference traces to 

your machine during the download process above.  (Warning:  The @code{ns-3.2} 

your machine during the download process above.  (Warning:  The @code{ns-3.2} 

and @code{ns-3.3} releases do not use the @code{ns-3-allinone} environment

and @code{ns-3.3} releases do not use the @code{ns-3-allinone} environment

has gone awry.  If the error was discovered in a pcap file, it will be useful

has gone awry.  If the error was discovered in a pcap file, it will be useful

to convert the pcap files to text using tcpdump prior to comparison.

to convert the pcap files to text using tcpdump prior to comparison.

is not present.

is not present.

To run the regression tests, you provide Waf with the regression flag.

To run the regression tests, you provide Waf with the regression flag.

@end verbatim

@end verbatim

Waf first checks to make sure that the program is built correctly and 

Waf first checks to make sure that the program is built correctly and 

produces the following output.

produces the following output.

@verbatim

@verbatim

order to extend the system in most cases.

order to extend the system in most cases.

For those interested in the gory details of Waf, the main web site can be 

For those interested in the gory details of Waf, the main web site can be 

@node Development Environment

@node Development Environment

@section Development Environment

@section Development Environment

@cindex MinGW

@cindex MinGW

If you do use Cygwin or MinGW; and use Logitech products, we will save you

If you do use Cygwin or MinGW; and use Logitech products, we will save you

quite a bit of heartburn right off the bat and encourage you to take a look

quite a bit of heartburn right off the bat and encourage you to take a look

@cindex Logitech

@cindex Logitech

Search for ``Logitech'' and read the FAQ entry, ``why does make often 

Search for ``Logitech'' and read the FAQ entry, ``why does make often 

We will assume a basic facility with the Berkeley Sockets API in the examples

We will assume a basic facility with the Berkeley Sockets API in the examples

used in this tutorial.  If you are new to sockets, we recommend reviewing the

used in this tutorial.  If you are new to sockets, we recommend reviewing the

API and some common usage cases.  For a good overview of programming TCP/IP

API and some common usage cases.  For a good overview of programming TCP/IP

There is an associated web site that includes source for the examples in the

There is an associated web site that includes source for the examples in the

book, which you can find at:

book, which you can find at:

not have access to a copy of the book, the echo clients and servers shown in 

not have access to a copy of the book, the echo clients and servers shown in 

the website above) you will be in good shape to understand the tutorial.

the website above) you will be in good shape to understand the tutorial.

There is a similar book on Multicast Sockets,

There is a similar book on Multicast Sockets,

that covers material you may need to understand if you look at the multicast 

that covers material you may need to understand if you look at the multicast 

examples in the distribution.

examples in the distribution.