.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "LWP::Protocol::socks 3pm"
.TH LWP::Protocol::socks 3pm "2022-06-15" "perl v5.34.0" "User Contributed Perl Documentation"
.\" 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"
LWP::Protocol::socks \- adds support for the socks protocol and proxy facility
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
use LWP::Protocol::socks;
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Use this package when you wish to use a socks proxy for your
connections.
.PP
It provides some essential hooks into the \s-1LWP\s0 system to implement a
socks \*(L"scheme\*(R" similar to http for describing your socks connection,
and can be used to proxy either http or https connections.
.PP
The use case is to use LWP::UserAgent's proxy method to register your
socks proxy like so:
.PP
.Vb 1
\& $ua\->proxy([qw(http https)] => \*(Aqsocks://socks.yahoo.com:1080\*(Aq);
.Ve
.PP
Then just use your \f(CW$ua\fR object as usual!
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.Vb 3
\& #!/usr/local/bin/perl
\& use strict;
\& use LWP::UserAgent;
\&
\& my $ua = new LWP::UserAgent(agent => \*(AqMozilla/5.0 (Windows; U; Windows NT 5.1; en\-US; rv:1.8.0.5) Gecko/20060719 Firefox/1.5.0.5\*(Aq);
\& # for socks5, use socks like so:
\& $ua\->proxy([qw(http https)] => \*(Aqsocks://socks.yahoo.com:1080\*(Aq);
\& # for socks4, use socks4 like so:
\& $ua\->proxy([qw(http https)] => \*(Aqsocks4://socks.yahoo.com:1080\*(Aq);
\& my $response = $ua\->get("http://www.freebsd.org");
\& print $response\->code,\*(Aq \*(Aq, $response\->message,"\en";
\& my $response = $ua\->get("https://www.microsoft.com");
\& print $response\->code,\*(Aq \*(Aq, $response\->message,"\en";
.Ve
.SH "NOTES"
.IX Header "NOTES"
I don't have much time to contribute to this.  If you'd like to
contribute, please fork https://github.com/scr/cpan and send me a pull
request.
.SH "AUTHORS"
.IX Header "AUTHORS"
Sheridan C Rawlins <\fIsheridan.rawlins@yahoo.com\fR>
.PP
Oleg G <\fIoleg@cpan.org\fR>