sys/man/8/ppp

   1 .TH PPP 8
   2 .SH NAME
   3 ppp, pppoe, pptp, pptpd \- point-to-point protocol
   4 .SH SYNOPSIS
   5 .B ip/ppp
   6 [
   7 .B -CPSacdfu
   8 ] [
   9 .B -b
  10 .I baud
  11 ] [
  12 .B -k
  13 .I keyspec
  14 ] [
  15 .B -m
  16 .I mtu
  17 ] [
  18 .B -M
  19 .I chatfile
  20 ] [
  21 .B -p
  22 .I dev
  23 ] [
  24 .B -x
  25 .I netmntpt
  26 ] [
  27 .B -t
  28 .I modemcmd
  29 ] [
  30 .I local
  31 [
  32 .I remote
  33 ] ]
  34 .PP
  35 .B ip/pppoe
  36 [
  37 .B -PdcC
  38 ]
  39 [
  40 .B -A
  41 .I acname
  42 ]
  43 [
  44 .B -S
  45 .I srvname
  46 ]
  47 [
  48 .B -k
  49 .I keyspec
  50 ]
  51 [
  52 .B -m
  53 .I mtu
  54 ]
  55 [
  56 .B -b
  57 .I baud
  58 ]
  59 [
  60 .B -x
  61 .I pppnetmntpt
  62 ]
  63 [
  64 .I ether
  65 ]
  66 .PP
  67 .B ip/pptp
  68 [
  69 .B -dP
  70 ]
  71 [
  72 .B -k
  73 .I keyspec
  74 ]
  75 [
  76 .B -w
  77 .I window
  78 ]
  79 [
  80 .B -x
  81 .I pppnetmntpt
  82 ]
  83 .I server
  84 .PP
  85 .B ip/pptpd
  86 [
  87 .B -d
  88 ] [
  89 .B -p
  90 .I pppnetmtpt
  91 ] [
  92 .B -w
  93 .I window
  94 ] [
  95 .B -D
  96 .I fraction
  97 ]
  98 .I tcp-dir
  99 .SH DESCRIPTION
 100 The Point-to-Point Protocol is used to encapsulate Internet Protocol packets
 101 in IPv4 packets
 102 for transfer over serial lines or other protocol connections.
 103 .I Ppp
 104 can run either as a client or, with the
 105 .I \-S
 106 option, as a server.  The only differences between a client and a server is
 107 that the server will not believe any local address the client tries to
 108 supply it and that the server always initiates the authentication of the
 109 client.
 110 .PP
 111 With no option,
 112 .I ppp
 113 communicates with the remote system via standard input and output.
 114 This is useful if a program wants to use
 115 .I ppp
 116 in a communications stream.  However, the normal mode is to
 117 specify a communications device, usually a serial line with a modem.
 118 .PP
 119 .I Ppp
 120 supports the following options:
 121 .TP 3
 122 .B a
 123 as server, don't request authentication from the client
 124 .TP
 125 .B b
 126 set the baud rate on the communications device
 127 .TP
 128 .B c
 129 disallow packet compression
 130 .TP
 131 .B C
 132 disallow IP header compression
 133 .TP
 134 .B f
 135 make PPP add HDLC framing.  This is necessary when using
 136 PPP over a serial line or a TCP connection
 137 .TP
 138 .B k
 139 add
 140 .I keyspec
 141 to the
 142 .IR factotum (4)
 143 key pattern when looking for a user name and password
 144 for authentication.
 145 .TP
 146 .B m
 147 set the maximum transfer unit (default 1450)
 148 .TP
 149 .B M
 150 chat with the modem as specified in the chat file.  Each line in
 151 the chat file contains a string that is transmitted to the modem
 152 and the response expected (e.g. 'AT' 'OK')
 153 .TP
 154 .B P
 155 use this as the primary IP interface; set the default
 156 route through this interface and write its configuration
 157 to
 158 .B /net/ndb
 159 .TP
 160 .B p
 161 communicate over
 162 .I dev
 163 instead of standard I/O
 164 .TP
 165 .B S
 166 run as a server
 167 .TP
 168 .B t
 169 before starting the PPP protocol, write
 170 .I modemcmd
 171 to the device
 172 .TP
 173 .B u
 174 before starting the PPP protocol with the remote end, shuttle
 175 bytes between the device and standard I/O until an EOF on standard
 176 input.  This allows a user to start
 177 .I ppp
 178 and then type commands at a modem before
 179 .I ppp
 180 takes over
 181 .TP
 182 .B x
 183 use the IP stack mounted at
 184 .I netmntpt
 185 .PD
 186 .PP
 187 If both the
 188 .I local
 189 and
 190 .I remote
 191 addresses are specified, don't ask the other end for either
 192 or believe it if it supplies one.  If either is missing, get
 193 it from the remote end.
 194 .PP
 195 .I Pppoe
 196 is a PPP over ethernet (PPPoE) client.
 197 It invokes
 198 .I ppp
 199 to start a PPP conversation which is
 200 tunneled in PPPoE packets on
 201 the ethernet device mounted at
 202 .I etherdir
 203 (default
 204 .BR /net/ether0 ).
 205 The
 206 .IR pppoe -specific
 207 options are:
 208 .TP 3
 209 .B A
 210 insist on an access concentrator named
 211 .I acname
 212 during PPPoE discovery
 213 .TP
 214 .B d
 215 write debugging output to standard error,
 216 and pass
 217 .B -d
 218 to
 219 .I ppp
 220 .TP
 221 .B S
 222 insist on a service named
 223 .I srvname
 224 during PPPoE discovery
 225 .PD
 226 .PP
 227 The other options are relayed to
 228 .IR ppp .
 229 .PP
 230 .I Pptp
 231 is a client for a PPTP encrypted tunnel.
 232 .I Server
 233 is the name of the server to dial.
 234 .I Pptp
 235 takes the same options as
 236 .IR pppoe ,
 237 except for the lack of a
 238 .B -m
 239 option and the addition of a
 240 .B -w
 241 option.
 242 The
 243 .B -w
 244 option specifies the local send window size
 245 (default 16) in packets.
 246 .PP
 247 .I Pptpd
 248 is the server side of a PPTP encrypted tunnel.
 249 .I Tcpdir
 250 is the directory of a TCP connection to the client.
 251 The TCP connection is used to control the tunnel while
 252 packets are sent back and forth using PPP inside of
 253 GRE packets.
 254 The options are:
 255 .TP 3
 256 .B d
 257 write debugging output to standard error.
 258 .TP
 259 .B D
 260 drop
 261 .I fraction
 262 of the received packets.  This is used for testing.
 263 .TP
 264 .B p
 265 use the IP stack mounted at
 266 .I pppnetmtpt
 267 to terminate the PPP connection.
 268 .TP
 269 .B w
 270 set the receive window to
 271 .IR window .
 272 .PD
 273 .SH SOURCE
 274 .B /sys/src/cmd/ip/ppp
 275 .br
 276 .B /sys/src/cmd/ip/pptpd.c
 277 .br
 278 .B /sys/src/cmd/ip/pppoe.c
 279 .SH SEE ALSO
 280 .I gre
 281 in
 282 .IR ip (3)