net-ssh-simple 1.7.2 → 1.7.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/coverage/.resultset.json +43 -43
- data/coverage/index.html +87 -87
- data/doc/Net.html +38 -38
- data/doc/Net/SSH.html +38 -38
- data/doc/Net/SSH/Simple.html +115 -115
- data/doc/Net/SSH/Simple/Error.html +54 -53
- data/doc/Net/SSH/Simple/Result.html +79 -78
- data/doc/_index.html +28 -31
- data/doc/class_list.html +24 -31
- data/doc/css/full_list.css +32 -31
- data/doc/css/style.css +251 -91
- data/doc/file.README.html +34 -37
- data/doc/file_list.html +26 -30
- data/doc/frames.html +7 -16
- data/doc/index.html +34 -37
- data/doc/js/app.js +106 -77
- data/doc/js/full_list.js +170 -135
- data/doc/method_list.html +188 -128
- data/doc/top-level-namespace.html +34 -36
- data/lib/net/ssh/simple/version.rb +1 -1
- data/net-ssh-simple.gemspec +1 -1
- metadata +4 -5
data/doc/file.README.html
CHANGED
@@ -1,12 +1,12 @@
|
|
1
|
-
<!DOCTYPE html
|
2
|
-
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
4
3
|
<head>
|
5
|
-
<meta
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
6
|
<title>
|
7
7
|
File: README
|
8
8
|
|
9
|
-
— Documentation by YARD 0.
|
9
|
+
— Documentation by YARD 0.9.12
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -15,9 +15,8 @@
|
|
15
15
|
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
16
|
|
17
17
|
<script type="text/javascript" charset="utf-8">
|
18
|
-
|
18
|
+
pathId = "README";
|
19
19
|
relpath = '';
|
20
|
-
framesUrl = "frames.html#!file.README.html";
|
21
20
|
</script>
|
22
21
|
|
23
22
|
|
@@ -28,40 +27,37 @@
|
|
28
27
|
|
29
28
|
</head>
|
30
29
|
<body>
|
31
|
-
<div
|
32
|
-
<
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="file_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
33
38
|
|
34
39
|
<a href="_index.html">Index</a> »
|
35
40
|
<span class="title">File: README</span>
|
36
41
|
|
37
|
-
|
38
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
39
42
|
</div>
|
40
43
|
|
41
|
-
|
44
|
+
<div id="search">
|
42
45
|
|
43
46
|
<a class="full_list_link" id="class_list_link"
|
44
47
|
href="class_list.html">
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
</a>
|
52
|
-
|
53
|
-
<a class="full_list_link" id="file_list_link"
|
54
|
-
href="file_list.html">
|
55
|
-
File List
|
48
|
+
|
49
|
+
<svg width="24" height="24">
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
</svg>
|
56
54
|
</a>
|
57
55
|
|
58
56
|
</div>
|
59
|
-
|
60
|
-
|
57
|
+
<div class="clear"></div>
|
58
|
+
</div>
|
61
59
|
|
62
|
-
|
63
|
-
|
64
|
-
<div id="content"><div id='filecontents'>
|
60
|
+
<div id="content"><div id='filecontents'>
|
65
61
|
<h1 id="label-Net-3A-3ASSH-3A-3ASimple+-3Cimg+src-3D-22https-3A-2F-2Fgemnasium.com-2Fbusyloop-2Fnet-ssh-simple.png-22+alt-3D-22Dependency+Status-22+-2F-3E+-3Cimg+src-3D-22https-3A-2F-2Fbadge.fury.io-2Frb-2Fnet-ssh-simple.svg-22+alt-3D-22Gem+Version-22+-2F-3E">Net::SSH::Simple <a href="https://gemnasium.com/busyloop/net-ssh-simple"><img src="https://gemnasium.com/busyloop/net-ssh-simple.png" alt="Dependency Status" /></a> <a href="https://badge.fury.io/rb/net-ssh-simple"><img src="https://badge.fury.io/rb/net-ssh-simple.svg" alt="Gem Version" /></a></h1>
|
66
62
|
|
67
63
|
<p>Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.</p>
|
@@ -108,7 +104,7 @@ more readable version with syntax highlighting.</p>
|
|
108
104
|
|
109
105
|
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>net/ssh/simple</span><span class='tstring_end'>'</span></span>
|
110
106
|
|
111
|
-
<span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_sync'>sync</span> <span class='kw'>do</span>
|
107
|
+
<span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_sync'><span class='object_link'><a href="Net/SSH/Simple.html#sync-class_method" title="Net::SSH::Simple.sync (method)">sync</a></span></span> <span class='kw'>do</span>
|
112
108
|
<span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example1.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World."</span><span class='tstring_end'>'</span></span>
|
113
109
|
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_stdout'>stdout</span> <span class='comment'>#=> "Hello World."
|
114
110
|
</span>
|
@@ -121,11 +117,11 @@ more readable version with syntax highlighting.</p>
|
|
121
117
|
|
122
118
|
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>net/ssh/simple</span><span class='tstring_end'>'</span></span>
|
123
119
|
|
124
|
-
<span class='id identifier rubyid_t1'>t1</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_async'>async</span> <span class='kw'>do</span>
|
120
|
+
<span class='id identifier rubyid_t1'>t1</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_async'><span class='object_link'><a href="Net/SSH/Simple.html#async-class_method" title="Net::SSH::Simple.async (method)">async</a></span></span> <span class='kw'>do</span>
|
125
121
|
<span class='id identifier rubyid_scp_put'>scp_put</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example1.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/local_foo</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/remote_bar</span><span class='tstring_end'>'</span></span>
|
126
122
|
<span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example3.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World A."</span><span class='tstring_end'>'</span></span>
|
127
123
|
<span class='kw'>end</span>
|
128
|
-
<span class='id identifier rubyid_t2'>t2</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_async'>async</span> <span class='kw'>do</span>
|
124
|
+
<span class='id identifier rubyid_t2'>t2</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_async'><span class='object_link'><a href="Net/SSH/Simple.html#async-class_method" title="Net::SSH::Simple.async (method)">async</a></span></span> <span class='kw'>do</span>
|
129
125
|
<span class='id identifier rubyid_scp_get'>scp_get</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example6.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/remote_foo</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/local_bar</span><span class='tstring_end'>'</span></span>
|
130
126
|
<span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example7.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World B."</span><span class='tstring_end'>'</span></span>
|
131
127
|
<span class='kw'>end</span>
|
@@ -140,7 +136,7 @@ more readable version with syntax highlighting.</p>
|
|
140
136
|
|
141
137
|
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>net/ssh/simple</span><span class='tstring_end'>'</span></span>
|
142
138
|
|
143
|
-
<span class='id identifier rubyid_s'>s</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
139
|
+
<span class='id identifier rubyid_s'>s</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Net/SSH/Simple.html#initialize-instance_method" title="Net::SSH::Simple#initialize (method)">new</a></span></span>
|
144
140
|
<span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example1.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World."</span><span class='tstring_end'>'</span></span>
|
145
141
|
<span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_scp_put'>scp_put</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example2.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/local_foo</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/remote_bar</span><span class='tstring_end'>'</span></span>
|
146
142
|
<span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_scp_get'>scp_get</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example3.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/remote_foo</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/local_bar</span><span class='tstring_end'>'</span></span>
|
@@ -162,7 +158,7 @@ following idiom will provide the best performance:</p>
|
|
162
158
|
|
163
159
|
<span class='comment'># Create and re-use one instance per thread, with a default username.
|
164
160
|
</span><span class='kw'>def</span> <span class='id identifier rubyid_ss'>ss</span>
|
165
|
-
<span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:simplessh</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='symbol'>:user</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>bob</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
161
|
+
<span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:simplessh</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Net/SSH/Simple.html#initialize-instance_method" title="Net::SSH::Simple#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='symbol'>:user</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>bob</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
166
162
|
<span class='kw'>end</span>
|
167
163
|
|
168
164
|
<span class='comment'># Strictly optional. You may use this method to close the
|
@@ -200,7 +196,7 @@ following idiom will provide the best performance:</p>
|
|
200
196
|
</span> <span class='comment'># that some hosts will be connected to only once during
|
201
197
|
</span> <span class='comment'># the lifetime of a thread (there's no point in keeping
|
202
198
|
</span> <span class='comment'># these open).
|
203
|
-
</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_sync'>sync</span> <span class='kw'>do</span>
|
199
|
+
</span> <span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_sync'><span class='object_link'><a href="Net/SSH/Simple.html#sync-class_method" title="Net::SSH::Simple.sync (method)">sync</a></span></span> <span class='kw'>do</span>
|
204
200
|
<span class='comment'># opens connections to example8.com, example9.com
|
205
201
|
</span> <span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example8.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World."</span><span class='tstring_end'>'</span></span>
|
206
202
|
<span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example9.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World."</span><span class='tstring_end'>'</span></span>
|
@@ -253,11 +249,12 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
253
249
|
DEALINGS IN THE SOFTWARE.</p>
|
254
250
|
</div></div>
|
255
251
|
|
256
|
-
|
257
|
-
Generated on
|
252
|
+
<div id="footer">
|
253
|
+
Generated on Thu Dec 21 01:55:38 2017 by
|
258
254
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
259
|
-
0.
|
255
|
+
0.9.12 (ruby-2.4.0).
|
260
256
|
</div>
|
261
257
|
|
258
|
+
</div>
|
262
259
|
</body>
|
263
260
|
</html>
|
data/doc/file_list.html
CHANGED
@@ -1,8 +1,8 @@
|
|
1
|
-
<!DOCTYPE html
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
1
|
+
<!DOCTYPE html>
|
3
2
|
<html>
|
4
3
|
<head>
|
5
|
-
<meta
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
|
+
<meta charset="utf-8" />
|
6
6
|
|
7
7
|
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
8
|
|
@@ -19,41 +19,37 @@
|
|
19
19
|
<base id="base_target" target="_parent" />
|
20
20
|
</head>
|
21
21
|
<body>
|
22
|
-
<script type="text/javascript" charset="utf-8">
|
23
|
-
var hasFrames = false;
|
24
|
-
try {
|
25
|
-
hasFrames = window.top.frames.main ? true : false;
|
26
|
-
} catch (e) { }
|
27
|
-
if (hasFrames) {
|
28
|
-
document.getElementById('base_target').target = 'main';
|
29
|
-
document.body.className = 'frames';
|
30
|
-
}
|
31
|
-
</script>
|
32
22
|
<div id="content">
|
33
|
-
<
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
23
|
+
<div class="fixed_header">
|
24
|
+
<h1 id="full_list_header">File List</h1>
|
25
|
+
<div id="full_list_nav">
|
26
|
+
|
27
|
+
<span><a target="_self" href="class_list.html">
|
28
|
+
Classes
|
29
|
+
</a></span>
|
30
|
+
|
31
|
+
<span><a target="_self" href="method_list.html">
|
32
|
+
Methods
|
33
|
+
</a></span>
|
34
|
+
|
35
|
+
<span><a target="_self" href="file_list.html">
|
36
|
+
Files
|
37
|
+
</a></span>
|
38
|
+
|
39
|
+
</div>
|
40
|
+
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
48
42
|
</div>
|
49
|
-
<div id="search">Search: <input type="text" /></div>
|
50
43
|
|
51
44
|
<ul id="full_list" class="file">
|
52
45
|
|
53
46
|
|
54
|
-
<li
|
47
|
+
<li id="object_README" class="odd">
|
48
|
+
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
49
|
+
</li>
|
55
50
|
|
56
51
|
|
52
|
+
|
57
53
|
</ul>
|
58
54
|
</div>
|
59
55
|
</body>
|
data/doc/frames.html
CHANGED
@@ -1,26 +1,17 @@
|
|
1
|
-
<!DOCTYPE html
|
2
|
-
|
3
|
-
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
5
3
|
<head>
|
6
|
-
|
7
|
-
<title>Documentation by YARD 0.
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<title>Documentation by YARD 0.9.12</title>
|
8
6
|
</head>
|
9
7
|
<script type="text/javascript" charset="utf-8">
|
10
|
-
window.onload = function() {
|
11
8
|
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
12
9
|
var name = match ? match[1] : 'index.html';
|
13
10
|
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
14
|
-
|
15
|
-
'<frame name="list" src="class_list.html" />' +
|
16
|
-
'<frame name="main" src="' + escape(name) + '" />' +
|
17
|
-
'</frameset>');
|
18
|
-
}
|
11
|
+
window.top.location = name;
|
19
12
|
</script>
|
20
13
|
<noscript>
|
21
|
-
<
|
22
|
-
|
23
|
-
<frame name="main" src="index.html" />
|
24
|
-
</frameset>
|
14
|
+
<h1>Oops!</h1>
|
15
|
+
<h2>YARD requires JavaScript!</h2>
|
25
16
|
</noscript>
|
26
17
|
</html>
|
data/doc/index.html
CHANGED
@@ -1,12 +1,12 @@
|
|
1
|
-
<!DOCTYPE html
|
2
|
-
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
4
3
|
<head>
|
5
|
-
<meta
|
4
|
+
<meta charset="UTF-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
6
|
<title>
|
7
7
|
File: README
|
8
8
|
|
9
|
-
— Documentation by YARD 0.
|
9
|
+
— Documentation by YARD 0.9.12
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -15,9 +15,8 @@
|
|
15
15
|
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
16
|
|
17
17
|
<script type="text/javascript" charset="utf-8">
|
18
|
-
|
18
|
+
pathId = "README";
|
19
19
|
relpath = '';
|
20
|
-
framesUrl = "frames.html#!file.README.html";
|
21
20
|
</script>
|
22
21
|
|
23
22
|
|
@@ -28,40 +27,37 @@
|
|
28
27
|
|
29
28
|
</head>
|
30
29
|
<body>
|
31
|
-
<div
|
32
|
-
<
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
33
38
|
|
34
39
|
<a href="_index.html">Index</a> »
|
35
40
|
<span class="title">File: README</span>
|
36
41
|
|
37
|
-
|
38
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
39
42
|
</div>
|
40
43
|
|
41
|
-
|
44
|
+
<div id="search">
|
42
45
|
|
43
46
|
<a class="full_list_link" id="class_list_link"
|
44
47
|
href="class_list.html">
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
</a>
|
52
|
-
|
53
|
-
<a class="full_list_link" id="file_list_link"
|
54
|
-
href="file_list.html">
|
55
|
-
File List
|
48
|
+
|
49
|
+
<svg width="24" height="24">
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
</svg>
|
56
54
|
</a>
|
57
55
|
|
58
56
|
</div>
|
59
|
-
|
60
|
-
|
57
|
+
<div class="clear"></div>
|
58
|
+
</div>
|
61
59
|
|
62
|
-
|
63
|
-
|
64
|
-
<div id="content"><div id='filecontents'>
|
60
|
+
<div id="content"><div id='filecontents'>
|
65
61
|
<h1 id="label-Net-3A-3ASSH-3A-3ASimple+-3Cimg+src-3D-22https-3A-2F-2Fgemnasium.com-2Fbusyloop-2Fnet-ssh-simple.png-22+alt-3D-22Dependency+Status-22+-2F-3E+-3Cimg+src-3D-22https-3A-2F-2Fbadge.fury.io-2Frb-2Fnet-ssh-simple.svg-22+alt-3D-22Gem+Version-22+-2F-3E">Net::SSH::Simple <a href="https://gemnasium.com/busyloop/net-ssh-simple"><img src="https://gemnasium.com/busyloop/net-ssh-simple.png" alt="Dependency Status" /></a> <a href="https://badge.fury.io/rb/net-ssh-simple"><img src="https://badge.fury.io/rb/net-ssh-simple.svg" alt="Gem Version" /></a></h1>
|
66
62
|
|
67
63
|
<p>Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.</p>
|
@@ -108,7 +104,7 @@ more readable version with syntax highlighting.</p>
|
|
108
104
|
|
109
105
|
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>net/ssh/simple</span><span class='tstring_end'>'</span></span>
|
110
106
|
|
111
|
-
<span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_sync'>sync</span> <span class='kw'>do</span>
|
107
|
+
<span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_sync'><span class='object_link'><a href="Net/SSH/Simple.html#sync-class_method" title="Net::SSH::Simple.sync (method)">sync</a></span></span> <span class='kw'>do</span>
|
112
108
|
<span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example1.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World."</span><span class='tstring_end'>'</span></span>
|
113
109
|
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_stdout'>stdout</span> <span class='comment'>#=> "Hello World."
|
114
110
|
</span>
|
@@ -121,11 +117,11 @@ more readable version with syntax highlighting.</p>
|
|
121
117
|
|
122
118
|
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>net/ssh/simple</span><span class='tstring_end'>'</span></span>
|
123
119
|
|
124
|
-
<span class='id identifier rubyid_t1'>t1</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_async'>async</span> <span class='kw'>do</span>
|
120
|
+
<span class='id identifier rubyid_t1'>t1</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_async'><span class='object_link'><a href="Net/SSH/Simple.html#async-class_method" title="Net::SSH::Simple.async (method)">async</a></span></span> <span class='kw'>do</span>
|
125
121
|
<span class='id identifier rubyid_scp_put'>scp_put</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example1.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/local_foo</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/remote_bar</span><span class='tstring_end'>'</span></span>
|
126
122
|
<span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example3.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World A."</span><span class='tstring_end'>'</span></span>
|
127
123
|
<span class='kw'>end</span>
|
128
|
-
<span class='id identifier rubyid_t2'>t2</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_async'>async</span> <span class='kw'>do</span>
|
124
|
+
<span class='id identifier rubyid_t2'>t2</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_async'><span class='object_link'><a href="Net/SSH/Simple.html#async-class_method" title="Net::SSH::Simple.async (method)">async</a></span></span> <span class='kw'>do</span>
|
129
125
|
<span class='id identifier rubyid_scp_get'>scp_get</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example6.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/remote_foo</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/local_bar</span><span class='tstring_end'>'</span></span>
|
130
126
|
<span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example7.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World B."</span><span class='tstring_end'>'</span></span>
|
131
127
|
<span class='kw'>end</span>
|
@@ -140,7 +136,7 @@ more readable version with syntax highlighting.</p>
|
|
140
136
|
|
141
137
|
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>net/ssh/simple</span><span class='tstring_end'>'</span></span>
|
142
138
|
|
143
|
-
<span class='id identifier rubyid_s'>s</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
139
|
+
<span class='id identifier rubyid_s'>s</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Net/SSH/Simple.html#initialize-instance_method" title="Net::SSH::Simple#initialize (method)">new</a></span></span>
|
144
140
|
<span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example1.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World."</span><span class='tstring_end'>'</span></span>
|
145
141
|
<span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_scp_put'>scp_put</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example2.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/local_foo</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/remote_bar</span><span class='tstring_end'>'</span></span>
|
146
142
|
<span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_scp_get'>scp_get</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example3.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/remote_foo</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tmp/local_bar</span><span class='tstring_end'>'</span></span>
|
@@ -162,7 +158,7 @@ following idiom will provide the best performance:</p>
|
|
162
158
|
|
163
159
|
<span class='comment'># Create and re-use one instance per thread, with a default username.
|
164
160
|
</span><span class='kw'>def</span> <span class='id identifier rubyid_ss'>ss</span>
|
165
|
-
<span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:simplessh</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='symbol'>:user</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>bob</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
161
|
+
<span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:simplessh</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Net/SSH/Simple.html#initialize-instance_method" title="Net::SSH::Simple#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='symbol'>:user</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>bob</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
166
162
|
<span class='kw'>end</span>
|
167
163
|
|
168
164
|
<span class='comment'># Strictly optional. You may use this method to close the
|
@@ -200,7 +196,7 @@ following idiom will provide the best performance:</p>
|
|
200
196
|
</span> <span class='comment'># that some hosts will be connected to only once during
|
201
197
|
</span> <span class='comment'># the lifetime of a thread (there's no point in keeping
|
202
198
|
</span> <span class='comment'># these open).
|
203
|
-
</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>SSH</span><span class='op'>::</span><span class='const'>Simple</span><span class='period'>.</span><span class='id identifier rubyid_sync'>sync</span> <span class='kw'>do</span>
|
199
|
+
</span> <span class='const'><span class='object_link'><a href="Net.html" title="Net (module)">Net</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH.html" title="Net::SSH (module)">SSH</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Net/SSH/Simple.html" title="Net::SSH::Simple (class)">Simple</a></span></span><span class='period'>.</span><span class='id identifier rubyid_sync'><span class='object_link'><a href="Net/SSH/Simple.html#sync-class_method" title="Net::SSH::Simple.sync (method)">sync</a></span></span> <span class='kw'>do</span>
|
204
200
|
<span class='comment'># opens connections to example8.com, example9.com
|
205
201
|
</span> <span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example8.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World."</span><span class='tstring_end'>'</span></span>
|
206
202
|
<span class='id identifier rubyid_ssh'>ssh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example9.com</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>echo "Hello World."</span><span class='tstring_end'>'</span></span>
|
@@ -253,11 +249,12 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
253
249
|
DEALINGS IN THE SOFTWARE.</p>
|
254
250
|
</div></div>
|
255
251
|
|
256
|
-
|
257
|
-
Generated on
|
252
|
+
<div id="footer">
|
253
|
+
Generated on Thu Dec 21 01:55:38 2017 by
|
258
254
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
259
|
-
0.
|
255
|
+
0.9.12 (ruby-2.4.0).
|
260
256
|
</div>
|
261
257
|
|
258
|
+
</div>
|
262
259
|
</body>
|
263
260
|
</html>
|
data/doc/js/app.js
CHANGED
@@ -1,3 +1,9 @@
|
|
1
|
+
(function() {
|
2
|
+
|
3
|
+
var localStorage = {}, sessionStorage = {};
|
4
|
+
try { localStorage = window.localStorage; } catch (e) { }
|
5
|
+
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
6
|
+
|
1
7
|
function createSourceLinks() {
|
2
8
|
$('.method_details_list .source_code').
|
3
9
|
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
@@ -16,7 +22,7 @@ function createDefineLinks() {
|
|
16
22
|
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
17
23
|
$('.toggleDefines').toggle(function() {
|
18
24
|
tHeight = $(this).parent().prev().height();
|
19
|
-
$(this).prev().
|
25
|
+
$(this).prev().css('display', 'inline');
|
20
26
|
$(this).parent().prev().height($(this).parent().height());
|
21
27
|
$(this).text("(less)");
|
22
28
|
},
|
@@ -42,29 +48,39 @@ function createFullTreeLinks() {
|
|
42
48
|
});
|
43
49
|
}
|
44
50
|
|
45
|
-
function
|
46
|
-
$('dl.box dd.r1, dl.box dd.r2').each(function() {
|
47
|
-
$(this).prev().height($(this).height());
|
48
|
-
});
|
49
|
-
}
|
50
|
-
|
51
|
-
function searchFrameLinks() {
|
51
|
+
function searchFrameButtons() {
|
52
52
|
$('.full_list_link').click(function() {
|
53
53
|
toggleSearchFrame(this, $(this).attr('href'));
|
54
54
|
return false;
|
55
55
|
});
|
56
|
+
window.addEventListener('message', function(e) {
|
57
|
+
if (e.data === 'navEscape') {
|
58
|
+
$('#nav').slideUp(100);
|
59
|
+
$('#search a').removeClass('active inactive');
|
60
|
+
$(window).focus();
|
61
|
+
}
|
62
|
+
});
|
63
|
+
|
64
|
+
$(window).resize(function() {
|
65
|
+
if ($('#search:visible').length === 0) {
|
66
|
+
$('#nav').removeAttr('style');
|
67
|
+
$('#search a').removeClass('active inactive');
|
68
|
+
$(window).focus();
|
69
|
+
}
|
70
|
+
});
|
56
71
|
}
|
57
72
|
|
58
73
|
function toggleSearchFrame(id, link) {
|
59
|
-
var frame = $('#
|
74
|
+
var frame = $('#nav');
|
60
75
|
$('#search a').removeClass('active').addClass('inactive');
|
61
|
-
if (frame.attr('src')
|
76
|
+
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
62
77
|
frame.slideUp(100);
|
63
78
|
$('#search a').removeClass('active inactive');
|
64
79
|
}
|
65
80
|
else {
|
66
81
|
$(id).addClass('active').removeClass('inactive');
|
67
|
-
frame.attr('src'
|
82
|
+
if (frame.attr('src') !== link) frame.attr('src', link);
|
83
|
+
frame.slideDown(100);
|
68
84
|
}
|
69
85
|
}
|
70
86
|
|
@@ -74,43 +90,10 @@ function linkSummaries() {
|
|
74
90
|
});
|
75
91
|
}
|
76
92
|
|
77
|
-
function framesInit() {
|
78
|
-
if (hasFrames) {
|
79
|
-
document.body.className = 'frames';
|
80
|
-
$('#menu .noframes a').attr('href', document.location);
|
81
|
-
try {
|
82
|
-
window.top.document.title = $('html head title').text();
|
83
|
-
} catch(error) {
|
84
|
-
// some browsers will not allow this when serving from file://
|
85
|
-
// but we don't want to stop the world.
|
86
|
-
}
|
87
|
-
}
|
88
|
-
else {
|
89
|
-
$('#menu .noframes a').text('frames').attr('href', framesUrl);
|
90
|
-
}
|
91
|
-
}
|
92
|
-
|
93
|
-
function keyboardShortcuts() {
|
94
|
-
if (window.top.frames.main) return;
|
95
|
-
$(document).keypress(function(evt) {
|
96
|
-
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
97
|
-
if (typeof evt.target !== "undefined" &&
|
98
|
-
(evt.target.nodeName == "INPUT" ||
|
99
|
-
evt.target.nodeName == "TEXTAREA")) return;
|
100
|
-
switch (evt.charCode) {
|
101
|
-
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
102
|
-
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
103
|
-
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
104
|
-
default: break;
|
105
|
-
}
|
106
|
-
});
|
107
|
-
}
|
108
|
-
|
109
93
|
function summaryToggle() {
|
110
|
-
$('.summary_toggle').click(function() {
|
111
|
-
|
112
|
-
|
113
|
-
}
|
94
|
+
$('.summary_toggle').click(function(e) {
|
95
|
+
e.preventDefault();
|
96
|
+
localStorage.summaryCollapsed = $(this).text();
|
114
97
|
$('.summary_toggle').each(function() {
|
115
98
|
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
116
99
|
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
@@ -132,18 +115,9 @@ function summaryToggle() {
|
|
132
115
|
});
|
133
116
|
return false;
|
134
117
|
});
|
135
|
-
if (localStorage) {
|
136
|
-
|
137
|
-
|
138
|
-
}
|
139
|
-
else localStorage.summaryCollapsed = "expand";
|
140
|
-
}
|
141
|
-
}
|
142
|
-
|
143
|
-
function fixOutsideWorldLinks() {
|
144
|
-
$('a').each(function() {
|
145
|
-
if (window.location.host != this.host) this.target = '_parent';
|
146
|
-
});
|
118
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
119
|
+
$('.summary_toggle').first().click();
|
120
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
147
121
|
}
|
148
122
|
|
149
123
|
function generateTOC() {
|
@@ -185,7 +159,7 @@ function generateTOC() {
|
|
185
159
|
lastTag = thisTag;
|
186
160
|
});
|
187
161
|
if (!show) return;
|
188
|
-
html = '<div id="toc"><p class="title"><a
|
162
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
189
163
|
$('#content').prepend(html);
|
190
164
|
$('#toc').append(_toc);
|
191
165
|
$('#toc .hide_toc').toggle(function() {
|
@@ -197,23 +171,78 @@ function generateTOC() {
|
|
197
171
|
$('#toc').toggleClass('hidden');
|
198
172
|
$('#toc .title small').toggle();
|
199
173
|
});
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
174
|
+
}
|
175
|
+
|
176
|
+
function navResizeFn(e) {
|
177
|
+
if (e.which !== 1) {
|
178
|
+
navResizeFnStop();
|
179
|
+
return;
|
180
|
+
}
|
181
|
+
|
182
|
+
sessionStorage.navWidth = e.pageX.toString();
|
183
|
+
$('.nav_wrap').css('width', e.pageX);
|
184
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
185
|
+
}
|
186
|
+
|
187
|
+
function navResizeFnStop() {
|
188
|
+
$(window).unbind('mousemove', navResizeFn);
|
189
|
+
window.removeEventListener('message', navMessageFn, false);
|
190
|
+
}
|
191
|
+
|
192
|
+
function navMessageFn(e) {
|
193
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
194
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
195
|
+
}
|
196
|
+
|
197
|
+
function navResizer() {
|
198
|
+
$('#resizer').mousedown(function(e) {
|
199
|
+
e.preventDefault();
|
200
|
+
$(window).mousemove(navResizeFn);
|
201
|
+
window.addEventListener('message', navMessageFn, false);
|
206
202
|
});
|
203
|
+
$(window).mouseup(navResizeFnStop);
|
204
|
+
|
205
|
+
if (sessionStorage.navWidth) {
|
206
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
207
|
+
}
|
208
|
+
}
|
209
|
+
|
210
|
+
function navExpander() {
|
211
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
212
|
+
function postMessage() {
|
213
|
+
if (done) return;
|
214
|
+
clearTimeout(timer);
|
215
|
+
var opts = { action: 'expand', path: pathId };
|
216
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
217
|
+
done = true;
|
218
|
+
}
|
219
|
+
|
220
|
+
window.addEventListener('message', function(event) {
|
221
|
+
if (event.data === 'navReady') postMessage();
|
222
|
+
return false;
|
223
|
+
}, false);
|
224
|
+
}
|
225
|
+
|
226
|
+
function mainFocus() {
|
227
|
+
var hash = window.location.hash;
|
228
|
+
if (hash !== '' && $(hash)[0]) {
|
229
|
+
$(hash)[0].scrollIntoView();
|
230
|
+
}
|
231
|
+
|
232
|
+
setTimeout(function() { $('#main').focus(); }, 10);
|
207
233
|
}
|
208
234
|
|
209
|
-
$(
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
|
235
|
+
$(document).ready(function() {
|
236
|
+
navResizer();
|
237
|
+
navExpander();
|
238
|
+
createSourceLinks();
|
239
|
+
createDefineLinks();
|
240
|
+
createFullTreeLinks();
|
241
|
+
searchFrameButtons();
|
242
|
+
linkSummaries();
|
243
|
+
summaryToggle();
|
244
|
+
generateTOC();
|
245
|
+
mainFocus();
|
246
|
+
});
|
247
|
+
|
248
|
+
})();
|