€•a5Œdocutils.nodes”Œdocument”“”)”}”(Œ	rawsource”Œ”Œchildren”]”hŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ``ProxyCommand`` support”h]”(hŒliteral”“”)”}”(hŒ``ProxyCommand``”h]”hŒText”“”ŒProxyCommand”…””}”(Œparent”hŒ	_document”hŒsource”NŒline”NubaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”uŒtagname”hh hubhŒ support”…””}”(h hh!hh"Nh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0hh hh!hh"Œ9/home/jforcier/Code/oss/paramiko/sites/docs/api/proxy.rst”h#KubŒsphinx.addnodes”Œindex”“”)”}”(hhh]”h$}”(h&]”h(]”h*]”h,]”h.]”Œentries”]”(Œsingle”Œparamiko.proxy (module)”Œmodule-paramiko.proxy”hNt”auh0h=h hh!hh"Œ[/home/jforcier/Code/oss/paramiko/paramiko/proxy.py:docstring of paramiko.proxy.ProxyCommand”h#K
ubh>)”}”(hhh]”h$}”(h&]”h(]”h*]”h,]”h.]”Œentries”]”(hJŒ&ProxyCommand (class in paramiko.proxy)”Œparamiko.proxy.ProxyCommand”hNt”auh0h=h hh!hh"Nh#Nubh<Œdesc”“”)”}”(hhh]”(h<Œdesc_signature”“”)”}”(hŒProxyCommand(command_line)”h]”(h<Œdesc_annotation”“”)”}”(hŒclass ”h]”hŒclass ”…””}”(h hjh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”Œ	xml:space”Œpreserve”uh0hhh hdh!hh"Œ[/home/jforcier/Code/oss/paramiko/paramiko/proxy.py:docstring of paramiko.proxy.ProxyCommand”h#Nubh<Œdesc_addname”“”)”}”(hŒparamiko.proxy.”h]”hŒparamiko.proxy.”…””}”(h h}h!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h{h hdh!hh"hzh#Nubh<Œ	desc_name”“”)”}”(hŒProxyCommand”h]”hŒProxyCommand”…””}”(h hh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h‹h hdh!hh"hzh#Nubh<Œdesc_parameterlist”“”)”}”(hŒcommand_line”h]”h<Œdesc_parameter”“”)”}”(hŒcommand_line”h]”hŒcommand_line”…””}”(h h£h!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h¡h hubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h›h hdh!hh"hzh#Nubeh$}”(h&]”h[ah(]”h*]”h[ah,]”h.]”Œfirst”‰Œmodule”Œparamiko.proxy”Œclass”hŒfullname”huh0hbh h_h!hh"hzh#Nubh<Œdesc_content”“”)”}”(hhh]”(hŒ	paragraph”“”)”}”(hŒ8Wraps a subprocess running ProxyCommand-driven programs.”h]”hŒ8Wraps a subprocess running ProxyCommand-driven programs.”…””}”(h hÉh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0hÇh"Œ[/home/jforcier/Code/oss/paramiko/paramiko/proxy.py:docstring of paramiko.proxy.ProxyCommand”h#K
h hÄh!hubhÈ)”}”(hX
This class implements a the socket-like interface needed by the
`.Transport` and `.Packetizer` classes. Using this class instead of a
regular socket makes it possible to talk with a Popen'd command that will
proxy traffic between the client and a server hosted in another machine.”h]”(hŒ@This class implements a the socket-like interface needed by the
”…””}”(h hØh!hh"Nh#Nubh<Œpending_xref”“”)”}”(hŒ`.Transport`”h]”h)”}”(hhäh]”hŒ	Transport”…””}”(h hæh!hh"Nh#Nubah$}”(h&]”h(]”(Œxref”Œpy”Œpy-obj”eh*]”h,]”h.]”uh0hh hâubah$}”(h&]”h(]”h*]”h,]”h.]”Œreftype”Œobj”Œ	refdomain”hñŒrefexplicit”‰Œ	py:module”h¿Œpy:class”hŒrefspecific”ˆŒ	reftarget”Œ	Transport”Œrefdoc”Œ	api/proxy”Œrefwarn”‰uh0hàh"Nh#Nh hØubhŒ and ”…””}”(h hØh!hh"Nh#Nubhá)”}”(hŒ
`.Packetizer`”h]”h)”}”(hj
h]”hŒ
Packetizer”…””}”(h j
h!hh"Nh#Nubah$}”(h&]”h(]”(hðŒpy”Œpy-obj”eh*]”h,]”h.]”uh0hh j
ubah$}”(h&]”h(]”h*]”h,]”h.]”Œreftype”Œobj”Œ	refdomain”j
Œrefexplicit”‰j
h¿j

