Annotation of embedaddon/mpd/doc/mpd5.8.in, revision 1.1.1.3
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: .\"
1.1.1.3 ! misho 6: .Dd 2016-01-06
1.1 misho 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
1.1.1.2 misho 19: .Op Fl m Ar service
1.1 misho 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
1.1.1.3 ! misho 61: .Xr telnet 1 .
1.1 misho 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
1.1.1.3 ! misho 66: in that bundle.
! 67: On startup mpd run commands from the
! 68: .Ar startup
! 69: label of config file.
! 70: After that, if
! 71: .Ar configuration
! 72: is supplied, mpd looks config file for a matching label and runs the
! 73: corresponding commands.
! 74: If
! 75: .Ar configuration
! 76: is not supplied, mpd looks for label named
! 77: .Ar default .
1.1 misho 78: .Sh ON-LINE MANUAL
79: Mpd is fully documented in the mpd manual, which is available in HTML.
80: The manual can be found in the directory
81: .Pa @PREFIX@/share/doc/mpd5 .
82: .Sh OPTIONS
83: Mpd supports the following command options:
84: .Pp
85: .Bl -tag -width Ds -compact
86: .Pp
87: .It Fl b
88: .It Fl -background
89: .Pp
90: Detach from the terminal and run as a background deamon.
91: .Pp
92: .It Fl d Ar dirname
93: .It Fl -directory Ar dirname
94: .Pp
95: Specify a configuration directory other than the default,
96: .Pa @PREFIX@/etc/mpd5 .
97: .Pp
98: .It Fl f Ar file
99: .It Fl -file Ar file
100: .Pp
101: Specify an initial configuration file other than the default,
102: .Pa mpd.conf .
103: .Pp
104: .It Fl o
105: .It Fl -one-shot
106: .Pp
107: Terminate daemon after the last link shutdown.
108: .Pp
109: .It Fl p Ar file
110: .It Fl -pidfile Ar file
111: .Pp
112: Specify an lock/process ID storage file other than the default
113: .Pa /var/run/mpd.pid .
114: .Pp
115: .It Fl k
116: .It Fl -kill
117: .Pp
118: Kill any existing
119: .Nm
120: daemon currently running. The same pidfile must be used.
121: .Pp
122: .It Fl s Ar ident
123: .It Fl -syslog-ident Ar ident
124: .Pp
125: Identifier to use for
126: .Xr syslog 3 .
1.1.1.2 misho 127: The default -
128: .Pa mpd
129: .Pp
130: .It Fl m Ar service
131: .It Fl -pam-service Ar service
132: .Pp
133: Service name to use for
134: .Xr pam 3 .
135: The default -
136: .Pa mpd
1.1 misho 137: .Pp
138: .It Fl v
139: .It Fl -version
140: .Pp
141: Display the program version and exit.
142: .Pp
143: .It Fl h
144: .It Fl -help
145: .Pp
146: Display invocation usage and exit.
147: .El
148: .Sh FILES
149: .Bl -tag -width /usr/local/share/doc/mpdXX -compact
150: .It Pa @PREFIX@/share/doc/mpd5
151: Directory containing the mpd manual
152: .It Pa @PREFIX@/etc/mpd5
153: Default configuration file directory
154: .It Pa mpd.conf
155: Configuration file
156: .It Pa mpd.script
157: Modem chat scripts
158: .It Pa mpd.secret
159: Account name, password pairs
160: .It Pa /var/run/mpd.pid
161: Stored process ID and lock file
162: .El
163: .Sh SEE ALSO
164: .Xr netgraph 4 ,
165: .Xr ngctl 8 ,
166: .Xr ng_ppp 4 ,
167: .Xr ng_iface 4 ,
1.1.1.2 misho 168: .Xr ppp 8 .
1.1 misho 169: .Sh AUTHORS
1.1.1.3 ! misho 170: .An Archie Cobbs Aq Mt archie@FreeBSD.org
! 171: .An Alexander Motin Aq Mt mav@FreeBSD.org
! 172: .An based on ppp daemon written by Toshiharu OHNO Aq Mt tony-o@iij.ad.jp
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to mpd5.8.in 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