Return to mpd5.8.in CVS log

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

Annotation of embedaddon/mpd/doc/mpd5.8.in, revision 1.1.1.1

1.1       misho       1: .\"
                      2: .\" Written by Archie Cobbs <archie@freebsd.org>
                      3: .\" Copyright (c) 1995-1999 Whistle Communications, Inc. All rights reserved.
                      4: .\" See ``COPYRIGHT.whistle''
                      5: .\"
                      6: .Dd 2011-12-21
                      7: .Dt MPD5 8
                      8: .Os
                      9: .Sh NAME
                     10: .Nm mpd5
                     11: .Nd netgraph multi-link PPP daemon
                     12: .Sh SYNOPSIS
                     13: .Nm
                     14: .Op Fl bkov
                     15: .Op Fl d Ar directory
                     16: .Op Fl f Ar file
                     17: .Op Fl p Ar pid-file
                     18: .Op Fl s Ar ident
                     19: .Op Ar configuration
                     20: .Sh DESCRIPTION
                     21: .Nm
                     22: is a user mode PPP daemon using the
                     23: .Xr netgraph 4
                     24: networking system.
                     25: By using Netgraph,
                     26: .Nm
                     27: combines the robustness and flexibility of a user-mode PPP implementation
                     28: with the speed and reliability of kernel-mode packet forwarding.
                     29: All PPP negotiation is handled in user level code, while all data
                     30: intensive operations such as encryption, compression, and multi-link
                     31: framing are handled strictly in the kernel.
                     32: Mpd supports several link layer types, a fully event-driven modem chat
                     33: scripting language, and other features.
                     34: .Pp
                     35: .Nm
                     36: creates a
                     37: .Xr ng_ppp 4
                     38: netgraph node that is placed between a
                     39: .Xr ng_iface 4
                     40: netgraph interface one or more link layer devices,
                     41: performing multi-link PPP negotiation and encapsulation. In multi-link PPP a
                     42: .Ar bundle
                     43: is a collection of one or more
                     44: .Ar links 
                     45: between two peers. Each link corresponds to some device (e.g.,
                     46: a modem), and each bundle corresponds to one netgraph interface.
                     47: The idea is to use all of the links, together connected to a remote
                     48: peer also performing multi-link PPP, to utilize their combined
                     49: bandwidth.  Packets routed through the netgraph interface travel in
                     50: multi-link fragments over all of the links.
                     51: Each link is a normal PPP link and can deliver complete packets
                     52: as well, so redundancy is another benefit.
                     53: Attempts to connect two links in the same bundle to different peers,
                     54: or to a peer that is not configured for multi-link PPP, will fail.
                     55: .Pp
                     56: In general, everything is controlled by executing commands which are either
                     57: entered via the console command line or read from a configuration file. If
                     58: .Nm
                     59: is running as a background daemon, the console can be made accessible via
                     60: .Xr telnet 1
                     61: Since commands may apply to a single link, the console prompt always shows the
                     62: .Ar current bundle
                     63: or the
                     64: .Ar current link
                     65: in that bundle. 
                     66: .Sh ON-LINE MANUAL
                     67: Mpd is fully documented in the mpd manual, which is available in HTML.
                     68: The manual can be found in the directory
                     69: .Pa @PREFIX@/share/doc/mpd5 .
                     70: .Sh OPTIONS
                     71: Mpd supports the following command options:
                     72: .Pp
                     73: .Bl -tag -width Ds -compact
                     74: .Pp
                     75: .It Fl b
                     76: .It Fl -background
                     77: .Pp
                     78: Detach from the terminal and run as a background deamon.
                     79: .Pp
                     80: .It Fl d Ar dirname
                     81: .It Fl -directory Ar dirname
                     82: .Pp
                     83: Specify a configuration directory other than the default,
                     84: .Pa @PREFIX@/etc/mpd5 .
                     85: .Pp
                     86: .It Fl f Ar file
                     87: .It Fl -file Ar file
                     88: .Pp
                     89: Specify an initial configuration file other than the default,
                     90: .Pa mpd.conf .
                     91: .Pp
                     92: .It Fl o
                     93: .It Fl -one-shot
                     94: .Pp
                     95: Terminate daemon after the last link shutdown.
                     96: .Pp
                     97: .It Fl p Ar file
                     98: .It Fl -pidfile Ar file
                     99: .Pp
                    100: Specify an lock/process ID storage file other than the default
                    101: .Pa /var/run/mpd.pid .
                    102: .Pp
                    103: .It Fl k
                    104: .It Fl -kill
                    105: .Pp
                    106: Kill any existing
                    107: .Nm
                    108: daemon currently running. The same pidfile must be used.
                    109: .Pp
                    110: .It Fl s Ar ident
                    111: .It Fl -syslog-ident Ar ident
                    112: .Pp
                    113: Identifier to use for
                    114: .Xr syslog 3 .
                    115: .Pp
                    116: .It Fl v
                    117: .It Fl -version
                    118: .Pp
                    119: Display the program version and exit.
                    120: .Pp
                    121: .It Fl h
                    122: .It Fl -help
                    123: .Pp
                    124: Display invocation usage and exit.
                    125: .El
                    126: .Sh FILES
                    127: .Bl -tag -width /usr/local/share/doc/mpdXX -compact
                    128: .It Pa @PREFIX@/share/doc/mpd5
                    129: Directory containing the mpd manual
                    130: .It Pa @PREFIX@/etc/mpd5
                    131: Default configuration file directory
                    132: .It Pa mpd.conf
                    133: Configuration file
                    134: .It Pa mpd.script
                    135: Modem chat scripts
                    136: .It Pa mpd.secret
                    137: Account name, password pairs
                    138: .It Pa /var/run/mpd.pid
                    139: Stored process ID and lock file
                    140: .El
                    141: .Sh SEE ALSO
                    142: .Xr netgraph 4 ,
                    143: .Xr ngctl 8 ,
                    144: .Xr ng_ppp 4 ,
                    145: .Xr ng_iface 4 ,
                    146: .Xr ppp 8 ,
                    147: .Xr pppd 8 .
                    148: .Sh AUTHORS
                    149: .An Archie Cobbs Aq archie@FreeBSD.org
                    150: .An Alexander Motin Aq mav@FreeBSD.org
                    151: .An based on ppp daemon written by Toshiharu OHNO Aq tony-o@iij.ad.jp