Return to igmpproxy.8.in CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / igmpproxy / doc

Annotation of embedaddon/igmpproxy/doc/igmpproxy.8.in, revision 1.1.1.1

1.1       misho       1: .\" .br - line break (nothing else on the line)
                      2: .\" .B  - bold
                      3: .\" .I  - green or kursive (on HTML)
                      4: .\" .TP - paragraph ? (header line, followed by indented lines)
                      5: .\"
                      6: .TH igmpproxy 8 "" "@PACKAGE_STRING@"
                      7: .SH NAME
                      8: igmpproxy \- Multicast router utilizing IGMP forwarding
                      9: 
                     10: .SH SYNOPSIS
                     11: .B igmpproxy [-h] [-d] [-v [-v]]
                     12: .I config-file
                     13: 
                     14: 
                     15: .SH DESCRIPTION
                     16: .B igmpproxy
                     17: is a simple multicast routing daemon which uses IGMP forwarding to
                     18: dynamically route multicast traffic. Routing is done by defining an
                     19: "upstream" interface on which the daemon act as a normal Multicast
                     20: client, and one or more "downstream" interfaces that serves clients
                     21: on the destination networks. This is useful in situations where other
                     22: dynamic multicast routers (like 'mrouted' or 'pimd') cannot be used.
                     23: 
                     24: Since 
                     25: .B igmpproxy
                     26: only uses IGMP signalling, the daemon is only suited for situations
                     27: where multicast traffic comes from only one neighbouring network.
                     28: In more advanced cases, 'mrouted' or 'pimd' is probably more suited.
                     29: The daemon is not designed for cascading, and probably won't scale
                     30: very well.
                     31: 
                     32: Currently only IGMPv1 and v2 is supported on downstream interfaces.
                     33: On the upstream interface the kernel IGMP client implementation is used,
                     34: and supported IGMP versions is therefore limited to that supported by the
                     35: kernel.
                     36: 
                     37: 
                     38: .SH OPTIONS
                     39: .IP -h
                     40: Display help.
                     41: .IP -v
                     42: Verbose logging. Set logging level to INFO instead of WARNING used by default. 
                     43: .IP -vv
                     44: More verbose logging. Set logging level to DEBUG.
                     45: .IP -d
                     46: Output log messages to STDERR instead of to
                     47: .BR syslog (3).
                     48: 
                     49: 
                     50: .SH LIMITS
                     51: The current version compiles and runs fine with the Linux kernel version 2.4. The known limits are:
                     52: 
                     53: .B Multicast routes:
                     54: more then 200
                     55: 
                     56: .B Multicast group membership:
                     57: max. 20
                     58: .SH FILES
                     59: .TP
                     60: .B /proc/net/ip_mr_cache 
                     61: - contains the active multicast routes
                     62: .TP
                     63: .B /proc/net/ip_mr_vif 
                     64: - contains the 'virtual' interfaces used by the active multicast routing daemon
                     65: .TP
                     66: .B /proc/sys/net/ipv4/conf/<ifname>/force_igmp_version 
                     67: - can be set to control what IGMP version the kernel should use on the upstream interface.
                     68: Ex.: 'echo 2 > /proc/sys/net/ipv4/conf/eth0/force_igmp_version' will force the kernel to
                     69: use IGMPv2 on eth0 (provided this is the upstream interface).
                     70: 
                     71: 
                     72: .SH SEE ALSO
                     73: .BR igmpproxy.conf (5),
                     74: .BR mrouted,
                     75: .BR pimd,
                     76: .BR smcroute
                     77: 
                     78: .SH BUGS
                     79: Currently none (but there probably will be :-/ )
                     80: .SH AUTHOR
                     81: Originally written by Johnny Egeland <johnny@rlo.org>.