Switch branches/tags
attic/AccessPointWithIP attic/annotationmanager attic/battery attic/battery2 attic/chatapp attic/delfoi attic/failover-rtp attic/install attic/musolesimobility attic/networkconfig-remainder attic/obstaclemanager attic/olsr-plan attic/router-alert-handling attic/sending-bz attic/sendsync attic/sendsync2 attic/tags attic/tcp_socket_read ext fixes-for-integration integration-gy integration-jm integration-ta integration master topic/ExtSocket topic/ManiAm-IGMP_improvements topic/PcapTrace2 topic/SocketsRTScheduler topic/andersonandrei-bz topic/ansa-changes topic/aodv-fix topic/aodv-validation topic/arp-ip-comm topic/arptutorial topic/authors topic/brand-new-mac topic/bug topic/bugfixes topic/bz-encap-llc-position topic/bz-fixes topic/bz-routingtable topic/codeformatter topic/configurator-fixes topic/environment topic/eth-fix-bz topic/ethtutor topic/ext topic/fixes-for-submodules topic/fixes-ta-opp6 topic/fixes-ta topic/fixes topic/frametransmitted topic/geographicmobility topic/gpsr topic/ieee80211mac topic/ieee802154 topic/igmpv3-orig topic/inet3.4.0-for-ansa topic/inlineunits topic/ipv4configuratortutorial topic/ipv4fixes topic/ipv6fixes topic/ipv6multicast topic/lookupprotocol topic/mac-multicast topic/manual topic/misc-av topic/mobility-av topic/moduleaccess topic/multicast topic/namespace-bz topic/nedcleanup topic/networkinterface topic/networknode topic/newmac_5txqueue topic/newmacwithoutEarlyAck topic/ns3-comparison topic/oldmac-validation topic/opsbremen topic/ospf topic/osx-fingerprint topic/packet-bz topic/pcap_trafgen topic/pim topic/python-experiment topic/queue topic/radio-cuda topic/radio-gnu topic/radio-multipath topic/radio-parallel topic/radio-pathloss topic/reviveoldstuff topic/samples topic/sctp-bz topic/sensornetwork topic/serializers-integration topic/serializers topic/signal topic/site topic/src-ipv4configuratortutorial topic/src-samples topic/src-visualizersamples topic/src-visualizertutorial topic/standardhost topic/statistic topic/submodules topic/swarm-fingerprint-2 topic/swarm-fingerprint topic/tagindexing topic/tags-bz topic/tap-bz topic/tcpfixes topic/tcpsack-fix topic/tcpvideosteaming topic/testfixes topic/thenewmac topic/travis-ta topic/udp-fixes topic/udplite-bz topic/v3.3.0-for_omnetpp5.2 topic/visualizersamples topic/visualizertutorial topic/whatsnew topic/wirelesstutorial-old topic/xmlattr topic/80211bandwidth topic/80211statistics v1.x v2.x v2.0.x v3.x xxxxxxxxxxxxxxxxx
Nothing to show
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
figures
lib
README
ch-80211.rst
ch-802154.rst
ch-adhoc-routing.rst
ch-apps.rst
ch-authors-guide.rst
ch-collecting-results.rst
ch-diffserv.rst
ch-emulation.rst
ch-environment.rst
ch-ethernet.rst
ch-history.rst
ch-instrument-figures.rst
ch-introduction.rst
ch-ipv4.rst
ch-ipv6.rst
ch-lifecycle.rst
ch-mobility.rst
ch-mpls.rst
ch-network-autoconfig.rst
ch-network-interfaces.rst
ch-network-nodes.rst
ch-networks.rst
ch-other-network-protocols.rst
ch-physicallayer.rst
ch-power.rst
ch-ppp.rst
ch-routing.rst
ch-scenario-scripting.rst
ch-sensor-macs.rst
ch-transmission-medium.rst
ch-transport.rst
ch-usage.rst
ch-visualization.rst
index.rst

README

How to build the manual
=======================

Prerequisites
-------------

Linux:

1. Install the 'texlive' package

2a. You may install the 'texlive-science' package, however recent distros still contain
    old 1.x versions of the bytefield package so the buil process may not work.
    (we need 2.x version)

2b. Install the bytefield package manually into a local folder:
    - copy the texmf folder in this directory to your $HOME dir
    - change to your $HOME dir and execute 'texhash texmf'

Windows:

1. Install MiKTex from miktex.org. The "basic" package is enough.
   (pdflatex will download needed extra packages automatically when you
   first build the document).

2. Install Inkscape. It will be used for SVG editing as well as for
   SVG-to-PNG and SVG-to-PDF conversion.


Making PDF output
-----------------
Make sure that <MiKTeX>/miktex/bin is in the path, then type "make pdf".


Graphics
--------
See http://amath.colorado.edu/documentation/LaTeX/reference/figures.html

Screenshots and other raster images should be checked in as PNG, and included
in the LaTeX sources like this:

  \includegraphics[width=60mm]{myfig.png}
  \includegraphics[height=60mm]{myfig.jpg}
  \includegraphics[scale=0.75]{myfig.pdf}
  \includegraphics[angle=45,width=52mm]{myfig.jpg}

Vector graphics should be drawn and checked in in SVG format. This will be
rasterized to PNG (for HTML output) and exported as vector PDF (for PDF output)
using Inkscape command-line options:

  inkscape -e FILENAME  (or --export-png=FILENAME)
  inkscape -A FILENAME  (or --export-pdf=FILENAME)

See http://inkscape.modevia.com/inkscape-man.html for other options (e.g.
-w/-h for specifying bitmap dimensions in pixels).


/Andras