Sync windows versions to Makefile
[olsrd.git] / gui / win32 / Inst / linux-manual.txt
1 olsrd(8)                                                              olsrd(8)\r
2 \r
3 \r
4 \r
5 NAME\r
6        olsrd - Optimized Link State Routing protocol daemon\r
7 \r
8 SYNOPSIS\r
9        olsrd  [  -i   interface1  [interface2  ...]  ] [ -f  configfile ] [ -d\r
10        debuglevel ] [ -ipv6 ] [ -ipc ] [ -dispin ] [ -dispout ]  [  -tnl  ]  [\r
11        -bcast  broadcastaddress ] [ -delgw ] [ -hint  HELLO interval for wire-\r
12        less interfaces ] [ -tcint  TC interval ] [ -midint  MID interval  ]  [\r
13        -hnaint   HNA  interval  ] [ -hhold  HELLO validity time ] [ -thold  TC\r
14        validity time ] [ -tos  TOS value ] [ -nhint  HELLO interval non WLAN ]\r
15        [ -nhhold  HELLO validity time non WLAN ] [ -T  scheduler poll rate ]\r
16 \r
17 \r
18 \r
19 DESCRIPTION\r
20        olsrd is an implementation of the Optimized Link State Routing protocol\r
21        for  Mobile  Ad-Hoc  networks(MANET).  The  protocol  is  described  in\r
22        RFC3626.  It is designed to be run as a standalone server process - but\r
23        as it is still in an experimental stage most users will prefer  running\r
24        it with some debug output which is directed to STDOUT.\r
25 \r
26 \r
27        This  manual page only lists the command line arguments. For details of\r
28        the configuration file see the comments  included  in  /etc/olsrd.conf.\r
29        Note  that  none  of these options need to be set at the command line -\r
30        all these options and others can be set in the configuration file.\r
31 \r
32 \r
33        The homepage of olsrd is http://www.olsr.org\r
34 \r
35 \r
36 OPTIONS\r
37        -i interface1 ... interfaceN\r
38                    This option specifies  on  what  network  interfaces  olsrd\r
39                    should  run.  These interfaces cannot be aliased interfaces\r
40                    such as eth0:1.\r
41 \r
42        -f configfile\r
43                    This option overrides the default configuration  file  path\r
44                    used by olsrd - /etc/olsrd.conf\r
45 \r
46        -d debuglevel\r
47                    This option specifies the amount of debug information olsrd\r
48                    should write to STDOUT. If set to 0 olsrd will run  in  the\r
49                    background.\r
50 \r
51        -ipv6       This  option  instructs  olsrd to use the Internet Protocol\r
52                    version 6. The default is version 4.\r
53 \r
54        -ipc        This option allows the GUI front-end created fro  olsrd  to\r
55                    connect to olsrd at runtime.\r
56 \r
57        -dispin     This option, when set, causes olsrd to display all incoming\r
58                    packet data on STDOUT. When using IPv4  the  data  is  dis-\r
59                    played  in decimal format, when using IPv6 the data is dis-\r
60                    played in hexadecimal format.\r
61 \r
62        -dispout    This option, when set, causes olsrd to display all outgoing\r
63                    packet  data  on  STDOUT.  When using IPv4 the data is dis-\r
64                    played in decimal format, when using IPv6 the data is  dis-\r
65                    played in hexadecimal format.\r
66 \r
67        -tnl        When  this  option is set olsrd will use IP-in-IP tunneling\r
68                    to Internet gateways. This is very experimental code and it\r
69                    should not be used as of yet.\r
70 \r
71        -delgw      If  this option is set olsrd will remove any default routes\r
72                    set prior to adding an Internet route based on  OLSR  rout-\r
73                    ing.\r
74 \r
75        -bcast broadcastaddress\r
76                    This option specifies what IPv4 broadcastaddress to use for\r
77                    OLSR control traffic. The only value that  currently  makes\r
78                    sense   when   setting   broadcast   address  mannually  is\r
79                    255.255.255.255.  The default action is to use  the  broad-\r
80                    castaddres  that  the  network  interface  is preconfigured\r
81                    with(per interface).\r
82 \r
83        -hint seconds\r
84                    This value sets the interval on which HELLO messages should\r
85                    be  generated.  The value is a floating point number repre-\r
86                    senting seconds.\r
87 \r
88        -nhint seconds\r
89                    This value sets the interval on which HELLO messages should\r
90                    be  generated  on  interfaces  that  are not detected to be\r
91                    wireless.  The value is a floating point number  represent-\r
92                    ing seconds.\r
93 \r
94        -tcint seconds\r
95                    This value sets the interval on which TC messages should be\r
96                    generated. The value is a floating point number  represent-\r
97                    ing seconds.\r
98 \r
99        -midint seconds\r
100                    This  value  sets the interval on which MID messages should\r
101                    be generated. The value is a floating point  number  repre-\r
102                    senting seconds.\r
103 \r
104        -hnaint seconds\r
105                    This  value  sets the interval on which HNA messages should\r
106                    be generated. The value is a floating point  number  repre-\r
107                    senting seconds.\r
108 \r
109        -hhold multiplier\r
110                    This  option  sets  the  announced HELLO validity time as a\r
111                    multiplier of the HELLO interval.\r
112 \r
113        -nhhold multiplier\r
114                    This option sets the announced HELLO validity time on  non-\r
115                    WLAN interfaces, as a multiplier of the HELLO interval.\r
116 \r
117        -thold multiplier\r
118                    This option sets the announced TC validity time as a multi-\r
119                    plier of the TC interval.\r
120 \r
121        -tos TOS-value\r
122                    This option sets the type of service value that  should  be\r
123                    set in the OLSR control traffic packet IP headers.\r
124 \r
125        -T seconds  This  option  sets  the polling intervall of the scheduler.\r
126                    The default is 0.1 seconds. This option should only be con-\r
127                    sidered if running with really low emission intervals.\r
128 \r
129 \r
130 \r
131        FILES  /etc/olsrd.conf\r
132 \r
133 SEE ALSO\r
134        iwconfig(8) route(8).\r