<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Darcs.Ssh</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Darcs-Ssh.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Darcs-Ssh.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">darcs-2.8.3: a distributed, interactive, smart revision control system</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>darcs-devel@darcs.net</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Darcs.Ssh</p></div><div id="description"><p class="caption">Description</p><div class="doc empty"> </div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:copySSH">copySSH</a> :: <a href="Darcs-Flags.html#t:RemoteDarcs">RemoteDarcs</a> -> <a href="Darcs-URL.html#t:SshFilePath">SshFilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:SSHCmd">SSHCmd</a> <ul class="subs"><li>= <a href="#v:SSH">SSH</a> </li><li>| <a href="#v:SCP">SCP</a> </li><li>| <a href="#v:SFTP">SFTP</a> </li></ul></li><li class="src short"><a href="#v:getSSH">getSSH</a> :: <a href="Darcs-Ssh.html#t:SSHCmd">SSHCmd</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>, [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>])</li><li class="src short"><a href="#v:environmentHelpSsh">environmentHelpSsh</a> :: ([<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>], [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>])</li><li class="src short"><a href="#v:environmentHelpScp">environmentHelpScp</a> :: ([<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>], [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>])</li><li class="src short"><a href="#v:environmentHelpSshPort">environmentHelpSshPort</a> :: ([<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>], [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>])</li><li class="src short"><a href="#v:remoteDarcs">remoteDarcs</a> :: <a href="Darcs-Flags.html#t:RemoteDarcs">RemoteDarcs</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a name="v:copySSH" class="def">copySSH</a> :: <a href="Darcs-Flags.html#t:RemoteDarcs">RemoteDarcs</a> -> <a href="Darcs-URL.html#t:SshFilePath">SshFilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/Darcs-Ssh.html#copySSH" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:SSHCmd" class="def">SSHCmd</a> <a href="src/Darcs-Ssh.html#SSHCmd" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:SSH" class="def">SSH</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SCP" class="def">SCP</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SFTP" class="def">SFTP</a></td><td class="doc empty"> </td></tr></table></div></div><div class="top"><p class="src"><a name="v:getSSH" class="def">getSSH</a> :: <a href="Darcs-Ssh.html#t:SSHCmd">SSHCmd</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>, [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>])<a href="src/Darcs-Ssh.html#getSSH" class="link">Source</a></p><div class="doc"><p>Return the command and arguments needed to run an ssh command
First try the appropriate darcs environment variable and SSH_PORT
defaulting to <a href="ssh.html">ssh</a> and no specified port.
</p></div></div><div class="top"><p class="src"><a name="v:environmentHelpSsh" class="def">environmentHelpSsh</a> :: ([<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>], [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>])<a href="src/Darcs-Ssh.html#environmentHelpSsh" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:environmentHelpScp" class="def">environmentHelpScp</a> :: ([<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>], [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>])<a href="src/Darcs-Ssh.html#environmentHelpScp" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:environmentHelpSshPort" class="def">environmentHelpSshPort</a> :: ([<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>], [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>])<a href="src/Darcs-Ssh.html#environmentHelpSshPort" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:remoteDarcs" class="def">remoteDarcs</a> :: <a href="Darcs-Flags.html#t:RemoteDarcs">RemoteDarcs</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Ssh.html#remoteDarcs" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
