Deleted Added
full compact
ppp.8.m4 (46686) ppp.8.m4 (47061)
1.\" $Id: ppp.8,v 1.166 1999/05/02 08:52:50 brian Exp $
1.\" $Id: ppp.8,v 1.167 1999/05/08 11:07:25 brian Exp $
2.Dd 20 September 1995
3.nr XX \w'\fC00'
4.Os FreeBSD
5.Dt PPP 8
6.Sh NAME
7.Nm ppp
8.Nd Point to Point Protocol (a.k.a. user-ppp)
9.Sh SYNOPSIS

--- 133 unchanged lines hidden (view full) ---

143.Em alive
144filter for keeping a connection alive with the trigger packet.
145.It Tunnel driver supports bpf.
146The user can use
147.Xr tcpdump 1
148to check the packet flow over the
149.Em PPP
150link.
2.Dd 20 September 1995
3.nr XX \w'\fC00'
4.Os FreeBSD
5.Dt PPP 8
6.Sh NAME
7.Nm ppp
8.Nd Point to Point Protocol (a.k.a. user-ppp)
9.Sh SYNOPSIS

--- 133 unchanged lines hidden (view full) ---

143.Em alive
144filter for keeping a connection alive with the trigger packet.
145.It Tunnel driver supports bpf.
146The user can use
147.Xr tcpdump 1
148to check the packet flow over the
149.Em PPP
150link.
151.It Supports PPP over TCP capability.
151.It Supports PPP over TCP and PPP over UDP.
152If a device name is specified as
152If a device name is specified as
153.Em host Ns No : Ns Em port ,
153.Em host Ns No : Ns Em port Ns
154.Op / Ns Em tcp Ns No | Ns Em udp ,
154.Nm
155.Nm
155will open a TCP connection for transporting data rather than using a
156conventional serial device.
156will open a TCP or UDP connection for transporting data rather than using a
157conventional serial device. UDP connections force
158.Nm
159into synchronous mode.
157.It "Supports IETF draft Predictor-1 (rfc 1978) and DEFLATE (rfc 1979) compression."
158.Nm
159supports not only VJ-compression but also Predictor-1 and DEFLATE compression.
160Normally, a modem has built-in compression (e.g. v42.bis) and the system
161may receive higher data rates from it as a result of such compression.
162While this is generally a good thing in most other situations, this
163higher speed data imposes a penalty on the system by increasing the
164number of serial interrupts the system has to process in talking to the

--- 1032 unchanged lines hidden (view full) ---

1197.Ar callback-number
1198may also contain a list of numbers or a
1199.Dq \&* ,
1200as if passed to the
1201.Dq set cbcp
1202command. The value will be used in
1203.Nm ppp Ns No s
1204subsequent CBCP phase.
160.It "Supports IETF draft Predictor-1 (rfc 1978) and DEFLATE (rfc 1979) compression."
161.Nm
162supports not only VJ-compression but also Predictor-1 and DEFLATE compression.
163Normally, a modem has built-in compression (e.g. v42.bis) and the system
164may receive higher data rates from it as a result of such compression.
165While this is generally a good thing in most other situations, this
166higher speed data imposes a penalty on the system by increasing the
167number of serial interrupts the system has to process in talking to the

--- 1032 unchanged lines hidden (view full) ---

1200.Ar callback-number
1201may also contain a list of numbers or a
1202.Dq \&* ,
1203as if passed to the
1204.Dq set cbcp
1205command. The value will be used in
1206.Nm ppp Ns No s
1207subsequent CBCP phase.
1205.Sh PPP OVER TCP (a.k.a Tunnelling)
1208.Sh PPP OVER TCP and UDP (a.k.a Tunnelling)
1206Instead of running
1207.Nm
1208over a serial link, it is possible to
1209Instead of running
1210.Nm
1211over a serial link, it is possible to
1209use a TCP connection instead by specifying a host and port as the
1212use a TCP connection instead by specifying the host, port and protocol as the
1210device:
1211.Pp
1213device:
1214.Pp
1212.Dl set device ui-gate:6669
1215.Dl set device ui-gate:6669/tcp
1213.Pp
1214Instead of opening a serial device,
1215.Nm
1216will open a TCP connection to the given machine on the given
1217socket. It should be noted however that
1218.Nm
1219doesn't use the telnet protocol and will be unable to negotiate
1220with a telnet server. You should set up a port for receiving this

--- 52 unchanged lines hidden (view full) ---

1273database.
1274.Pp
1275The entry in
1276.Pa /etc/ppp/ppp.conf
1277on awfulhak (the initiator) should contain the following:
1278.Bd -literal -offset indent
1279ui-gate:
1280 set escape 0xff
1216.Pp
1217Instead of opening a serial device,
1218.Nm
1219will open a TCP connection to the given machine on the given
1220socket. It should be noted however that
1221.Nm
1222doesn't use the telnet protocol and will be unable to negotiate
1223with a telnet server. You should set up a port for receiving this

