OSDN Git Service

2013.10.24
[uclinux-h8/uClinux-dist.git] / user / pptp / pptp.8
1 .\" SH section heading
2 .\" SS subsection heading
3 .\" LP paragraph
4 .\" IP indented paragraph
5 .\" TP hanging label
6 .TH PPTP 8
7 .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
8 .\" other parms are allowed: see man(7), man(1)
9 .SH NAME
10 pptp \- PPTP driver
11 .SH SYNOPSIS
12 .B pptp
13 .I "<pptp-server-IP> <pptp-options> [ppp-options] ..."
14 .SH "DESCRIPTION"
15 .LP
16 .B pptp
17 establishes the client side of a Virtual Private Network (VPN) using
18 the Point-to-Point Tunneling Protocol (PPTP).  Use this program to
19 connect to an employer's PPTP based VPN, or to certain cable and ADSL
20 service providers.
21 .LP
22 By default, \fBpptp\fR establishes the PPTP call to the PPTP server,
23 and then starts an instance of \fBpppd\fR to manage the data transfer.
24 However, \fBpptp\fR can also be run as a connection manager within
25 \fBpppd\fR.
26 .SH OPTIONS
27 .LP
28 The first non\-option argument on the \fBpptp\fR command line must be the host
29 name or IP address of the PPTP server.
30 .LP
31 All long options (starting with "\-\-")
32 are interpreted as pptp options, and a fatal error occurs if an 
33 unrecognised option is used.
34 .LP
35 All command\-line arguments which do not start
36 with "\-" are interpreted as ppp options, and passed as is to \fBpppd\fR unless
37 \fB\-\-nolaunchpppd\fR is given.
38 .TP
39 .B \-\-phone <number>
40 Pass <number> to remote host as phone number
41 .TP
42 .B \-\-nolaunchpppd
43 Do not launch
44 .B pppd
45 but use stdin as the network connection.  Use this flag when including
46 .B pptp
47 as a
48 .B pppd
49 connection process using the
50 .B pty
51 option.  See EXAMPLES.
52 .TP
53 .B \-\-quirks <quirk>
54 Work around a buggy PPTP implementation, adopts special case handling for
55 particular PPTP servers and ADSL modems.
56 Currently recognised values are BEZEQ_ISRAEL only
57 .TP
58 .B \-\-debug
59 Run in foreground (for debugging with gdb)
60 .TP
61 .B \-\-sync
62 Enable Synchronous HDLC (pppd must use it too)
63 .TP
64 .B \-\-timeout <secs>
65 Time to wait for reordered packets (0.01 to 10 secs)
66 .TP
67 .B \-\-nobuffer
68 Completely disables buffering and reordering of packets.
69 Any \-\-timeout specified will be ignored.
70 .TP
71 .B \-\-idle-wait <secs>
72 Time to wait before sending a control connection echo request.
73 The RFC2637 default is 60 seconds.
74 .TP
75 .B \-\-max-echo-wait <secs>
76 Time to wait for an echo reply before closing the control connection.
77 The RFC2637 default is 60 seconds.
78 .TP
79 .B \-\-logstring <name>
80 Use <name> instead of 'anon' in syslog messages
81 .TP
82 .B \-\-localbind <addr>
83 Bind to specified IP address instead of wildcard
84 .TP
85 .B \-\-loglevel <level>
86 Sets the debugging level (0=low, 1=default, 2=high)
87
88 .TP
89 .B \-\-test-type <n>
90 Enable packet reordering tests that damage the integrity of the packet
91 stream to the server.  Use this only when testing servers.  Zero is
92 the default, and means that packets are sent in the correct order.  A
93 value of one (1) causes a single swap between two packets, such that
94 the sequence numbers might be 1 2 3 4 6 5 7 8 9.  A value of two (2)
95 causes ten packets to be buffered, then sent out of order but
96 ascending, such that the sequence numbers might be 1 2 3 4 16 6 7 8 9
97 10 11 12 13 14 15 17 18 19 20.  A value of three (3) causes ten
98 packets to be buffered, then sent in the reverse order, like this; 1 2
99 3 4 16 15 14 13 12 11 10 9 8 7 6 5 17 18 19 20.
100
101 .TP
102 .B \-\-test-rate <n>
103 Sets the number of packets to pass before causing a reordering test.
104 Default is 100.  Has no effect if test-type is zero.  The result of
105 test types 2 and 3 are undefined if this value is less than ten.
106
107
108 .SH "QUIRKS"
109
110 .TP
111 .B BEZEQ_ISRAEL
112 modifies packets to interoperate with Orckit ADSL modems on the BEZEQ
113 network in Israel.
114
115 .SH "EXAMPLES"
116
117 .B Connection to a Microsoft Windows VPN Server
118
119 .BR
120 pppd noauth nobsdcomp nodeflate require\-mppe\-128 name domain\\\\\\\\username remotename PPTP pty "pptp 10.0.0.5 \-\-nolaunchpppd"
121 .PP
122 Note that the \fBchap\-secrets\fR file used by \fBpppd\fR must include an entry for domain\\\\username
123
124 .SH "STATISTICS"
125 The pptp process collects statistics when sending and receiving
126 GRE packets. They are intended to be useful for debugging poor PPTP
127 performance and for general monitoring of link quality. The statistics
128 are cumulative since the pptp process was started.
129 .PP
130 The statistics can be viewed by sending a SIGUSR1 signal to the
131 "GRE-to-PPP Gateway" process, which will cause it to dump them
132 to the system logs (at the LOG_NOTICE level). A better way to present
133 the statistics to applications is being sought (e.g. SNMP?).
134 .PP
135 The following statistics are collected at the time of writing (April 2003):
136 .TP
137 .B rx accepted
138 the number of GRE packets successfully passed to PPP
139 .TP
140 .B rx lost
141 the number of packets never received, and presumed lost in the network
142 .TP
143 .B rx under win
144 the number of packets which were duplicates or had old sequence numbers
145 (this might be caused by a packet-reordering network if your reordering
146 timeout is set too low)
147 .TP
148 .B rx over win
149 the number of packets which were too far ahead in the sequence to be
150 reordered (might be caused by loss of more than 300 packets in a row)
151 .TP
152 .B rx buffered
153 the number of packets which were slightly ahead of sequence, and were
154 either buffered for reordering, or if buffering is disabled, accepted
155 immediately (resulting in the intermediate packets being discarded).
156 .TP
157 .B rx OS errors
158 the number of times where the operating system reported an error when
159 we tried to read a packet
160 .TP
161 .B rx truncated
162 the number of times we received a packet which was shorter than the
163 length implied by the GRE header
164 .TP
165 .B rx invalid
166 the number of times we received a packet which had invalid or unsupported
167 flags set in the header, wrong version, or wrong protocol.
168 .TP
169 .B rx acks
170 the number of pure acknowledgements received (without data). Too many
171 of these will waste bandwidth, and might be solved by tuning the remote host.
172 .TP
173 .B tx sent
174 the number of GRE packets sent with data
175 .TP
176 .B tx failed
177 the number of packets we tried to send, but the OS reported an error
178 .TP
179 .B tx short
180 the number of times the OS would not let us write a complete packet
181 .TP
182 .B tx acks
183 the number of times we sent a pure ack, without data
184 .TP
185 .B tx oversize
186 the number of times we couldn't send a packet because it was over
187 PACKET_MAX bytes long
188 .TP
189 .B round trip
190 the estimated round-trip time in milliseconds
191
192 .SH "SEE ALSO"
193 .IR pppd (8)
194 .PP
195 Documentation in
196 .IR /usr/share/doc/pptp
197 .SH AUTHOR
198 This manual page was written by James Cameron
199 <james.cameron@hp.com> from text contributed by Thomas Quinot
200 <thomas@debian.org>, for the Debian GNU/Linux system.
201 The description of the available statistics was written by Chris Wilson
202 <chris@netservers.co.uk>. Updates for the Debian distribution by
203 Ola Lundqvist <opal@debian.org>.