doc/tutorial/tutorial.texi
author Tom Henderson <tomh@tomh.org>
Sat, 19 Jan 2008 20:58:01 -0800
changeset 2221 8a6f9a7d8c48
parent 2216 9c209295b0b1
child 2222 09b00ef2f4f3
permissions -rw-r--r--
Split tutorial.texi into multiple files; some work on the tracing section
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2221
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
     1
\input texinfo  @c -*-texinfo-*-
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
     2
@c %**start of header
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
     3
@setfilename ns-3.info
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
     4
@settitle ns-3 tutorial
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
     5
@c @setchapternewpage odd
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
     6
@c %**end of header
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
     7
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
     8
@ifinfo
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
     9
Primary documentation for the @command{ns-3} project is available in
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    10
three forms:
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    11
@itemize @bullet
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    12
@item ns-3 Manual:  Documentation of the public APIs of the simulator
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    13
@item Tutorial (this document)
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    14
@item ns-3 wiki (http://www.nsnam.org/wiki/index.php)
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    15
@end itemize
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    16
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    17
This document is written in GNU Texinfo and is to be maintained in
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    18
revision control on the @command{ns-3} code server.  Both PDF and HTML versions
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    19
should be available on the server.  Changes to 
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    20
the document should be discussed on the ns-developers@@isi.edu mailing list.
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    21
@end ifinfo
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    22
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    23
@copying
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    24
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    25
This is an @command{ns-3} tutorial.
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    26
Primary documentation for the @command{ns-3} project is available in
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    27
three forms:
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    28
@itemize @bullet
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    29
@item ns-3 Manual:  Documentation of the public APIs of the simulator
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    30
@item Tutorial (this document)
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    31
@item ns-3 wiki (http://www.nsnam.org/wiki/index.php)
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    32
@end itemize
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    33
 
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    34
This document is written in GNU Texinfo and is to be maintained in
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    35
revision control on the @command{ns-3} code server.  Both PDF and HTML 
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    36
versions should be available on the server.  Changes to 
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    37
the document should be discussed on the ns-developers@@isi.edu mailing list.
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    38
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    39
This software is free software; you can redistribute it and/or modify
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    40
it under the terms of the GNU General Public License as published by
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    41
the Free Software Foundation; either version 2 of the License, or
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    42
(at your option) any later version.
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    43
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    44
This software is distributed in the hope that it will be useful,
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    45
but WITHOUT ANY WARRANTY; without even the implied warranty of
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    46
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    47
GNU General Public License for more details.
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    48
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    49
You should have received a copy of the GNU General Public License
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    50
along with this program.  If not, see @uref{http://www.gnu.org/licenses/}.
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    51
@end copying
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    52
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    53
@titlepage
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    54
@title ns-3 Tutorial
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    55
@author ns-3 project
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    56
@author feedback:  ns-developers@@isi.edu
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    57
@today{}
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    58
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    59
@c @page
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    60
@vskip 0pt plus 1filll
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    61
@insertcopying
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    62
@end titlepage
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    63
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    64
@c So the toc is printed at the start.
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    65
@anchor{Full Table of Contents}
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    66
@contents
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    67
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    68
@ifnottex
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    69
@node Top, Introduction, Full Table of Contents 
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    70
@top ns-3 Tutorial (html version)
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    71
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    72
For a pdf version of this manual, 
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    73
see @uref{http://www.nsnam.org/docs/tutorial.pdf}.
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    74
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    75
@insertcopying
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    76
@end ifnottex
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    77
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    78
@menu
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    79
* Introduction::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    80
* Overview::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    81
* Resources::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    82
* The-Basics::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    83
* Some-Prerequisites::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    84
* A-First-ns-3-Script::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    85
* Simulation Output::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    86
* Other-network-topologies::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    87
* Nonlinear-Thinking::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    88
* Summary::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    89
* Object-Model::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    90
* The-Doxygen-Documentation-System::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    91
* How-To-Change-Things::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    92
* How-To-Set-Default-Values::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    93
* How-To-Write-A-New-Application::
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    94
@end menu
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    95
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    96
@include introduction.texi
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    97
@include output.texi
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    98
@include other.texi
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    99
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
   100
@printindex cp
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
   101
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
   102
@bye