Correct PPTP server firewall rules chain.
[tomato/davidwu.git] / release / src / router / pptp-client / pptp.8
blob9210984922707a33954ec6a035ec89abd6b16127
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)
88 .SH "QUIRKS"
90 .TP
91 .B BEZEQ_ISRAEL
92 modifies packets to interoperate with Orckit ADSL modems on the BEZEQ
93 network in Israel.
95 .SH "EXAMPLES"
97 .B Connection to a Microsoft Windows VPN Server
99 .BR
100 pppd noauth nobsdcomp nodeflate mppe-40 mppe-128
101 mppe-stateless name domain\\\\\\\\username remotename PPTP
102 require-chapms-v2
103 pty "pptp 10.0.0.5 --nolaunchpppd"
105 Note that the \fBchap-secrets\fR file used by \fBpppd\fR must include an entry for domain\\\\username
107 .SH "STATISTICS"
108 The pptp process collects statistics when sending and receiving
109 GRE packets. They are intended to be useful for debugging poor PPTP
110 performance and for general monitoring of link quality. The statistics
111 are cumulative since the pptp process was started.
113 The statistics can be viewed by sending a SIGUSR1 signal to the
114 "GRE-to-PPP Gateway" process, which will cause it to dump them
115 to the system logs (at the LOG_NOTICE level). A better way to present
116 the statistics to applications is being sought (e.g. SNMP?).
118 The following statistics are collected at the time of writing (April 2003):
120 .B rx accepted
121 the number of GRE packets successfully passed to PPP
123 .B rx lost
124 the number of packets never received, and presumed lost in the network
126 .B rx under win
127 the number of packets which were duplicates or had old sequence numbers
128 (this might be caused by a packet-reordering network if your reordering
129 timeout is set too low)
131 .B rx over win
132 the number of packets which were too far ahead in the sequence to be
133 reordered (might be caused by loss of more than 300 packets in a row)
135 .B rx buffered
136 the number of packets which were slightly ahead of sequence, and were
137 either buffered for reordering, or if buffering is disabled, accepted
138 immediately (resulting in the intermediate packets being discarded).
140 .B rx OS errors
141 the number of times where the operating system reported an error when
142 we tried to read a packet
144 .B rx truncated
145 the number of times we received a packet which was shorter than the
146 length implied by the GRE header
148 .B rx invalid
149 the number of times we received a packet which had invalid or unsupported
150 flags set in the header, wrong version, or wrong protocol.
152 .B rx acks
153 the number of pure acknowledgements received (without data). Too many
154 of these will waste bandwidth, and might be solved by tuning the remote host.
156 .B tx sent
157 the number of GRE packets sent with data
159 .B tx failed
160 the number of packets we tried to send, but the OS reported an error
162 .B tx short
163 the number of times the OS would not let us write a complete packet
165 .B tx acks
166 the number of times we sent a pure ack, without data
168 .B tx oversize
169 the number of times we couldn't send a packet because it was over
170 PACKET_MAX bytes long
172 .B round trip
173 the estimated round-trip time in milliseconds
175 .SH "SEE ALSO"
176 .IR pppd (8)
178 Documentation in
179 .IR /usr/share/doc/pptp
180 .SH AUTHOR
181 This manual page was written by James Cameron
182 <james.cameron@hp.com> from text contributed by Thomas Quinot
183 <thomas@debian.org>, for the Debian GNU/Linux system.
184 The description of the available statistics was written by Chris Wilson
185 <chris@netservers.co.uk>.