pptpd.8 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  1. .TH PPTPD 8 "29 December 2005"
  2. .SH NAME
  3. pptpd - PPTP VPN daemon
  4. .SH SYNOPSIS
  5. .PP
  6. .B pptpd
  7. [
  8. .IR options
  9. ]
  10. .SH DESCRIPTION
  11. .B pptpd
  12. is the Poptop PPTP daemon, which manages tunnelled PPP connections
  13. encapsulated in GRE using the PPTP VPN protocol. It may contain
  14. features like IP address management and TCP wrappers if compiled in.
  15. .SH OPTIONS
  16. Here we document the command line options. See
  17. .BR pptpd.conf (5)
  18. for configuration directives, IP address allocation, routing, and
  19. firewall rules.
  20. .TP
  21. \fB-b\fR|\fB--bcrelay \fIinternal-interface
  22. specifies that broadcasts received on the server's internal
  23. network interface should be relayed to the clients.
  24. .TP
  25. \fB-c\fR|\fB--conf \fIconf-file
  26. specifies the configuration file for
  27. .B pptpd
  28. (default
  29. .IR /etc/pptpd.conf )
  30. .TP
  31. .BR -d | --debug
  32. turns on debugging mode, causing more debugging messages to be sent
  33. to syslog.
  34. .TP
  35. \fB-e\fR|\fB--ppp \fIpppd-program
  36. use
  37. .I pppd-program
  38. in place of the default
  39. .BR pppd (8).
  40. .TP
  41. .BR -f | --fg
  42. run in the foreground instead of detaching from terminal
  43. .TP
  44. .BR -h | --help
  45. display program usage.
  46. .TP
  47. .BR -i | --noipparam
  48. do not send the client's IP address to ip-up scripts (required if you are using the
  49. .BR pppd (8)
  50. .I ipparam
  51. option for some other purpose).
  52. .TP
  53. \fB-l\fR|\fB--listen \fIx.x.x.x
  54. specifies the local interface IP address to listen on.
  55. .TP
  56. \fB-o\fR|\fB--option \fIppp-conf-file
  57. specifies that pptpd should specify an alternate configuration file
  58. for the ppp daemon (the default is normally
  59. .I /etc/ppp/options
  60. but may vary depending on your ppp daemon).
  61. .TP
  62. \fB-p\fR|\fB--pidfile \fIpid-file
  63. specifies an alternate location to store the process ID file (default
  64. .IR /var/run/pptpd.pid ).
  65. .TP
  66. \fB-s\fR|\fB--speed \fIbaud
  67. specifies that the speed
  68. .I baud
  69. should be passed to the ppp daemon as the tty speed to use (in some
  70. cases this is ignored by the ppp daemon).
  71. .TP
  72. \fB-t\fR|\fB--stimeout \fIseconds
  73. specifies the number of seconds to wait for the first packet before
  74. dropping the connection. This is a denial of service protection
  75. feature.
  76. .TP
  77. .BR -w | --logwtmp
  78. update
  79. .BR wtmp (5)
  80. as users connect and disconnect. See
  81. .BR wtmp (1).
  82. .TP
  83. \fB-C\fR|\fB--connections \fIn
  84. limits the number of client connections that may be accepted. Corresponds to the
  85. .BR connections
  86. option in
  87. .IR pptpd.conf .
  88. If pptpd is allocating IP addresses (e.g.
  89. .BR --delegate
  90. is not used) then the number of connections is also limited by the
  91. .BR remoteip
  92. option in
  93. .IR pptpd.conf .
  94. .TP
  95. .BR -D | --delegate
  96. delegates the allocation of client IP addresses to
  97. .BR pppd (8).
  98. Without this option, which is the default, pptpd manages the list of
  99. IP addresses for clients and passes the next free address to pppd.
  100. With this option, pptpd does not pass an address, and so pppd may use
  101. radius or chap-secrets to allocate an address.
  102. .TP
  103. \fB-V\fR|\fB--vrf \fIvrf-name
  104. specifies the VRF to be used for listening in.
  105. .TP
  106. .BR -v | --version
  107. displays the current version of the pptp daemon.
  108. .SH FILES
  109. /etc/pptpd.conf
  110. .br
  111. /var/run/pptpd.pid
  112. .SH DEBUGGING
  113. To turn on debugging, add 'debug' to /etc/pptpd.conf and your
  114. PPP options file, and restart pptpd.
  115. .br
  116. .LP
  117. Typically the PPP options file is options.pptpd in /etc/ppp, though on
  118. some distributions it may be pptpd-options. Use your package manager
  119. to find it, e.g. 'rpm -ql pptpd | grep options' or 'dpkg --listfiles
  120. pptpd | grep options'.
  121. .br
  122. .LP
  123. You may need to configure syslogd to catch debug messages. e.g. edit
  124. /etc/syslog.conf and add something similar to the example below, then
  125. restart syslogd.
  126. .br
  127. .LP
  128. # debug logging
  129. .br
  130. *.debug;mail.none /var/log/debug
  131. .br
  132. .LP
  133. This will log all debug information, except mail, to the file
  134. /var/log/debug. Note that this is a lot of information and might
  135. flood your disks. If performance is an issue, you can try turning off
  136. sync during your debugging, by prefixing the destination with '-'.
  137. .br
  138. .LP
  139. # debug logging
  140. .br
  141. *.debug;mail.none -/var/log/debug
  142. .br
  143. .LP
  144. Disable this line and restart syslog after you are done debugging.
  145. See the syslog man pages for more details.
  146. .br
  147. .LP
  148. .SH AUTHORS
  149. Poptop is written by Matthew Ramsay <matthewr@moreton.com.au>, David Luyer
  150. <luyer@ucs.uwa.edu.au>, Kevin Thayer <tmk@netmagic.net>, Peter Galbavy
  151. <Peter.Galbavy@knowledge.com> and others. Development has been moved to
  152. SourceForge and worked on by Richard de Vroede <r.devroede@linvision.com>
  153. since June 26, 2002.
  154. .SH COPYRIGHT
  155. Copyright \(co 1999 Matthew Ramsay and others.
  156. .LP
  157. Poptop is free software; you can redistribute it and/or modify it under
  158. the terms of the GNU General Public License as published by the Free
  159. Software Foundation; either version 2, or (at your option) any later
  160. version.
  161. .LP
  162. Poptop is distributed in the hope that it will be useful, but WITHOUT ANY
  163. WARRANTY; without even the implied warranty of MERCHANTABILITY or
  164. FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  165. for more details.
  166. .LP
  167. You should have received a copy of the GNU General Public License along
  168. with Poptop; see the file COPYING. If not, write to the Free Software
  169. Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  170. .SH AVAILABILITY
  171. The most recent version of Poptop is available for download from
  172. SourceForge at
  173. .IR http://sourceforge.net/projects/poptop .
  174. .SH "SEE ALSO"
  175. .BR pppd (8),
  176. .BR pptpd (8),
  177. .BR pptpd.conf (5).