hj
ˆj
Œ
Packetizer”j
j
j
‰uh0hàh"Nh#Nh hØubhŒ¼ classes. Using this class instead of a
regular socket makes it possible to talk with a Popen’d command that will
proxy traffic between the client and a server hosted in another machine.”…””}”(h hØh!hh"Nh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0hÇh"h×h#Kh hÄh!hubhÈ)”}”(hŒ8Instances of this class may be used as context managers.”h]”hŒ8Instances of this class may be used as context managers.”…””}”(h j4
h!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0hÇh"h×h#Kh hÄh!hubh>)”}”(hhh]”h$}”(h&]”h(]”h*]”h,]”h.]”Œentries”]”(hJŒ/__init__() (paramiko.proxy.ProxyCommand method)”Œ$paramiko.proxy.ProxyCommand.__init__”hNt”auh0h=h hÄh!hh"Nh#Nubh^)”}”(hhh]”(hc)”}”(hŒ#ProxyCommand.__init__(command_line)”h]”(hŒ)”}”(hŒ__init__”h]”hŒ__init__”…””}”(h jW
h!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h‹h jS
h!hh"Œd/home/jforcier/Code/oss/paramiko/paramiko/proxy.py:docstring of paramiko.proxy.ProxyCommand.__init__”h#Nubhœ)”}”(hŒcommand_line”h]”h¢)”}”(hŒcommand_line”h]”hŒcommand_line”…””}”(h jj
h!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h¡h jf
ubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h›h jS
h!hh"je
h#Nubeh$}”(h&]”jN
ah(]”h*]”jN
ah,]”h.]”h½‰h¾Œparamiko.proxy”hÀhhLProxyCommand.__init__”uh0hbh jP
h!hh"je
h#NubhÃ)”}”(hhh]”(hÈ)”}”(hŒ~Create a new CommandProxy instance. The instance created by this
class can be passed as an argument to the `.Transport` class.”h]”(hŒkCreate a new CommandProxy instance. The instance created by this
class can be passed as an argument to the ”…””}”(h j‰
h!hh"Nh#Nubhá)”}”(hŒ`.Transport`”h]”h)”}”(hj“
h]”hŒ	Transport”…””}”(h j•
h!hh"Nh#Nubah$}”(h&]”h(]”(hðŒpy”Œpy-obj”eh*]”h,]”h.]”uh0hh j‘
ubah$}”(h&]”h(]”h*]”h,]”h.]”Œreftype”Œobj”Œ	refdomain”jŸ
Œrefexplicit”‰j
j„
j

