doc/tutorial/in-process/tutorial.texi
changeset 3332 da67e8efa347
parent 3273 8bbd6b509c0f
equal deleted inserted replaced
3331:7305032b6100 3332:da67e8efa347
       
     1 \input texinfo  @c -*-texinfo-*-
       
     2 @c %**start of header
       
     3 @setfilename ns-3.info
       
     4 @settitle ns-3 tutorial
       
     5 @c @setchapternewpage odd
       
     6 @c %**end of header
       
     7 
       
     8 @ifinfo
       
     9 Primary documentation for the @command{ns-3} project is available in
       
    10 three forms:
       
    11 @itemize @bullet
       
    12 @item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen/Manual}:  Documentation of the public APIs of the simulator
       
    13 @item Tutorial (this document)
       
    14 @item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki}
       
    15 @end itemize
       
    16 
       
    17 This document is written in GNU Texinfo and is to be maintained in
       
    18 revision control on the @command{ns-3} code server.  Both PDF and HTML versions
       
    19 should be available on the server.  Changes to 
       
    20 the document should be discussed on the ns-developers@@isi.edu mailing list.
       
    21 @end ifinfo
       
    22 
       
    23 @copying
       
    24 
       
    25 This is an @command{ns-3} tutorial.
       
    26 Primary documentation for the @command{ns-3} project is available in
       
    27 three forms:
       
    28 @itemize @bullet
       
    29 @item @uref{http://www.nsnam.org/doxygen/index.html,,ns-3 Doxygen/Manual}:  Documentation of the public APIs of the simulator
       
    30 @item Tutorial (this document)
       
    31 @item @uref{http://www.nsnam.org/wiki/index.php,, ns-3 wiki}
       
    32 @end itemize
       
    33  
       
    34 This document is written in GNU Texinfo and is to be maintained in
       
    35 revision control on the @command{ns-3} code server.  Both PDF and HTML 
       
    36 versions should be available on the server.  Changes to 
       
    37 the document should be discussed on the ns-developers@@isi.edu mailing list.
       
    38 
       
    39 This software is free software; you can redistribute it and/or modify
       
    40 it under the terms of the GNU General Public License as published by
       
    41 the Free Software Foundation; either version 2 of the License, or
       
    42 (at your option) any later version.
       
    43 
       
    44 This software is distributed in the hope that it will be useful,
       
    45 but WITHOUT ANY WARRANTY; without even the implied warranty of
       
    46 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       
    47 GNU General Public License for more details.
       
    48 
       
    49 You should have received a copy of the GNU General Public License
       
    50 along with this program.  If not, see @uref{http://www.gnu.org/licenses/}.
       
    51 @end copying
       
    52 
       
    53 @titlepage
       
    54 @title ns-3 Tutorial
       
    55 @author ns-3 project
       
    56 @author feedback:  ns-developers@@isi.edu
       
    57 @today{}
       
    58 
       
    59 @c @page
       
    60 @vskip 0pt plus 1filll
       
    61 @insertcopying
       
    62 @end titlepage
       
    63 
       
    64 @c So the toc is printed at the start.
       
    65 @anchor{Full Table of Contents}
       
    66 @contents
       
    67 
       
    68 @ifnottex
       
    69 @node Top, Overview, Full Table of Contents 
       
    70 @top ns-3 Tutorial (html version)
       
    71 
       
    72 For a pdf version of this tutorial, 
       
    73 see @uref{http://www.nsnam.org/docs/tutorial.pdf}.
       
    74 
       
    75 @insertcopying
       
    76 @end ifnottex
       
    77 
       
    78 @menu
       
    79 * Tutorial Goals::
       
    80 Part 1:  Getting Started with ns-3
       
    81 * Overview::
       
    82 * Browsing::
       
    83 * Resources::
       
    84 * Downloading and Compiling::
       
    85 * Some-Prerequisites::
       
    86 Part 2:  Reading ns-3 Programs
       
    87 * A-First-ns-3-Script::
       
    88 Part 3:  Reconfiguring Existing ns-3 Scripts
       
    89 * Logging::
       
    90 * ns-3 Attributes::
       
    91 * Tracing::
       
    92 * Statistics::
       
    93 Part 4:  Creating New or Revised Topologies
       
    94 * Helper Functions::
       
    95 @end menu
       
    96 
       
    97 @include introduction.texi
       
    98 @include log.texi
       
    99 @include attributes.texi
       
   100 @include statistics.texi
       
   101 @include helpers.texi
       
   102 
       
   103 @printindex cp
       
   104 
       
   105 @bye