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