release/src/router/pptpd/pptpd.8

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