Drush: commands/core/ssh.drush.inc File Reference

  1. 7.x doxygen/html/ssh_8drush_8inc.html
  2. master doxygen/html/ssh_8drush_8inc.html
ssh.drush.inc File Reference

Go to the source code of this file.

Functions

 ssh_drush_command ()
 drush_ssh_site_ssh ($command=NULL)

Detailed Description

The drush site-ssh command for connecting to a remote alias' server via SSH, either for an interactive session or to run a shell command.

Definition in file ssh.drush.inc.

Function Documentation

drush_ssh_site_ssh (   $command = NULL)

Command callback.

Definition at line 35 of file ssh.drush.inc.

References drush_escapeshellarg(), drush_get_context(), drush_get_option(), drush_get_original_cli_args_and_options(), drush_set_context(), drush_set_error(), drush_shell_proc_build(), drush_shell_proc_open(), drush_sitealias_get_record(), and dt().

Here is the call graph for this function:

File

doxygen/html/ssh_8drush_8inc.html
View source
<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Drush: commands/core/ssh.drush.inc File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Drush
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_afac61274991793aa7e9133a8f4f291e.html">commands</a></li><li class="navelem"><a class="el" href="dir_5762b63965e3a68a35f77c23b4dd4668.html">core</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">ssh.drush.inc File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a href="ssh_8drush_8inc_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a59a4a75a22082958e2bb6df30849e586"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59a4a75a22082958e2bb6df30849e586"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>ssh_drush_command</b> ()</td></tr>
<tr class="memitem:a82a89cae3f9cd4bb76b6e9ac5bddb1cc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ssh_8drush_8inc.html#a82a89cae3f9cd4bb76b6e9ac5bddb1cc">drush_ssh_site_ssh</a> ($command=NULL)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The drush site-ssh command for connecting to a remote alias' server via SSH, either for an interactive session or to run a shell command. </p>

<p>Definition in file <a class="el" href="ssh_8drush_8inc_source.html">ssh.drush.inc</a>.</p>
</div><h2>Function Documentation</h2>
<a class="anchor" id="a82a89cae3f9cd4bb76b6e9ac5bddb1cc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">drush_ssh_site_ssh </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$command</em> = <code>NULL</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Command callback. </p>

<p>Definition at line <a class="el" href="ssh_8drush_8inc_source.html#l00035">35</a> of file <a class="el" href="ssh_8drush_8inc_source.html">ssh.drush.inc</a>.</p>

