doc/tutorial/tutorial.texi
author Florian Westphal <fw@strlen.de>
Wed, 03 Sep 2008 23:24:59 +0200
changeset 3595 693faf7f4e9b
parent 3353 244be25117b9
child 5382 0a46f4d86040
permissions -rw-r--r--
nsc: Fix build problem if gtk config store is disabled gtk config store pulled in libdl.so for us, so things fail to link of the config store isn't enabled. This makes nsc pull in libdl itself when its enabled.
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
3340
0b45016b6097 Table of content fixes
Tom Henderson <tomh@tomh.org>
parents: 3332
diff changeset
    10
four forms:
2221
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
2222
09b00ef2f4f3 add hyperlinks to wiki, Doxygen
Tom Henderson <tomh@tomh.org>
parents: 2221
diff changeset
    12
@item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen/Manual}:  Documentation of the public APIs of the simulator
2221
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)
3340
0b45016b6097 Table of content fixes
Tom Henderson <tomh@tomh.org>
parents: 3332
diff changeset
    14
@item @uref{http://www.nsnam.org/docs/manual.html,,Reference Manual}:  Reference Manual
2222
09b00ef2f4f3 add hyperlinks to wiki, Doxygen
Tom Henderson <tomh@tomh.org>
parents: 2221
diff changeset
    15
@item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki}
2221
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    16
@end itemize
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    17
3345
b0af63b9f9a6 editing pass through the tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3332
diff changeset
    18
This document is written in GNU Texinfo and is to be maintained in revision 
b0af63b9f9a6 editing pass through the tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3332
diff changeset
    19
control on the @command{ns-3} code server.  Both PDF and HTML versions should 
b0af63b9f9a6 editing pass through the tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3332
diff changeset
    20
be available on the server.  Changes to the document should be discussed on 
b0af63b9f9a6 editing pass through the tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3332
diff changeset
    21
the ns-developers@@isi.edu mailing list.
2221
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    22
@end ifinfo
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    23
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    24
@copying
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    25
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    26
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
    27
Primary documentation for the @command{ns-3} project is available in
3340
0b45016b6097 Table of content fixes
Tom Henderson <tomh@tomh.org>
parents: 3332
diff changeset
    28
four forms:
2221
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    29
@itemize @bullet
2222
09b00ef2f4f3 add hyperlinks to wiki, Doxygen
Tom Henderson <tomh@tomh.org>
parents: 2221
diff changeset
    30
@item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen/Manual}:  Documentation of the public APIs of the simulator
2221
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    31
@item Tutorial (this document)
3340
0b45016b6097 Table of content fixes
Tom Henderson <tomh@tomh.org>
parents: 3332
diff changeset
    32
@item @uref{http://www.nsnam.org/docs/manual.html,,Reference Manual}:  Reference Manual
2222
09b00ef2f4f3 add hyperlinks to wiki, Doxygen
Tom Henderson <tomh@tomh.org>
parents: 2221
diff changeset
    33
@item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki}
2221
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    34
@end itemize
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    35
 
3345
b0af63b9f9a6 editing pass through the tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3332
diff changeset
    36
This document is written in GNU Texinfo and is to be maintained in revision 
b0af63b9f9a6 editing pass through the tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3332
diff changeset
    37
control on the @command{ns-3} code server.  Both PDF and HTML versions should 
b0af63b9f9a6 editing pass through the tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3332
diff changeset
    38
be available on the server.  Changes to the document should be discussed on 
b0af63b9f9a6 editing pass through the tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3332
diff changeset
    39
the ns-developers@@isi.edu mailing list.
2221
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    40
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    41
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
    42
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
    43
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
    44
(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
    45
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    46
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
    47
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
    48
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
    49
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
    50
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    51
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
    52
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
    53
@end copying
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    54
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    55
@titlepage
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    56
@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
    57
@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
    58
@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
    59
@today{}
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    60
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    61
@c @page
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    62
@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
    63
@insertcopying
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    64
@end titlepage
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    65
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    66
@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
    67
@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
    68
@contents
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    69
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    70
@ifnottex
3332
da67e8efa347 swap in new tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3273
diff changeset
    71
@node Top, Introduction, Full Table of Contents 
2221
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    72
@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
    73
2222
09b00ef2f4f3 add hyperlinks to wiki, Doxygen
Tom Henderson <tomh@tomh.org>
parents: 2221
diff changeset
    74
For a pdf version of this tutorial, 
2221
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    75
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
    76
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    77
@insertcopying
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    78
@end ifnottex
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    79
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    80
@menu
3332
da67e8efa347 swap in new tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3273
diff changeset
    81
* Introduction::
3340
0b45016b6097 Table of content fixes
Tom Henderson <tomh@tomh.org>
parents: 3332
diff changeset
    82
* Resources::
0b45016b6097 Table of content fixes
Tom Henderson <tomh@tomh.org>
parents: 3332
diff changeset
    83
* Getting Started::
3332
da67e8efa347 swap in new tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3273
diff changeset
    84
* Conceptual Overview::
3340
0b45016b6097 Table of content fixes
Tom Henderson <tomh@tomh.org>
parents: 3332
diff changeset
    85
* Tweaking ns-3::
3332
da67e8efa347 swap in new tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3273
diff changeset
    86
* Building Topologies::
2221
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    87
@end menu
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    88
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    89
@include introduction.texi
3332
da67e8efa347 swap in new tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3273
diff changeset
    90
@include getting-started.texi
da67e8efa347 swap in new tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3273
diff changeset
    91
@include conceptual-overview.texi
da67e8efa347 swap in new tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3273
diff changeset
    92
@include tweaking.texi
da67e8efa347 swap in new tutorial
Craig Dowell <craigdo@ee.washington.edu>
parents: 3273
diff changeset
    93
@include building-topologies.texi
2221
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    94
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    95
@printindex cp
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    96
8a6f9a7d8c48 Split tutorial.texi into multiple files; some work on the tracing section
Tom Henderson <tomh@tomh.org>
parents: 2216
diff changeset
    97
@bye