ppp 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
  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 -CPScdfu
  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. PPP supports the following options:
  116. .TP
  117. .B b
  118. set the baud rate on the communications device
  119. .TP
  120. .B f
  121. make PPP add HDLC framing. This is necessary when using
  122. PPP over a serial line or a TCP connection
  123. .TP
  124. .B k
  125. add
  126. .I keyspec
  127. to the
  128. .IR factotum (4)
  129. key pattern when looking for a user name and password
  130. for authentication; the default key pattern is
  131. .B "proto=pass" "service=ppp"
  132. .TP
  133. .B m
  134. set the maximum transfer unit (default 1450)
  135. .TP
  136. .B P
  137. use this as the primary IP interface; set the default
  138. route through this interface and write its configuration
  139. to
  140. .B /net/ndb
  141. .TP
  142. .B p
  143. communicate over
  144. .I dev
  145. instead of standard I/O
  146. .TP
  147. .B u
  148. before starting the PPP protocol with the remote end, shuttle
  149. bytes between the device and standard I/O until an EOF on standard
  150. input. This allows a user to start
  151. .I ppp
  152. and then type commands at a modem before
  153. .I ppp
  154. takes over
  155. .TP
  156. .B S
  157. run as a server
  158. .TP
  159. .B t
  160. before starting the PPP protocol, write
  161. .I modemcmd
  162. to the device
  163. .TP
  164. .B x
  165. use the IP stack mounted at
  166. .I netmntpt
  167. .TP
  168. .B M
  169. chat with the modem as specified in the chat file. Each line in
  170. the chat file contains a string that is transmitted to the modem
  171. and the response expected (e.g. 'AT' 'OK')
  172. .TP
  173. .B c
  174. disallow packet compression
  175. .TP
  176. .B C
  177. disallow ip header compression
  178. .PD
  179. .PP
  180. If both the
  181. .I local
  182. and
  183. .I remote
  184. addresses are specified, don't ask the other end for either
  185. or believe it if it supplies one. If either is missing, get
  186. it from the remote end.
  187. .PP
  188. .I Pppoe
  189. is a PPP over ethernet (PPPoE) client.
  190. It invokes
  191. .I ppp
  192. to start a PPP conversation which is
  193. tunneled in PPPoE packets on
  194. the ethernet device mounted at
  195. .I etherdir
  196. (default
  197. .BR /net/ether0 ).
  198. The
  199. .I pppoe -specific
  200. options are:
  201. .TP
  202. .B A
  203. insist on an access concentrator named
  204. .I acname
  205. during PPPoE discovery
  206. .TP
  207. .B S
  208. insist on a service named
  209. .I srvname
  210. during PPPoE discovery
  211. .TP
  212. .B d
  213. write debugging output to standard error,
  214. and pass
  215. .B -d
  216. to
  217. .I ppp
  218. .PD
  219. .PP
  220. The other options are relayed to
  221. .IR ppp .
  222. .PP
  223. .I Pptp
  224. is a client for a PPTP encrypted tunnel.
  225. .I Server
  226. is the name of the server to dial.
  227. .I Pptp
  228. takes the same options as
  229. .IR pppoe ,
  230. except for the lack of a
  231. .B -m
  232. option and the addition of a
  233. .B -w
  234. option.
  235. The
  236. .B -w
  237. option specifies the local send window size
  238. (default 16) in packets.
  239. .PP
  240. .I Pptpd
  241. is the server side of a PPTP encrypted tunnel.
  242. .I Tcpdir
  243. is the directory of a TCP connection to the client.
  244. The TCP connection is used to control the tunnel while
  245. packets are sent back and forth using PPP inside of
  246. GRE packets.
  247. The options are:
  248. .TP
  249. .B d
  250. write debugging output to standard error.
  251. .TP
  252. .B p
  253. use the IP stack mounted at
  254. .I pppnetmtpt
  255. to terminate the PPP connection.
  256. .TP
  257. .B w
  258. set the receive window to
  259. .IR window .
  260. .TP
  261. .B D
  262. drop
  263. .I fraction
  264. of the received packets. This is used for testing.
  265. .PD
  266. .SH SOURCE
  267. .B /sys/src/cmd/ip/ppp
  268. .br
  269. .B /sys/src/cmd/ip/pptpd.c
  270. .br
  271. .B /sys/src/cmd/ip/pppoe.c
  272. .SH SEE ALSO
  273. .I gre
  274. in
  275. .IR ip (3)
  276. .SH BUGS
  277. .I Ppp
  278. should use factotum to execute
  279. the client side of the challenge-reponse
  280. protocol, but instead it reads a password
  281. from factotum and runs the protocol itself.