release/src/router/pptpd/pptpctrl.8

   1 .TH PPTPCTRL 8 "28 April 2004"
   2 .SH NAME
   3 pptpctrl - PPTP control connection manager
   4 .SH SYNOPSIS
   5 .B pptpctrl
   6 .IR pptp-debug-flag
   7 .IR no-ipparam-flag
   8 .IR ppp-options-value
   9 .IR ppp-speed-value
  10 .IR ppp-local-ip-value
  11 .IR ppp-remote-ip-value
  12 .RB [
  13 .IR pptp-call-id
  14 ]
  15 .RB [
  16 .IR ppp-binary
  17 ]
  18 .RB [
  19 .IR pptp-logwtmp
  20 ]
  21 .SH DESCRIPTION
  22 .B pptpctrl
  23 is usually run by
  24 .BR pptpd (8),
  25 but can also be run from
  26 .BR inetd (8)
  27 if some of the features of
  28 .BR pptpd (8),
  29 such as IP pool management, and inbuilt TCP wrappers, are not required.
  30 .SH OPTIONS
  31 .B pptpctrl
  32 options are unconventional, as they are designed for use by
  33 .BR pptpd (8)
  34 rather than users.  The option order is critical.  Flag options
  35 consist of a 0 or 1, and must be present.  Value options consist of a
  36 0, or a 1 followed by the value.  Either the 0 or both the 1 and the
  37 value must be present.  The remaining options are optional, but must
  38 be present in the defined order.  The options are as follows:
  39 .TP
  40 pptp-debug-flag
  41 if set (1), enables debug messages to syslog from pptpctrl.  This has no
  42 effect on the setting of the PPP debug option.
  43 .TP
  44 no-ipparam-flag
  45 if set,
  46 .B pptpctrl
  47 will not pass the client's IP address to
  48 .BR pppd (8)
  49 using the
  50 .IR ipparam
  51 option.  See the
  52 .IR noipparam
  53 option in
  54 .BR pptpd.conf (5).
  55 .TP
  56 ppp-options-value
  57 file to use for PPP options.  See the
  58 .IR file
  59 option in
  60 .BR pppd (8).
  61 .TP
  62 ppp-speed-value
  63 value for the
  64 .IR speed
  65 option given to
  66 .BR pppd (8).
  67 Note that on Linux, this parameter is ineffective.
  68 .TP
  69 ppp-local-ip-value
  70 if set, specifies the IP address that
  71 .BR pppd (8)
  72 is to use for the network interface on the server.  If not set,
  73 .BR pppd (8)
  74 will determine it based on options; usually it will be the ethernet address of the server.
  75 .TP
  76 ppp-remote-ip-value
  77 if set, specifies the IP address that
  78 .BR pppd (8)
  79 is to use for the network interface on the client.  If not set,
  80 .BR pppd (8)
  81 will determine it based on options; usually it will be the ethernet address of the client, or an address given in
  82 .IR chap-secrets.
  83 Must be set if
  84 .IR ppp-local-ip-value
  85 is set.
  86 .TP
  87 pptp-call-id
  88 if present, specifies the call identification for the PPTP session.  If omitted, the call identification is zero.  Normally the ID is allocated by
  89 .BR pptpd (8)
  90 and passed to pptpctrl.
  91 .TP
  92 ppp-binary
  93 if present, path to the PPP binary to use.  If omitted, the default
  94 value is used.
  95 .TP
  96 pptp-logwtmp
  97 if present, specifies whether
  98 .BR wtmp (5)
  99 should be updated as users connect and disconnect.
 100 .SH FILES
 101 none.
 102 .SH AUTHORS
 103 Poptop is written by Matthew Ramsay <matthewr@moreton.com.au>, David Luyer
 104 <luyer@ucs.uwa.edu.au>, Kevin Thayer <tmk@netmagic.net>, Peter Galbavy
 105 <Peter.Galbavy@knowledge.com> and others. Development has been moved to
 106 SourceForge and worked on by Richard de Vroede <r.devroede@linvision.com>
 107 since June 26, 2002.
 108 .SH COPYRIGHT
 109 Copyright \(co 1999 Matthew Ramsay and others.
 110 .LP
 111 Poptop is free software; you can redistribute it and/or modify it under
 112 the terms of the GNU General Public License as published by the Free
 113 Software Foundation; either version 2, or (at your option) any later
 114 version.
 115 .LP
 116 Poptop is distributed in the hope that it will be useful, but WITHOUT ANY
 117 WARRANTY; without even the implied warranty of MERCHANTABILITY or
 118 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 119 for more details.
 120 .LP
 121 You should have received a copy of the GNU General Public License along
 122 with Poptop; see the file COPYING.  If not, write to the Free Software
 123 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 124 .SH AVAILABILITY
 125 The most recent version of Poptop is available for download from
 126 SourceForge at
 127 .IR http://sourceforge.net/projects/poptop .
 128 .SH "SEE ALSO"
 129 .BR inetd (8),
 130 .BR inetd.conf (5),
 131 .BR pppd (8),
 132 .BR pptpd (8),
 133 .BR pptpd.conf (5),
 134 .BR tcpd (8).