1PPTP(8)                     System Manager's Manual                    PPTP(8)
2
3
4

NAME

6       pptp - PPTP driver
7

SYNOPSIS

9       pptp <pptp-server-IP> <pptp-options> [ppp-options] ...
10

DESCRIPTION

12       pptp  establishes  the  client  side of a Virtual Private Network (VPN)
13       using the Point-to-Point Tunneling Protocol (PPTP).  Use  this  program
14       to  connect  to  an  employer's PPTP based VPN, or to certain cable and
15       ADSL service providers.
16
17       By default, pptp establishes the PPTP call to the PPTP server, and then
18       starts  an instance of pppd to manage the data transfer.  However, pptp
19       can also be run as a connection manager within pppd.
20

OPTIONS

22       The first non-option argument on the pptp command line must be the host
23       name or IP address of the PPTP server.
24
25       All  long options (starting with "--") are interpreted as pptp options,
26       and a fatal error occurs if an unrecognised option is used.
27
28       All command-line arguments which do not start with "-" are  interpreted
29       as  ppp  options,  and  passed  as  is to pppd unless --nolaunchpppd is
30       given.
31
32       --phone <number>
33              Pass <number> to remote host as phone number
34
35       --nolaunchpppd
36              Do not launch pppd but use stdin as the network connection.  Use
37              this flag when including pptp as a pppd connection process using
38              the pty option.  See EXAMPLES.
39
40       --quirks <quirk>
41              Work around a buggy PPTP  implementation,  adopts  special  case
42              handling for particular PPTP servers and ADSL modems.  Currently
43              recognised values are BEZEQ_ISRAEL only
44
45       --debug
46              Run in foreground (for debugging with gdb)
47
48       --sync Enable Synchronous HDLC (pppd must use it too)
49
50       --timeout <secs>
51              Time to wait for reordered packets (0.01 to 10 secs)
52
53       --nobuffer
54              Completely disables buffering and reordering  of  packets.   Any
55              --timeout specified will be ignored.
56
57       --idle-wait <secs>
58              Time  to  wait before sending a control connection echo request.
59              The RFC2637 default is 60 seconds.
60
61       --max-echo-wait <secs>
62              Time to wait for an echo reply before closing the  control  con‐
63              nection.  The RFC2637 default is 60 seconds.
64
65       --logstring <name>
66              Use <name> instead of 'anon' in syslog messages
67
68       --localbind <addr>
69              Bind to specified IP address instead of wildcard
70
71       --loglevel <level>
72              Sets the debugging level (0=low, 1=default, 2=high)
73
74

QUIRKS

76       BEZEQ_ISRAEL
77              modifies  packets to interoperate with Orckit ADSL modems on the
78              BEZEQ network in Israel.
79
80

EXAMPLES

82       Connection to a Microsoft Windows VPN Server
83
84        pppd noauth nobsdcomp nodeflate mppe-40 mppe-128  mppe-stateless  name
85       domain\\\\username remotename PPTP require-chapms-v2 pty "pptp 10.0.0.5
86       --nolaunchpppd"
87
88       Note that the chap-secrets file used by pppd must include an entry  for
89       domain\\username
90
91

STATISTICS

93       The  pptp  process  collects  statistics when sending and receiving GRE
94       packets. They are intended to be useful for debugging poor PPTP perfor‐
95       mance  and  for  general monitoring of link quality. The statistics are
96       cumulative since the pptp process was started.
97
98       The statistics can be viewed by sending a SIGUSR1 signal to  the  "GRE-
99       to-PPP Gateway" process, which will cause it to dump them to the system
100       logs (at the LOG_NOTICE level). A better way to present the  statistics
101       to applications is being sought (e.g. SNMP?).
102
103       The  following  statistics  are collected at the time of writing (April
104       2003):
105
106       rx accepted
107              the number of GRE packets successfully passed to PPP
108
109       rx lost
110              the number of packets never received, and presumed lost  in  the
111              network
112
113       rx under win
114              the  number of packets which were duplicates or had old sequence
115              numbers (this might be caused by a packet-reordering network  if
116              your reordering timeout is set too low)
117
118       rx over win
119              the  number  of packets which were too far ahead in the sequence
120              to be reordered (might be caused by loss of more than 300  pack‐
121              ets in a row)
122
123       rx buffered
124              the number of packets which were slightly ahead of sequence, and
125              were either buffered for reordering, or  if  buffering  is  dis‐
126              abled, accepted immediately (resulting in the intermediate pack‐
127              ets being discarded).
128
129       rx OS errors
130              the number of times where the operating system reported an error
131              when we tried to read a packet
132
133       rx truncated
134              the  number of times we received a packet which was shorter than
135              the length implied by the GRE header
136
137       rx invalid
138              the number of times we received a packet which  had  invalid  or
139              unsupported  flags  set  in  the header, wrong version, or wrong
140              protocol.
141
142       rx acks
143              the number of pure acknowledgements received (without data). Too
144              many  of these will waste bandwidth, and might be solved by tun‐
145              ing the remote host.
146
147       tx sent
148              the number of GRE packets sent with data
149
150       tx failed
151              the number of packets we tried to send, but the OS  reported  an
152              error
153
154       tx short
155              the  number  of  times  the OS would not let us write a complete
156              packet
157
158       tx acks
159              the number of times we sent a pure ack, without data
160
161       tx oversize
162              the number of times we couldn't send a  packet  because  it  was
163              over PACKET_MAX bytes long
164
165       round trip
166              the estimated round-trip time in milliseconds
167
168

SEE ALSO

170       pppd(8)
171
172       Documentation in /usr/share/doc/pptp
173

AUTHOR

175       This  manual  page  was written by James Cameron <james.cameron@hp.com>
176       from text contributed by Thomas  Quinot  <thomas@debian.org>,  for  the
177       Debian  GNU/Linux  system.  The description of the available statistics
178       was written by Chris Wilson <chris@netservers.co.uk>.
179
180
181
182                                                                       PPTP(8)
Impressum