--- 52 unchanged lines hidden (view full) ---

1276database.
1277.Pp
1278The entry in
1279.Pa /etc/ppp/ppp.conf
1280on awfulhak (the initiator) should contain the following:
1281.Bd -literal -offset indent
1282ui-gate:
1283 set escape 0xff
1281 set device ui-gate:ppp-in
1284 set device ui-gate:ppp-in/tcp
1282 set dial
1283 set timeout 30
1284 set log Phase Chat Connect hdlc LCP IPCP CCP tun
1285 set ifaddr 10.0.4.2 10.0.4.1
1286 add 10.0.2.0/24 10.0.4.1
1287.Ed
1288.Pp
1289Again, if you're enabling PAP, you'll also need:

--- 13 unchanged lines hidden (view full) ---

1303"route" on ui-gate to the 10.0.1.0/24 network.
1304The networks are effectively bridged - the underlying TCP
1305connection may be across a public network (such as the
1306Internet), and the
1307.Em PPP
1308traffic is conceptually encapsulated
1309(although not packet by packet) inside the TCP stream between
1310the two gateways.
1285 set dial
1286 set timeout 30
1287 set log Phase Chat Connect hdlc LCP IPCP CCP tun
1288 set ifaddr 10.0.4.2 10.0.4.1
1289 add 10.0.2.0/24 10.0.4.1
1290.Ed
1291.Pp
1292Again, if you're enabling PAP, you'll also need:

--- 13 unchanged lines hidden (view full) ---

1306"route" on ui-gate to the 10.0.1.0/24 network.
1307The networks are effectively bridged - the underlying TCP
1308connection may be across a public network (such as the
1309Internet), and the
1310.Em PPP
1311traffic is conceptually encapsulated
1312(although not packet by packet) inside the TCP stream between
1313the two gateways.
1314.Pp
1311The major disadvantage of this mechanism is that there are two
1312"guaranteed delivery" mechanisms in place - the underlying TCP
1313stream and whatever protocol is used over the
1314.Em PPP
1315link - probably TCP again. If packets are lost, both levels will
1316get in each others way trying to negotiate sending of the missing
1317packet.
1315The major disadvantage of this mechanism is that there are two
1316"guaranteed delivery" mechanisms in place - the underlying TCP
1317stream and whatever protocol is used over the
1318.Em PPP
1319link - probably TCP again. If packets are lost, both levels will
1320get in each others way trying to negotiate sending of the missing
1321packet.
1322.Pp
1323To avoid this overhead, it is also possible to do all this using
1324UDP instead of TCP as the transport by simply changing the protocol
1325from "tcp" to "udp". When using UDP as a transport,
1326.Nm
1327will operate in synchronous mode. This is another gain as the incoming
1328data does not have to be rearranged into packets.
1329.Pp
1318.Sh PACKET ALIASING
1319The
1320.Fl alias
1321command line option enables packet aliasing. This allows the
1322.Nm
1323host to act as a masquerading gateway for other computers over
1324a local area network. Outgoing IP packets are aliased so that
1325they appear to come from the

--- 591 unchanged lines hidden (view full) ---

1917.It Li IPCP
1918Generate an IPCP packet trace.
1919.It Li LCP
1920Generate an LCP packet trace.
1921.It Li LQM
1922Generate LQR reports.
1923.It Li Phase
1924Phase transition log output.
1330.Sh PACKET ALIASING
1331The
1332.Fl alias
1333command line option enables packet aliasing. This allows the
1334.Nm
1335host to act as a masquerading gateway for other computers over
1336a local area network. Outgoing IP packets are aliased so that
1337they appear to come from the

--- 591 unchanged lines hidden (view full) ---

1929.It Li IPCP
1930Generate an IPCP packet trace.
1931.It Li LCP
1932Generate an LCP packet trace.
1933.It Li LQM
1934Generate LQR reports.
1935.It Li Phase
1936Phase transition log output.
1937.It Li Physical
1938Dump physical level packet in hex.
1939.It Li Sync
1940Dump sync level packet in hex.
1925.It Li TCP/IP
1926Dump all TCP/IP packets.
1927.It Li Timer
1928Log timer manipulation.
1929.It Li TUN
1930Include the tun device on each log line.
1931.It Li Warning
1932Output to the terminal device. If there is currently no terminal,

--- 1570 unchanged lines hidden (view full) ---

