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