.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "corkscrew 1"
.TH corkscrew 1 2024-07-14 corkscrew Networking
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
corkscrew \- Tunnel TCP connections through HTTP proxies
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  corkscrew  PROXY PROXYPORT TARGETHOST TARGETPORT [AUTH_FILE]
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
corkscrew is a simple tool to tunnel TCP connections through an HTTP
proxy supporting the CONNECT method. It reads stdin and writes to std\-
out during the connection, just like netcat. It can be used for
instance to connect to an SSH server running on a remote 443 port
through a strict HTTPS proxy.
.IP PROXY 4
.IX Item "PROXY"
The name of the host running the HTTP proxy.
.IP PROXYPORT 4
.IX Item "PROXYPORT"
The port on which to connect on the proxy.
.IP TARGET 4
.IX Item "TARGET"
The host to reach through the proxy.
.IP TARGETPORT 4
.IX Item "TARGETPORT"
The port to connect to on the target host.
.IP "AUTH_ FILE" 4
.IX Item "AUTH_ FILE"
The  auth  file is made of one single line containing your username and
password in the form
.Sp
.Vb 1
\&    username:password
.Ve
.SH OPTIONS
.IX Header "OPTIONS"
None.
.SH EXAMPLES
.IX Header "EXAMPLES"
The common usage of corkscrew is to put the following line in
~/.ssh/ssh_config:
.PP
.Vb 1
\&        ProxyCommand corkscrew proxy proxyport %h %p [<path to auth_file>]
.Ve
.PP
This will let the ssh connection go through the proxy with the help of
corkscrew.
.SH ENVIRONMENT
.IX Header "ENVIRONMENT"
None.
.SH FILES
.IX Header "FILES"
None.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBssh_config\fR\|(5)
.SH AUTHORS
.IX Header "AUTHORS"
Program was written by Pat Padgett <pat@patpadgett.com>.
.PP
This manual page was written by Laurent Fousse <laurent@komite.net> for
the Debian GNU system (but may be used by others). Updated by Jari
Aalto <jari.aalto@cante.net>. Released under license GNU GPL version 2
or (at your option) any later version. For more information about
license, visit <http://www.gnu.org/copyleft/gpl.html>.