author | Tom Henderson <tomh@tomh.org> |
Mon, 15 Dec 2008 07:25:27 -0800 | |
changeset 4024 | dfd0bc16dc99 |
parent 3986 | 44d4f4d768dd |
child 4134 | a104b592cba3 |
permissions | -rw-r--r-- |
3274
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
1 |
\input texinfo @c -*-texinfo-*- |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
2 |
@c %**start of header |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
3 |
@setfilename ns-3.info |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
4 |
@settitle ns-3 manual |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
5 |
@c @setchapternewpage odd |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
6 |
@c %**end of header |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
7 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
8 |
@ifinfo |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
9 |
Primary documentation for the @command{ns-3} project is available in |
3314
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
10 |
four forms: |
3274
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
11 |
@itemize @bullet |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
12 |
@item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen/Manual}: Documentation of the public APIs of the simulator |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
13 |
@item @uref{http://www.nsnam.org/tutorial/index.html,,ns-3 Tutorial} |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
14 |
@item Reference Manual (this document) |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
15 |
@item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki} |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
16 |
@end itemize |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
17 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
18 |
This document is written in GNU Texinfo and is to be maintained in |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
19 |
revision control on the @command{ns-3} code server. Both PDF and HTML versions |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
20 |
should be available on the server. Changes to |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
21 |
the document should be discussed on the ns-developers@@isi.edu mailing list. |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
22 |
@end ifinfo |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
23 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
24 |
@copying |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
25 |
|
3314
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
26 |
This is an @command{ns-3} reference manual. |
3274
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
27 |
Primary documentation for the @command{ns-3} project is available in |
3314
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
28 |
four forms: |
3274
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
29 |
@itemize @bullet |
3314
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
30 |
@item @uref{http://www.nsnam.org/tutorial/index.html,,ns-3 Tutorial} |
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
31 |
@item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen}: Documentation of the public APIs of the simulator |
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
32 |
@item Reference Manual (this document) |
3274
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
33 |
@item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki} |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
34 |
@end itemize |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
35 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
36 |
This document is written in GNU Texinfo and is to be maintained in |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
37 |
revision control on the @command{ns-3} code server. Both PDF and HTML |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
38 |
versions should be available on the server. Changes to |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
39 |
the document should be discussed on the ns-developers@@isi.edu mailing list. |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
40 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
41 |
This software is free software; you can redistribute it and/or modify |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
42 |
it under the terms of the GNU General Public License as published by |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
43 |
the Free Software Foundation; either version 2 of the License, or |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
44 |
(at your option) any later version. |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
45 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
46 |
This software is distributed in the hope that it will be useful, |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
47 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
48 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
49 |
GNU General Public License for more details. |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
50 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
51 |
You should have received a copy of the GNU General Public License |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
52 |
along with this program. If not, see @uref{http://www.gnu.org/licenses/}. |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
53 |
@end copying |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
54 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
55 |
@titlepage |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
56 |
@title ns-3 Reference Manual |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
57 |
@author ns-3 project |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
58 |
@author feedback: ns-developers@@isi.edu |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
59 |
@today{} |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
60 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
61 |
@c @page |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
62 |
@vskip 0pt plus 1filll |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
63 |
@insertcopying |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
64 |
@end titlepage |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
65 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
66 |
@c So the toc is printed at the start. |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
67 |
@anchor{Full Table of Contents} |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
68 |
@contents |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
69 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
70 |
@ifnottex |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
71 |
@node Top, Overview, Full Table of Contents |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
72 |
@top ns-3 Manual (html version) |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
73 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
74 |
For a pdf version of this manual, |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
75 |
see @uref{http://www.nsnam.org/docs/manual.pdf}. |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
76 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
77 |
@insertcopying |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
78 |
@end ifnottex |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
79 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
80 |
@menu |
3314
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
81 |
* Random variables:: |
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
82 |
* Callbacks:: |
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
83 |
* Attributes:: |
3986
44d4f4d768dd
Add new objects chapter to manual
Tom Henderson <tomh@tomh.org>
parents:
3979
diff
changeset
|
84 |
* Object model:: |
3708
2ecac911b3ec
Add chapter on realtime scheduler to manual
Tom Henderson <tomh@tomh.org>
parents:
3707
diff
changeset
|
85 |
* RealTime:: |
3986
44d4f4d768dd
Add new objects chapter to manual
Tom Henderson <tomh@tomh.org>
parents:
3979
diff
changeset
|
86 |
* Emulation:: |
3314
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
87 |
* Packets:: |
3274
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
88 |
* Sockets APIs:: |
3362
9a6f1b3c6e0b
chapter on Node and internet stack, for manual
Tom Henderson <tomh@tomh.org>
parents:
3314
diff
changeset
|
89 |
* Node and Internet Stack:: |
3707 | 90 |
* TCP:: |
3314
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
91 |
* Routing overview:: |
4024
dfd0bc16dc99
add device chapters to manual
Tom Henderson <tomh@tomh.org>
parents:
3986
diff
changeset
|
92 |
* Wifi NetDevice:: |
dfd0bc16dc99
add device chapters to manual
Tom Henderson <tomh@tomh.org>
parents:
3986
diff
changeset
|
93 |
* CSMA NetDevice:: |
dfd0bc16dc99
add device chapters to manual
Tom Henderson <tomh@tomh.org>
parents:
3986
diff
changeset
|
94 |
* PointToPoint NetDevice:: |
3986
44d4f4d768dd
Add new objects chapter to manual
Tom Henderson <tomh@tomh.org>
parents:
3979
diff
changeset
|
95 |
* Troubleshooting:: |
3274
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
96 |
@end menu |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
97 |
|
3314
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
98 |
@include random.texi |
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
99 |
@include callbacks.texi |
27443ac75474
Add chapter on random numbers to manual
Tom Henderson <tomh@tomh.org>
parents:
3274
diff
changeset
|
100 |
@include attributes.texi |
3986
44d4f4d768dd
Add new objects chapter to manual
Tom Henderson <tomh@tomh.org>
parents:
3979
diff
changeset
|
101 |
@include objects.texi |
3708
2ecac911b3ec
Add chapter on realtime scheduler to manual
Tom Henderson <tomh@tomh.org>
parents:
3707
diff
changeset
|
102 |
@include realtime.texi |
3979
dee10444d76e
some words about emulation
Craig Dowell <craigdo@ee.washington.edu>
parents:
3708
diff
changeset
|
103 |
@include emulation.texi |
3274
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
104 |
@include packets.texi |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
105 |
@include sockets.texi |
3362
9a6f1b3c6e0b
chapter on Node and internet stack, for manual
Tom Henderson <tomh@tomh.org>
parents:
3314
diff
changeset
|
106 |
@include node.texi |
3274
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
107 |
@c @include output.texi |
3707 | 108 |
@include tcp.texi |
3274
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
109 |
@include routing.texi |
4024
dfd0bc16dc99
add device chapters to manual
Tom Henderson <tomh@tomh.org>
parents:
3986
diff
changeset
|
110 |
@include wifi.texi |
dfd0bc16dc99
add device chapters to manual
Tom Henderson <tomh@tomh.org>
parents:
3986
diff
changeset
|
111 |
@include csma.texi |
dfd0bc16dc99
add device chapters to manual
Tom Henderson <tomh@tomh.org>
parents:
3986
diff
changeset
|
112 |
@include point-to-point.texi |
3274
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
113 |
@c @include other.texi |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
114 |
@include troubleshoot.texi |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
115 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
116 |
@printindex cp |
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
117 |
|
eaa3a345b05e
Split out non-tutorial sections from tutorial; place into a doc/manual directory
Tom Henderson <tomh@tomh.org>
parents:
diff
changeset
|
118 |
@bye |