3503.Pp
3504If it begins with an exclamation mark, the rest of the device name is
3505treated as a program name, and that program is executed when the device
3506is opened. Standard input, output and error are fed back to
3507.Nm
3508and are read and written as if they were a regular device.
3509.Pp
3510If a
1941.It Li TCP/IP
1942Dump all TCP/IP packets.
1943.It Li Timer
1944Log timer manipulation.
1945.It Li TUN
1946Include the tun device on each log line.
1947.It Li Warning
1948Output to the terminal device. If there is currently no terminal,

--- 1570 unchanged lines hidden (view full) ---

3519.Pp
3520If it begins with an exclamation mark, the rest of the device name is
3521treated as a program name, and that program is executed when the device
3522is opened. Standard input, output and error are fed back to
3523.Nm
3524and are read and written as if they were a regular device.
3525.Pp
3526If a
3511.Dq host:port
3512pair is given,
3527.Dq host:port Ns Op /tcp|/udp
3528specification is given,
3513.Nm
3514will attempt to connect to the given
3515.Dq host
3516on the given
3517.Dq port .
3529.Nm
3530will attempt to connect to the given
3531.Dq host
3532on the given
3533.Dq port .
3518Refer to the section on
3519.Em PPP OVER TCP
3534If a tcp or udp specification is not given, the default is tcp. Refer to
3535the section on
3536.Em PPP OVER TCP and UDP
3520above for further details.
3521.Pp
3522If multiple
3523.Dq values
3524are specified,
3525.Nm
3526will attempt to open each one in turn until it succeeds or runs out of
3527devices.

--- 269 unchanged lines hidden (view full) ---

3797will only negotiate
3798.Dq 10.0.0.1
3799as the local IP number, but may assign any of the given 10 IP
3800numbers to the peer. If the peer requests one of these numbers,
3801and that number is not already in use,
3802.Nm
3803will grant the peers request. This is useful if the peer wants
3804to re-establish a link using the same IP number as was previously
3537above for further details.
3538.Pp
3539If multiple
3540.Dq values
3541are specified,
3542.Nm
3543will attempt to open each one in turn until it succeeds or runs out of
3544devices.

--- 269 unchanged lines hidden (view full) ---

3814will only negotiate
3815.Dq 10.0.0.1
3816as the local IP number, but may assign any of the given 10 IP
3817numbers to the peer. If the peer requests one of these numbers,
3818and that number is not already in use,
3819.Nm
3820will grant the peers request. This is useful if the peer wants
3821to re-establish a link using the same IP number as was previously
3805allocated (thus maintaining any existing tcp connections).
3822allocated (thus maintaining any existing tcp or udp connections).
3806.Pp
3807If the peer requests an IP number that's either outside
3808of this range or is already in use,
3809.Nm
3810will suggest a random unused IP number from the range.
3811.Pp
3812If
3813.Ar triggeraddr

--- 428 unchanged lines hidden (view full) ---

4242with a server socket, the
4243.Xr pppctl 8
4244command is the preferred mechanism of communications. Currently,
4245.Xr telnet 1
4246can also be used, but link encryption may be implemented in the future, so
4247.Xr telnet 1
4248should not be relied upon.
4249.It set speed Ar value
3823.Pp
3824If the peer requests an IP number that's either outside
3825of this range or is already in use,
3826.Nm
3827will suggest a random unused IP number from the range.
3828.Pp
3829If
3830.Ar triggeraddr

--- 428 unchanged lines hidden (view full) ---

4259with a server socket, the
4260.Xr pppctl 8
4261command is the preferred mechanism of communications. Currently,
4262.Xr telnet 1
4263can also be used, but link encryption may be implemented in the future, so
4264.Xr telnet 1
4265should not be relied upon.
4266.It set speed Ar value
4250This sets the speed of the serial device.
4267This sets the speed of the serial device. If speed is specified as
4268.Dq sync ,
4269.Nm
4270treats the device as a synchronous device.
4271.Pp
4272Certain device types will know whether they should be specified as
4273synchronous or asynchronous. These devices will override incorrect
4274settings and log a warning to this effect.
4251.It set stopped Op Ar LCPseconds Op Ar CCPseconds
4252If this option is set,
4253.Nm
4254will time out after the given FSM (Finite State Machine) has been in
4255the stopped state for the given number of
4256.Dq seconds .
4257This option may be useful if the peer sends a terminate request,
4258but never actually closes the connection despite our sending a terminate

--- 250 unchanged lines hidden ---
4275.It set stopped Op Ar LCPseconds Op Ar CCPseconds
4276If this option is set,
4277.Nm
4278will time out after the given FSM (Finite State Machine) has been in
4279the stopped state for the given number of
4280.Dq seconds .
4281This option may be useful if the peer sends a terminate request,
4282but never actually closes the connection despite our sending a terminate

--- 250 unchanged lines hidden ---