--- a/doc/tutorial/building-topologies.texi Sun Jun 29 21:16:35 2008 -0700
+++ b/doc/tutorial/building-topologies.texi Sun Jun 29 21:22:33 2008 -0700
@@ -16,8 +16,8 @@
@chapter Building Topologies
@menu
-* Building a Bus Network Topology
-* Building a Wireless Network Topology
+* Building a Bus Network Topology::
+* Building a Wireless Network Topology::
@end menu
@c ========================================================================
@@ -565,8 +565,8 @@
In this section we are going to further expand our knowledge of ns-3 network
devices and channels to cover an example of a wireless network. Ns-3 provides
a set of 802.11 models that attempt to provide an accurate MAC-level
-implementation of the 802.11 specification a ``not-so-slow'' PHY-level model
-of the 802.11a specification.
+implementation of the 802.11 specification and a ``not-so-slow''
+PHY-level model of the 802.11a specification.
Just as we have seen both point-to-point and CSMA topology helper objects when
constructing point-to-point topologies, we will see equivalent @code{Wifi}
@@ -748,7 +748,7 @@
that provides our extensions ``for free'' to other classes that inherit from
our @code{class Object}.
-In the code snipped above, the right hand side of the expression is a
+In the code snippet above, the right hand side of the expression is a
call to a templated C++ function called @code{CreateObject}. The
@emph{template parameter} inside the angle brackets basically tells the
compiler what class it is we want to instantiate. Our system returns a
--- a/doc/tutorial/conceptual-overview.texi Sun Jun 29 21:16:35 2008 -0700
+++ b/doc/tutorial/conceptual-overview.texi Sun Jun 29 21:22:33 2008 -0700
@@ -6,7 +6,7 @@
@c ========================================================================
@c Conceptual Overview
@c ========================================================================
-@node Conceptual Overveiw
+@node Conceptual Overview
@chapter Conceptual Overview
@menu
--- a/doc/tutorial/getting-started.texi Sun Jun 29 21:16:35 2008 -0700
+++ b/doc/tutorial/getting-started.texi Sun Jun 29 21:22:33 2008 -0700
@@ -267,9 +267,10 @@
along with a suggestion on how to run diff in order to see what has gone awry.
@c ========================================================================
-@c Testing ns-3
+@c Running a Script
@c ========================================================================
+@node Running a Script
@section Running a Script
@cindex running a script with Waf
We typically run scripts under the control of Waf. This allows the build
--- a/doc/tutorial/introduction.texi Sun Jun 29 21:16:35 2008 -0700
+++ b/doc/tutorial/introduction.texi Sun Jun 29 21:22:33 2008 -0700
@@ -24,15 +24,15 @@
The @command{ns-3} simulator is a discrete-event network simulator targeted
primarily for research and educational use. The
@uref{http://www.nsnam.org,,ns-3 project},
-started in 2006, is an open-source project. The goal of the project is to
-build a new network simulator primarily for research and educational use.
+started in 2006, is an open-source project developing ns-3.
-Primary documentation for the @command{ns-3} project is available in three
+Primary documentation for the @command{ns-3} project is available in four
forms:
@itemize @bullet
@item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen/Manual}:
Documentation of the public APIs of the simulator
@item Tutorial (this document)
+@item @uref{http://www.nsnam.org/docs/manual.html,,Reference Manual}: Reference Manual
@item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki}
@end itemize
@@ -97,7 +97,7 @@
started with the simulator (please contact @uref{http://www.nsnam.org/people.html,,one of us}).
@end itemize
-If you are an ns user, please consider providing your feedback, bug fixes, or
+If you are an ns-3 user, please consider providing your feedback, bug fixes, or
code to the project.
@node Tutorial Organization
@@ -176,11 +176,6 @@
Example scripts are in the @code{examples} directory. The @code{examples}
directory is a good place to start browsing the code.
-For ns-2 users, who may be familiar with the @code{simple.tcl} example script
-in the ns-2 documentation, a roughly analogous script is found in
-@code{examples/first.cc} with a Python equivalent found in
-@emph{(pending Python merge)}.
-
@node Doxygen
@section Doxygen
@@ -286,7 +281,7 @@
order to extend the system in most cases.
For those interested in the gory details of Waf, the main web site can be
-found at @uref{http://freehackers.org/\~tnagy/waf.html}.
+found at @uref{http://freehackers.org/~tnagy/waf.html}.
@node Environment Idioms Design Patterns
@section Environment, Idioms, and Design Patterns
--- a/doc/tutorial/tutorial.texi Sun Jun 29 21:16:35 2008 -0700
+++ b/doc/tutorial/tutorial.texi Sun Jun 29 21:22:33 2008 -0700
@@ -7,10 +7,11 @@
@ifinfo
Primary documentation for the @command{ns-3} project is available in
-three forms:
+four forms:
@itemize @bullet
@item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen/Manual}: Documentation of the public APIs of the simulator
@item Tutorial (this document)
+@item @uref{http://www.nsnam.org/docs/manual.html,,Reference Manual}: Reference Manual
@item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki}
@end itemize
@@ -24,10 +25,11 @@
This is an @command{ns-3} tutorial.
Primary documentation for the @command{ns-3} project is available in
-three forms:
+four forms:
@itemize @bullet
@item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen/Manual}: Documentation of the public APIs of the simulator
@item Tutorial (this document)
+@item @uref{http://www.nsnam.org/docs/manual.html,,Reference Manual}: Reference Manual
@item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki}
@end itemize
@@ -77,9 +79,12 @@
@menu
* Introduction::
-* Geting Started::
+* Browsing ns-3::
+* Resources::
+* Getting Started::
* Conceptual Overview::
-* Tweaking Ns-3::
+* A First ns-3 Script::
+* Tweaking ns-3::
* Building Topologies::
@end menu
--- a/doc/tutorial/tweaking.texi Sun Jun 29 21:16:35 2008 -0700
+++ b/doc/tutorial/tweaking.texi Sun Jun 29 21:22:33 2008 -0700
@@ -4,16 +4,16 @@
@c ========================================================================
@c ========================================================================
-@c PART: Tweaking Ns-3
+@c PART: Tweaking ns-3
@c ========================================================================
-@c The below chapters are under the major heading "Tweaking Ns-3"
+@c The below chapters are under the major heading "Tweaking ns-3"
@c This is similar to the Latex \part command
@c
@c ========================================================================
-@c Tweaking Ns-3
+@c Tweaking ns-3
@c ========================================================================
-@node Tweaking Ns-3
-@chapter Tweaking Ns-3
+@node Tweaking ns-3
+@chapter Tweaking ns-3
@menu
* Using the Logging Module::
@@ -32,7 +32,8 @@
over the @code{first.cc} script. We will now take a closer look and see what
kind of use-cases the logging subsystem was designed to cover.
-@section Logging Overview
+@node Logging Overview
+@subsection Logging Overview
Many large systems support some kind of message logging facility, and ns-3
is not an exception. In some cases, only error messages are logged to the
``operator console'' (which is typically @code{stderr} in Unix-based systems).
@@ -40,7 +41,7 @@
informational messages. In some cases, logging facilities are used to output
debug messages which can quickly turn the output into a blur.
-Ns-3 takes the view that all of these verbosity levels are useful and se
+ns-3 takes the view that all of these verbosity levels are useful and se
provides a selectable, multi-level approach to message logging. Logging can
be disabled completely, enabled on a component-by-component basis, enabled
globally and has selectable verbosity levels. The ns-3 log module provides
@@ -83,7 +84,8 @@
interesting information out of the @code{first.cc} example script you dropped
in the scratch directory after the script walkthrough.
-@section Enabling Logging Using the NS_LOG Environment Variable
+@node Enabling Logging
+@subsection Enabling Logging Using the NS_LOG Environment Variable
@cindex NS_LOG
First, let's use the NS_LOG environment variable to turn on some more logging
in the @code{first.cc} script you have already built. Go ahead and run the
@@ -323,7 +325,8 @@
output can be especially useful when your script does something completely
unexpected.
-@section Adding Logging to your Code
+@node Adding Logging to your Code
+@subsection Adding Logging to your Code
@cindex NS_LOG
You can add new logging to your simulations by making calls to the log
component via several macros. Let's do so in the @code{first.cc} script we
@@ -390,7 +393,7 @@
@node Using Command Line Arguments
@section Using Command Line Arguments
-@section Overriding Default Attributes
+@subsection Overriding Default Attributes
@cindex command line arguments
Another way you can change the way that ns-3 scripts behave without editing
and building scripts is via @emph{command line arguments.} We provide a
@@ -736,7 +739,7 @@
@cindex tracing
@cindex ASCII tracing
@subsection ASCII Tracing
-Ns-3 provides an ASCII trace helper that is a wrapper around low-level
+ns-3 provides an ASCII trace helper that is a wrapper around low-level
tracing system. This helper lets you configure some useful and easily
understood packet traces easily. The output of a trace of a simulation run
is an ASCII file --- thus the name. For those familiar with @command{ns-2}