<p>References <a class="el" href="exec_8inc_source.html#l00312">drush_escapeshellarg()</a>, <a class="el" href="context_8inc_source.html#l00328">drush_get_context()</a>, <a class="el" href="context_8inc_source.html#l00405">drush_get_option()</a>, <a class="el" href="includes_2command_8inc_source.html#l01606">drush_get_original_cli_args_and_options()</a>, <a class="el" href="context_8inc_source.html#l00293">drush_set_context()</a>, <a class="el" href="drush_8inc_source.html#l01723">drush_set_error()</a>, <a class="el" href="exec_8inc_source.html#l00185">drush_shell_proc_build()</a>, <a class="el" href="exec_8inc_source.html#l00229">drush_shell_proc_open()</a>, <a class="el" href="sitealias_8inc_source.html#l00176">drush_sitealias_get_record()</a>, and <a class="el" href="output_8inc_source.html#l00145">dt()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="ssh_8drush_8inc_a82a89cae3f9cd4bb76b6e9ac5bddb1cc_cgraph.png" border="0" usemap="#ssh_8drush_8inc_a82a89cae3f9cd4bb76b6e9ac5bddb1cc_cgraph" alt=""/></div>
<map name="ssh_8drush_8inc_a82a89cae3f9cd4bb76b6e9ac5bddb1cc_cgraph" id="ssh_8drush_8inc_a82a89cae3f9cd4bb76b6e9ac5bddb1cc_cgraph">
<area shape="rect" id="node3" href="group__commandwrappers.html#gafc52f7e769d935b4d2462467cdf8d5ee" title="drush_escapeshellarg" alt="" coords="600,237,747,266"/><area shape="rect" id="node11" href="context_8inc.html#ad25559f8d7d753f636fbeac347c29fc5" title="drush_get_context" alt="" coords="1660,606,1788,636"/><area shape="rect" id="node13" href="context_8inc.html#afe91fb3e5219ecb2208c3b036b1f0cb8" title="drush_get_option" alt="" coords="817,450,937,480"/><area shape="rect" id="node20" href="includes_2command_8inc.html#a272d98da256f7ae2988f3aa7cb6b464b" title="drush_get_original\l_cli_args_and_options" alt="" coords="1241,104,1391,151"/><area shape="rect" id="node32" href="context_8inc.html#af983acfe90e7d7bbdbd67c57f93708ba" title="drush_set_context" alt="" coords="1033,661,1161,690"/><area shape="rect" id="node35" href="group__errorhandling.html#ga23fe9e1e8c1e5ade39256106044b6da4" title="drush_set_error" alt="" coords="821,185,933,214"/><area shape="rect" id="node47" href="group__commandwrappers.html#ga78a7ff5045fa4fc20c8e24dd2ba8d777" title="drush_shell_proc_build" alt="" coords="192,333,347,362"/><area shape="rect" id="node61" href="group__commandwrappers.html#ga3a1bb3ae751f14749ce1dbe4ec9c3288" title="drush_shell_proc_open" alt="" coords="395,513,549,542"/><area shape="rect" id="node67" href="sitealias_8inc.html#ac2f57b80441374522c4e4cdc3b7e0c2b" title="drush_sitealias_get\l_record" alt="" coords="203,1016,336,1063"/><area shape="rect" id="node113" href="group__outputfunctions.html#ga1218abcb1e27dd3bb412113d1e344d96" title="dt" alt="" coords="1079,717,1116,746"/><area shape="rect" id="node5" href="includes_2environment_8inc.html#a88114295372bcb0ca8dbb5f10b36368e" title="drush_is_windows" alt="" coords="1252,1248,1380,1277"/><area shape="rect" id="node7" href="group__commandwrappers.html#gac60b4740ceccf95b8e60d1896d93d2ab" title="_drush_escapeshellarg\l_windows" alt="" coords="800,238,955,284"/><area shape="rect" id="node9" href="group__commandwrappers.html#ga561ce790cc15caa5e1f0bfebc2546529" title="_drush_escapeshellarg\l_linux" alt="" coords="800,307,955,354"/><area shape="rect" id="node15" href="context_8inc.html#aee5781894bf828bfa508d9052553f809" title="_drush_get_option" alt="" coords="1033,450,1161,480"/><area shape="rect" id="node18" href="context_8inc.html#a9f6272c1a68141ce873c07aae3a316ac" title="drush_context_names" alt="" coords="1023,504,1172,533"/><area shape="rect" id="node23" href="context_8inc.html#a8fc57227375a540fea5314b154576354" title="drush_get_command" alt="" coords="1448,144,1589,173"/><area shape="rect" id="node26" href="group__dispatching.html#ga0edaf347ba975a7743a81eb3d7a4e38c" title="_drush_get_command\l_options" alt="" coords="1444,74,1593,120"/><area shape="rect" id="node28" href="includes_2command_8inc.html#a74995cc76034e90a39baee51111b20be" title="drush_command_invoke\l_all_ref" alt="" coords="1643,74,1805,120"/><area shape="rect" id="node30" href="includes_2command_8inc.html#a385cd0ff47c30105f965722a81987809" title="drush_command_implements" alt="" coords="1853,82,2045,112"/><area shape="rect" id="node38" href="includes_2command_8inc.html#a19eba9666aba673a64fbd78a2c5ef4f9" title="drush_command_invoke_all" alt="" coords="1007,185,1188,214"/><area shape="rect" id="node40" href="backend_8inc.html#a38490210d77373f3d8492caf4e9a3190" title="drush_backend_packet" alt="" coords="1239,504,1393,533"/><area shape="rect" id="node43" href="group__logging.html#gad820f489a93518301794ada4ff7816b6" title="drush_log" alt="" coords="1059,608,1136,637"/><area shape="rect" id="node49" href="group__commandwrappers.html#gae0975650ba125212c2666e58729f43cf" title="drush_remote_host" alt="" coords="405,254,539,284"/><area shape="rect" id="node52" href="context_8inc.html#add3af7aa09b1ccf49718577a8d7aa61d" title="drush_sitealias_get\l_option" alt="" coords="607,290,740,336"/><area shape="rect" id="node56" href="group__commandwrappers.html#ga1292121e5bdd4bf19ef4f944b16301ed" title="drush_os" alt="" coords="435,358,509,388"/><area shape="rect" id="node64" href="group__outputfunctions.html#ga63acbb94925d6d2693e235e966bba740" title="drush_print" alt="" coords="631,512,716,541"/><area shape="rect" id="node69" href="sitealias_8inc.html#a448de5768a772d33e44f86cfefe070ac" title="_drush_sitealias_get\l_record" alt="" coords="603,1238,744,1284"/><area shape="rect" id="node84" href="sitealias_8inc.html#ab58274361a02348f2d3ebf640686480b" title="drush_sitealias_uri\l_to_site_dir" alt="" coords="1032,1067,1163,1114"/><area shape="rect" id="node95" href="sitealias_8inc.html#a9e6067d5c022f5ee598fd0da886931a0" title="drush_sitealias_local\l_site_path" alt="" coords="807,1007,948,1054"/><area shape="rect" id="node103" href="sitealias_8inc.html#a49723d857350c5f3501001cede845fa5" title="drush_sitealias_lookup\l_alias_by_path" alt="" coords="395,855,549,902"/><area shape="rect" id="node72" href="group__filesystemfunctions.html#gafa80199035259ddf98fa300d6f646aa2" title="drush_is_absolute_path" alt="" coords="1019,1298,1176,1328"/><area shape="rect" id="node76" href="sitealias_8inc.html#a6812218f7e86fa00ec5c011768c63f48" title="_drush_sitealias_set\l_record_element" alt="" coords="807,1418,948,1464"/><area shape="rect" id="node78" href="includes_2environment_8inc.html#ad6ad0af63156033b1f7fe9a9409eaa7e" title="drush_valid_drupal_root" alt="" coords="799,1488,956,1517"/><area shape="rect" id="node81" href="sitealias_8inc.html#a38645e5a6d252e6f419db90c5e7e8739" title="_drush_sitealias_find\l_record_for_local_site" alt="" coords="803,1127,952,1174"/><area shape="rect" id="node90" href="sitealias_8inc.html#a03f4ae74a5e4854ac9ffee762cab07f3" title="drush_sitealias_add\l_to_alias_path" alt="" coords="809,1540,945,1587"/><area shape="rect" id="node98" href="sitealias_8inc.html#a1f4c706969fbd0d73d227a52d106b5f4" title="_drush_sitealias_add\l_static_defaults" alt="" coords="805,1348,949,1395"/><area shape="rect" id="node87" href="includes_2environment_8inc.html#a4f1fda8a8ff6eac8e1182b54e36f4466" title="drush_site_dir_lookup\l_from_hostname" alt="" coords="1445,1008,1592,1055"/><area shape="rect" id="node92" href="group__filesystemfunctions.html#ga4126321d45e8a9c454048869dd42a27c" title="drush_normalize_path" alt="" coords="1023,1485,1172,1514"/><area shape="rect" id="node100" href="sitealias_8inc.html#a96a1545df8b70035ba248ae3cb057d06" title="drush_sitealias_convert\l_db_from_db_url" alt="" coords="1019,1351,1176,1398"/><area shape="rect" id="node105" href="sitealias_8inc.html#a90a54eb940fe80e6e9e3faf12098cbac" title="drush_sitealias_quick\l_lookup_cached_alias\l_by_path" alt="" coords="599,768,748,832"/><area shape="rect" id="node120" href="sitealias_8inc.html#a33aa8e8ae8df2578bbed0d893e0b8f7a" title="_drush_sitealias_find\l_and_load_all_aliases" alt="" coords="803,770,952,816"/><area shape="rect" id="node132" href="sitealias_8inc.html#af5e2a5f32557a495b31c2a72bab9586b" title="drush_sitealias_cache\l_alias_by_path" alt="" coords="599,855,748,902"/><area shape="rect" id="node107" href="includes_2cache_8inc.html#a70613777c5e1a0e258bd0d8e213e0156" title="drush_get_cid" alt="" coords="827,864,928,893"/><area shape="rect" id="node110" href="includes_2cache_8inc.html#adc36ac3b562c67cbf1d7aab89c029694" title="drush_cache_get" alt="" coords="817,717,937,746"/><area shape="rect" id="node115" href="includes_2drupal_8inc.html#ad2ccab77d4bc8e7355186f26cd328ac0" title="drush_drupal_major\l_version" alt="" coords="1249,708,1383,755"/><area shape="rect" id="node117" href="includes_2drupal_8inc.html#a203e989fd043d054d774954e2b2dff21" title="drush_drupal_version" alt="" coords="1447,713,1591,742"/><area shape="rect" id="node122" href="sitealias_8inc.html#a9ccbaf4417b01e474a01db9c985fb103" title="_drush_sitealias_find\l_alias_files" alt="" coords="1025,828,1169,875"/><area shape="rect" id="node127" href="sitealias_8inc.html#a432d1b4f4f62b73ecf29aa29501571a7" title="_drush_sitealias_initialize\l_alias_record" alt="" coords="1012,948,1183,995"/></map>
</div>
</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 8 2014 09:04:56 for Drush by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>