summaryrefslogtreecommitdiff
path: root/usr.sbin/mrouted/mrouted.8
diff options
context:
space:
mode:
authorAaron Campbell <aaron@cvs.openbsd.org>1999-06-05 22:18:38 +0000
committerAaron Campbell <aaron@cvs.openbsd.org>1999-06-05 22:18:38 +0000
commitbf95f4749485653fcbff0be73db299a9d226d4e0 (patch)
treec6c5c04d21e0e72753029e3a35290bfd754626a1 /usr.sbin/mrouted/mrouted.8
parentb64780a41e3237fc72bbc817e8c4cdccc40271dd (diff)
remove trailing whitespace, some Nm cleanup
Diffstat (limited to 'usr.sbin/mrouted/mrouted.8')
-rw-r--r--usr.sbin/mrouted/mrouted.888
1 files changed, 44 insertions, 44 deletions
diff --git a/usr.sbin/mrouted/mrouted.8 b/usr.sbin/mrouted/mrouted.8
index 33d6a631b7d..fb9f82adc3d 100644
--- a/usr.sbin/mrouted/mrouted.8
+++ b/usr.sbin/mrouted/mrouted.8
@@ -5,26 +5,26 @@
.SH NAME
mrouted \- IP multicast routing daemon
.SH SYNOPSIS
-.B mrouted
+.B mrouted
[
.B \-p
] [
-.B \-c
+.B \-c
.I config_file
] [
-.B \-d
-[
+.B \-d
+[
.I debug_level
]]
.SH DESCRIPTION
-.I Mrouted
+.I Mrouted
is an implementation of the Distance-Vector Multicast Routing
Protocol (DVMRP), an earlier version of which is specified in RFC-1075.
It maintains topological knowledge via a distance-vector routing protocol
(like RIP, described in RFC-1058), upon which it implements a multicast
datagram forwarding algorithm called Reverse Path Multicasting.
.PP
-.I Mrouted
+.I Mrouted
forwards a multicast datagram along a shortest (reverse) path tree
rooted at the subnet on which the datagram originates. The multicast
delivery tree may be thought of as a broadcast delivery tree that has
@@ -35,55 +35,55 @@ multicast group. The IP time-to-live of a multicast datagram can be
used to limit the range of multicast datagrams.
.PP
In order to support multicasting among subnets that are separated by (unicast)
-routers that do not support IP multicasting,
-.I mrouted
+routers that do not support IP multicasting,
+.I mrouted
includes support for
-"tunnels", which are virtual point-to-point links between pairs of
+"tunnels", which are virtual point-to-point links between pairs of
.IR mrouted s
located anywhere in an internet. IP multicast packets are encapsulated for
transmission through tunnels, so that they look like normal unicast datagrams
-to intervening routers and subnets. The encapsulation
+to intervening routers and subnets. The encapsulation
is added on entry to a tunnel, and stripped off
on exit from a tunnel.
By default, the packets are encapsulated using the IP-in-IP protocol
(IP protocol number 4).
-Older versions of
+Older versions of
.I mrouted
tunnel using IP source routing, which puts a heavy load on some
types of routers.
This version does not support IP source route tunnelling.
.PP
-The tunnelling mechanism allows
-.I mrouted
+The tunnelling mechanism allows
+.I mrouted
to establish a virtual internet, for
the purpose of multicasting only, which is independent of the physical
internet, and which may span multiple Autonomous Systems. This capability
is intended for experimental support of internet multicasting only, pending
widespread support for multicast routing by the regular (unicast) routers.
-.I Mrouted
+.I Mrouted
suffers from the well-known scaling problems of any distance-vector
routing protocol, and does not (yet) support hierarchical multicast routing.
.PP
-.I Mrouted
+.I Mrouted
handles multicast routing only; there may or may not be unicast routing
-software running on the same machine as
+software running on the same machine as
.IR mrouted .
With the use of tunnels, it
-is not necessary for
-.I mrouted
+is not necessary for
+.I mrouted
to have access to more than one physical subnet
in order to perform multicast forwarding.
.br
.ne 5
.SH INVOCATION
.PP
-If no "\-d" option is given, or if the debug level is specified as 0,
+If no "\-d" option is given, or if the debug level is specified as 0,
.I mrouted
detaches from the invoking terminal. Otherwise, it remains attached to the
invoking terminal and responsive to signals from that terminal. If "\-d" is
given with no argument, the debug level defaults to 2. Regardless of the
-debug level,
-.I mrouted
+debug level,
+.I mrouted
always writes warning and error messages to the system
log daemon. Non-zero debug levels have the following effects:
.IP "level 1"
@@ -98,7 +98,7 @@ arrivals and departures are printed to stderr.
Upon startup, mrouted writes its pid to the file /var/run/mrouted.pid .
.SH CONFIGURATION
.PP
-.I Mrouted
+.I Mrouted
automatically configures itself to forward on all multicast-capable
interfaces, i.e., interfaces that have the IFF_MULTICAST flag set (excluding
the loopback "interface"), and it finds other
@@ -140,7 +140,7 @@ options may be specified as many times as necessary.
The phyint command can be used to disable multicast routing on the physical
interface identified by local IP address <local-addr>, or to associate a
non-default metric or threshold with the specified physical interface.
-The local IP address <local-addr> may be replaced by the
+The local IP address <local-addr> may be replaced by the
interface name (e.g le0).
If a phyint is attached to multiple IP subnets, describe each additional subnet
with the altnet keyword.
@@ -157,7 +157,7 @@ The tunnel must be set
up in the mrouted.conf files of both routers before it can be used.
'\"For backwards compatibility with older
'\".IR mrouted s,
-'\"the srcrt keyword specifies
+'\"the srcrt keyword specifies
'\"encapsulation using IP source routing.
.PP
The cache_lifetime is a value that determines the amount of time that a
@@ -166,9 +166,9 @@ entry should lie between 300 (5 min) and 86400 (1 day). It defaults to 300.
.PP
The pruning <off/on> option is provided for
.IR mrouted
-to act as a non-pruning router. It is also possible to start
+to act as a non-pruning router. It is also possible to start
.IR mrouted
-in a non-pruning mode using the "-p" option on the command line. It is
+in a non-pruning mode using the "-p" option on the command line. It is
expected that a router would be configured in this manner for test
purposes only. The default mode is pruning enabled.
.PP
@@ -179,7 +179,7 @@ can accept either a name or a boundary.
The metric is the "cost" associated with sending a datagram on the given
interface or tunnel; it may be used to influence the choice of routes.
The metric defaults to 1. Metrics should be kept as small as possible,
-because
+because
.I mrouted
cannot route along paths with a sum of metrics greater
than 31.
@@ -195,7 +195,7 @@ In general, all
connected to a particular subnet or tunnel should
use the same metric and threshold for that subnet or tunnel.
.PP
-The rate_limit option allows the network administrator to specify a
+The rate_limit option allows the network administrator to specify a
certain bandwidth in Kbits/second which would be allocated to multicast
traffic. It defaults to 500Kbps on tunnels, and 0 (unlimited) on physical
interfaces.
@@ -210,7 +210,7 @@ a name or a boundary spec.
will not initiate execution if it has fewer than two enabled vifs,
where a vif (virtual interface) is either a physical multicast-capable
interface or a tunnel. It will log a warning if all of its vifs are
-tunnels; such an
+tunnels; such an
.I mrouted
configuration would be better replaced by more
direct tunnels (i.e., eliminate the middle man).
@@ -255,7 +255,7 @@ tunnel 192.168.5.4 10.11.12.13 metric 1 threshold 32
.fi
.SH SIGNALS
.PP
-.I Mrouted
+.I Mrouted
responds to the following signals:
.IP HUP
restarts
@@ -272,8 +272,8 @@ dumps the internal routing tables to /var/tmp/mrouted.dump.
dumps the internal cache tables to /var/tmp/mrouted.cache.
.IP QUIT
dumps the internal routing tables to stderr (only if
-.I mrouted
-was invoked with a non-zero debug level).
+.I mrouted
+was invoked with a non-zero debug level).
.PP
For convenience in sending signals,
.I mrouted
@@ -293,13 +293,13 @@ Virtual Interface Table
pkts out: 2322323
1 36.11.0.1 subnet: 36.11 1 1 querier
- groups: 224.0.2.1
- 224.0.1.0
- 224.0.0.4
+ groups: 224.0.2.1
+ 224.0.1.0
+ 224.0.0.4
pkts in: 345
pkts out: 3456
- 2 36.2.0.8 tunnel: 36.8.0.77 3 1
+ 2 36.2.0.8 tunnel: 36.8.0.77 3 1
peers: 36.8.0.77 (2.2)
boundaries: 239.0.1
: 239.1.2
@@ -321,7 +321,7 @@ Multicast Routing Table (1136 entries)
In this example, there are four vifs connecting to two subnets and two
tunnels. The vif 3 tunnel is not in use (no peer address). The vif 0 and
vif 1 subnets have some groups present; tunnels never have any groups. This
-instance of
+instance of
.I mrouted
is the one responsible for sending periodic group
membership queries on the vif 0 and vif 1 subnets, as indicated by the
@@ -339,9 +339,9 @@ origin, and a multicast datagram from that origin will be forwarded on that
outgoing vif only if there are members of the destination group on that leaf.
.bp
.PP
-.I Mrouted
+.I Mrouted
also maintains a copy of the kernel forwarding cache table. Entries
-are created and deleted by
+are created and deleted by
.I mrouted.
.PP
The cache tables look like this:
@@ -349,17 +349,17 @@ The cache tables look like this:
Multicast Routing Cache Table (147 entries)
Origin Mcast-group CTmr Age Ptmr IVif Forwvifs
- 13.2.116/22 224.2.127.255 3m 2m - 0 1
+ 13.2.116/22 224.2.127.255 3m 2m - 0 1
>13.2.116.19
>13.2.116.196
- 138.96.48/21 224.2.127.255 5m 2m - 0 1
+ 138.96.48/21 224.2.127.255 5m 2m - 0 1
>138.96.48.108
- 128.9.160/20 224.2.127.255 3m 2m - 0 1
+ 128.9.160/20 224.2.127.255 3m 2m - 0 1
>128.9.160.45
- 198.106.194/24 224.2.135.190 9m 28s 9m 0P
+ 198.106.194/24 224.2.135.190 9m 28s 9m 0P
>198.106.194.22
-.fi
+.fi
Each entry is characterized by the origin subnet number and mask and the
destination multicast group. The 'CTmr' field indicates the lifetime
of the entry. The entry is deleted from the cache table