hj
ˆj
Œ	Transport”j
j
j
‰uh0hàh"Nh#Nh j‰
ubhŒ class.”…””}”(h j‰
h!hh"Nh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0hÇh"Œd/home/jforcier/Code/oss/paramiko/paramiko/proxy.py:docstring of paramiko.proxy.ProxyCommand.__init__”h#K
h j†
h!hubhŒ
field_list”“”)”}”(hhh]”hŒfield”“”)”}”(hhh]”(hŒ
field_name”“”)”}”(hŒ
Parameters”h]”hŒ
Parameters”…””}”(h jÆ
h!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jÄ
h jÁ
h"je
h#KubhŒ
field_body”“”)”}”(hhh]”hÈ)”}”(hŒPcommand_line (str) -- the command that should be executed and used as the proxy.”h]”(h<Œliteral_strong”“”)”}”(hŒcommand_line”h]”hŒcommand_line”…””}”(h jß
h!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”j
ˆuh0jÝ
h jÙ
ubhŒ (”…””}”(h jÙ
h!hh"Nh#Nubhá)”}”(hhh]”h<Œliteral_emphasis”“”)”}”(hŒstr”h]”hŒstr”…””}”(h jö
h!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jô
h jñ
ubah$}”(h&]”h(]”h*]”h,]”h.]”Œ	refdomain”Œpy”Œrefexplicit”‰Œreftype”Œobj”Œ	reftarget”jø
j
ˆuh0hàh jÙ
ubhŒ
)”…””}”(h jÙ
h!hh"Nh#NubhŒ – ”…””}”(h jÙ
h!hh"Nh#NubhŒ:the command that should be executed and used as the proxy.”…””}”(h jÙ
h!hh"Nh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0hÇh jÖ
ubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jÔ
h jÁ
ubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0j¿
h j¼
ubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jº
h j†
h!hh"Nh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0hÂh jP
h!hh"je
h#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”Œdomain”jŒobjtype”Œmethod”Œdesctype”jBŒnoindex”‰uh0h]h!hh hÄh"Nh#Nubh>)”}”(hhh]”h$}”(h&]”h(]”h*]”h,]”h.]”Œentries”]”(hJŒ+recv() (paramiko.proxy.ProxyCommand method)”Œ paramiko.proxy.ProxyCommand.recv”hNt”auh0h=h hÄh!hh"Nh#Nubh^)”}”(hhh]”(hc)”}”(hŒProxyCommand.recv(size)”h]”(hŒ)”}”(hŒrecv”h]”hŒrecv”…””}”(h jZh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h‹h jVh!hh"Œ`/home/jforcier/Code/oss/paramiko/paramiko/proxy.py:docstring of paramiko.proxy.ProxyCommand.recv”h#Nubhœ)”}”(hŒsize”h]”h¢)”}”(hŒsize”h]”hŒsize”…””}”(h jmh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h¡h jiubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h›h jVh!hh"jhh#Nubeh$}”(h&]”jQah(]”h*]”jQah,]”h.]”h½‰h¾Œparamiko.proxy”hÀhhLProxyCommand.recv”uh0hbh jSh!hh"jhh#NubhÃ)”}”(hhh]”(hÈ)”}”(hŒ4Read from the standard output of the forked program.”h]”hŒ4Read from the standard output of the forked program.”…””}”(h jŒh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0hÇh"Œ`/home/jforcier/Code/oss/paramiko/paramiko/proxy.py:docstring of paramiko.proxy.ProxyCommand.recv”h#K
h j‰h!hubj»
)”}”(hhh]”(jÀ
)”}”(hhh]”(jÅ
)”}”(hŒ
Parameters”h]”hŒ
Parameters”…””}”(h j¡h!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jÄ
h jžh"jhh#KubjÕ
)”}”(hhh]”hÈ)”}”(hŒ+size (int) -- how many chars should be read”h]”(jÞ
)”}”(hŒsize”h]”hŒsize”…””}”(h j¶h!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”j
ˆuh0jÝ
h j²ubhŒ (”…””}”(h j²h!hh"Nh#Nubhá)”}”(hhh]”jõ
)”}”(hŒint”h]”hŒint”…””}”(h jËh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jô
h jÈubah$}”(h&]”h(]”h*]”h,]”h.]”Œ	refdomain”Œpy”Œrefexplicit”‰Œreftype”jŒ	reftarget”jÍj
ˆuh0hàh j²ubhŒ
)”…””}”(h j²h!hh"Nh#NubhŒ – ”…””}”(h j²h!hh"Nh#NubhŒhow many chars should be read”…””}”(h j²h!hh"Nh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0hÇh j¯ubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jÔ
h jžubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0j¿
h j›ubjÀ
)”}”(hhh]”(jÅ
)”}”(hŒReturns”h]”hŒReturns”…””}”(h jh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jÄ
h jh"jhh#KubjÕ
)”}”(hhh]”hÈ)”}”(hŒ=the string of bytes read, which may be shorter than requested”h]”hŒ=the string of bytes read, which may be shorter than requested”…””}”(h jh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0hÇh jubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jÔ
h jubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0j¿
h j›ubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0jº
h j‰h!hh"Nh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0hÂh jSh!hh"jhh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”j@jàjAŒmethod”jCjBjD‰uh0h]h!hh hÄh"Nh#Nubh>)”}”(hhh]”h$}”(h&]”h(]”h*]”h,]”h.]”Œentries”]”(hJŒ+send() (paramiko.proxy.ProxyCommand method)”Œ paramiko.proxy.ProxyCommand.send”hNt”auh0h=h hÄh!hh"Nh#Nubh^)”}”(hhh]”(hc)”}”(hŒProxyCommand.send(content)”h]”(hŒ)”}”(hŒsend”h]”hŒsend”…””}”(h jXh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h‹h jTh!hh"Œ`/home/jforcier/Code/oss/paramiko/paramiko/proxy.py:docstring of paramiko.proxy.ProxyCommand.send”h#Nubhœ)”}”(hŒcontent”h]”h¢)”}”(hŒcontent”h]”hŒcontent”…””}”(h jkh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h¡h jgubah$}”(h&]”h(]”h*]”h,]”h.]”hxhyuh0h›h jTh!hh"jfh#Nubeh$}”(h&]”jOah(]”h*]”jOah,]”h.]”h½‰h¾Œparamiko.proxy”hÀhhLProxyCommand.send”uh0hbh jQh!hh"jfh#NubhÃ)”}”(hhh]”(hÈ)”}”(hŒ[Write the content received from the SSH client to the standard
input of the forked command.”h]”hŒ[Write the content received from the SSH client to the standard
input of the forked command.”…””}”(h jŠh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0hÇh"Œ`/home/jforcier/Code/oss/paramiko/paramiko/proxy.py:docstring of paramiko.proxy.ProxyCommand.send”h#K
h j‡h!hubj»
)”}”(hhh]”jÀ
)”}”(hhh]”(jÅ
)”}”(hŒ
Parameters”h]”hŒ
Parameters”…””}”(h jŸh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jÄ
h jœh"jfh#KubjÕ
)”}”(hhh]”hÈ)”}”(hŒ8content (str) -- string to be sent to the forked command”h]”(jÞ
)”}”(hŒcontent”h]”hŒcontent”…””}”(h j´h!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”j
ˆuh0jÝ
h j°ubhŒ (”…””}”(h j°h!hh"Nh#Nubhá)”}”(hhh]”jõ
)”}”(hŒstr”h]”hŒstr”…””}”(h jÉh!hh"Nh#Nubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jô
h jÆubah$}”(h&]”h(]”h*]”h,]”h.]”Œ	refdomain”Œpy”Œrefexplicit”‰Œreftype”jŒ	reftarget”jËj
ˆuh0hàh j°ubhŒ
)”…””}”(h j°h!hh"Nh#NubhŒ – ”…””}”(h j°h!hh"Nh#NubhŒ'string to be sent to the forked command”…””}”(h j°h!hh"Nh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0hÇh j­ubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jÔ
h jœubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0j¿
h j™ubah$}”(h&]”h(]”h*]”h,]”h.]”uh0jº
h j‡h!hh"Nh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0hÂh jQh!hh"jfh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”j@jÞjAŒmethod”jCjjD‰uh0h]h!hh hÄh"Nh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”uh0hÂh h_h!hh"hzh#Nubeh$}”(h&]”h(]”h*]”h,]”h.]”j@Œpy”jAŒclass”jCj jD‰uh0h]h!hh hh"Nh#Nubeh$}”(h&]”(Œmodule-paramiko.proxy”Œproxycommand-support”eh(]”h*]”Œproxycommand support”ah,]”h.]”uh0h	h hh!hh"h;h#Kubah$}”(h&]”h(]”h*]”h,]”h.]”Œsource”h;uh0h
Œcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hNŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒ
toc_backlinks”Œentry”Œfootnote_backlinks”K
Œ
sectnum_xform”K
Œstrip_comments”NŒstrip_elements_with_classes”NŒ
strip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”jMŒerror_encoding”ŒUTF-8”Œerror_encoding_error_handler”Œbackslashreplace”Œ
language_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œ
%”Œ
dump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”h;Œ_destination”NŒ
_config_files”]”Œfile_insertion_enabled”ˆŒraw_enabled”K
Œline_length_limit”M'Œpep_references”NŒpep_base_url”Œ https://www.python.org/dev/peps/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œhttps://tools.ietf.org/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”NŒcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œ
docinfo_xform”K
Œsectsubtitle_xform”‰Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒenv”NŒgettext_compact”ˆubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j'j$h[h[jN
jN
jQjQjOjOuŒ	nametypes”}”(j'‰h[ˆjN
ˆjQˆjOˆuh&}”(j$hj#hŒtarget”“”)”}”(hhh]”h$}”(h&]”j#ah(]”h*]”h,]”h.]”Œismod”ˆuh0jh hh!hh"hNh#K
ubh[hdjN
jS
jQjVjOjTuŒ
footnote_refs”}”Œ
citation_refs”}”Œ
autofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”K
Œsymbol_footnote_start”KŒ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nh!hub.