openbsd-ports/net/pptp/files/pptp_8
2004-05-30 21:54:03 +00:00

84 lines
1.8 KiB
Plaintext

.\" $OpenBSD: pptp_8,v 1.3 2004/05/30 21:54:03 jmc Exp $
.\" Manual page for pptp-1.1.0
.\" Information gleaned from USING file in the distribution
.\" SH section heading
.\" SS subsection heading
.\" LP paragraph
.\" IP indented paragraph
.\" TP hanging label
.Dd April 9, 2000
.Dt pptp 8
.Sh NAME
.Nm pptp
.Nd Point-to-Point Tunneling Protocol daemon
.Sh SYNOPSIS
.Nm
.Ar hostname
[
.Op Ar --phone <phone number>
.Op Ar --quirks ISP_NAME
-- ]
.Op Ar pppd options
.Sh DESCRIPTION
.Nm
manages
a virtual private network (VPN) connection using Microsoft
PPTP protocols using IP GRE tunneling protocols.
.Nm
uses
.Xr pppd 8
on a pseudo-tty
to negotiate the connection with MS-CHAP authentication.
.Pp
Because
.Nm
uses GRE by using a raw IP socket, it will not work if your kernel has
the
.Xr gre 4
pseudo-device
configured.
.Pp
Build a kernel without "GRE encapsulation interface" support.
(NB: look in /usr/src/sys/conf/GENERIC for "pseudo-device gre".)
.Pp
The
.Ar hostname
parameter specifies which host should be contacted as the PPTP server.
Additional parameters are passed on to
.Ic pppd
and typically include a remote username or a file containing options.
.Pp
.Nm
must be run as root.
.Sh EXAMPLE
.Nm
.Ar hostname
.Op Ar pppd options
.Sh FILES
.Pa /var/run/pptp/<ip-address>
is created as a socket. It is used for communicating with an existing
PPTP call manager for a given remote server host.
.Pp
.Pa PREFIX/sbin/pptp-reconnect
can be used to (re)establish a pptp connection.
.Sh SEE ALSO
.Xr pppd 8 ,
.Xr gre 4 ,
.Pa PREFIX/share/doc/pptp/USING .
.Sh BUGS
.Nm
does not work with a GENERIC kernel, because
.Xr gre 4
conflicts with
.Xr pptp 8
protocol ip (47).
.Sh HISTORY
This man page appeared first in
.Nx
\'s pptp-package.
.Sh AUTHORS
.An C. Scott Ananian Aq cananian@alumni.princeton.edu ,
.An John Kohl Aq jtk@NetBSD.org
(patches and original man page).