9a73aa8
.\"                                      Hey, EMACS: -*- nroff -*-
9a73aa8
.\" First parameter, NAME, should be all caps
9a73aa8
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
9a73aa8
.\" other parameters are allowed: see man(7), man(1)
9a73aa8
.TH CORKSCREW 1 "November 22, 2003"
9a73aa8
.\" Please adjust this date whenever revising the manpage.
9a73aa8
.\"
9a73aa8
.\" Some roff macros, for reference:
9a73aa8
.\" .nh        disable hyphenation
9a73aa8
.\" .hy        enable hyphenation
9a73aa8
.\" .ad l      left justify
9a73aa8
.\" .ad b      justify to both left and right margins
9a73aa8
.\" .nf        disable filling
9a73aa8
.\" .fi        enable filling
9a73aa8
.\" .br        insert line break
9a73aa8
.\" .sp <n>    insert n+1 empty lines
9a73aa8
.\" for manpage-specific macros, see man(7)
9a73aa8
.SH NAME
9a73aa8
corkscrew \- Tunnel TCP connections through HTTP proxies
9a73aa8
.SH SYNOPSIS
9a73aa8
.B corkscrew
9a73aa8
.BR 
9a73aa8
proxy
9a73aa8
.BR 
9a73aa8
proxyport 
9a73aa8
.BR
9a73aa8
targethost
9a73aa8
.BR
9a73aa8
targetport
9a73aa8
.BR
9a73aa8
[ authfile ]
9a73aa8
.br
9a73aa8
.SH DESCRIPTION
9a73aa8
This manual page documents briefly the
9a73aa8
.BR corkscrew
9a73aa8
command.
9a73aa8
This manual page was written for the Debian distribution
9a73aa8
because the original program does not have a manual page.
9a73aa8
9a73aa8
corkscrew is a simple tool to tunnel TCP connections through an HTTP
9a73aa8
proxy supporting the CONNECT method. It reads stdin and writes to
9a73aa8
stdout during the connection, just like netcat.
9a73aa8
It can be used for instance to connect to an SSH server running on
9a73aa8
a remote 443 port through a strict HTTPS proxy.
9a73aa8
9a73aa8
9a73aa8
.SH PARAMETERS
9a73aa8
9a73aa8
.TP
9a73aa8
.B proxy
9a73aa8
This is the name of the host running the HTTP proxy.
9a73aa8
.TP
9a73aa8
.B proxyport
9a73aa8
This is the port on which to connect on the proxy.
9a73aa8
.TP
9a73aa8
.B target
9a73aa8
This is the host to reach through the proxy.
9a73aa8
.TP
9a73aa8
.B targetport
9a73aa8
This is the port to connect to on the target host.
9a73aa8
9a73aa8
.SH COMMON USAGE
9a73aa8
9a73aa8
The common usage of corkscrew is to put the following line in your
9a73aa8
ssh_config:
9a73aa8
9a73aa8
ProxyCommand corkscrew proxy proxyport %h %p
9a73aa8
9a73aa8
This will let your ssh connection go through the proxy with the help
9a73aa8
of corkscrew.
9a73aa8
9a73aa8
.SH AUTH FILE
9a73aa8
9a73aa8
The auth file is made of one single line containing your username and
9a73aa8
password in the form:
9a73aa8
9a73aa8
username:password
9a73aa8
9a73aa8
You should add the path to your auth file in the proxy command
9a73aa8
described above:
9a73aa8
9a73aa8
ProxyCommand corkscrew proxy proxyport %h %p auth-file
9a73aa8
9a73aa8
.SH "SEE ALSO"
9a73aa8
.IX Header "SEE ALSO"
9a73aa8
\&\fIssh_config\fR\|(5)
9a73aa8
9a73aa8
.PP
9a73aa8
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
9a73aa8
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
9a73aa8
.\" respectively.
9a73aa8
.SH AUTHOR
9a73aa8
corkscrew was written by Pat Padgett <agroman@agroman.net>.
9a73aa8
Thomas Seyrat <tomasera@debian.org> is the debian maintainer for this
9a73aa8
package.  This manual page was written by Laurent Fousse
9a73aa8
<laurent@komite.net>, for the Debian GNU/Linux system (but may be used
9a73aa8
by others).