-
Notifications
You must be signed in to change notification settings - Fork 0
/
STAFLibrary.html
205 lines (200 loc) · 4.54 KB
/
STAFLibrary.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>STAFLibrary</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style media="all" type="text/css">
body {
background: white;
color: black;
font-size: small;
font-family: sans-serif;
padding: 0.1em 0.5em;
}
a.name, span.name {
font-style: italic;
}
a, a:link, a:visited {
color: #c30;
}
a:hover, a:active {
text-decoration: underline;
color: black;
}
div.shortcuts {
margin: 1em 0em;
font-size: 0.9em;
}
div.shortcuts a {
text-decoration: none;
color: black;
}
div.shortcuts a:hover {
text-decoration: underline;
}
table.keywords {
border: 2px solid black;
border-collapse: collapse;
empty-cells: show;
margin: 0.3em 0em;
width: 100%;
}
table.keywords th, table.keywords td {
border: 2px solid black;
padding: 0.2em;
vertical-align: top;
}
table.keywords th {
background: #bbb;
color: black;
}
table.keywords td.kw {
width: 150px;
font-weight: bold;
}
table.keywords td.arg {
width: 300px;
font-style: italic;
}
table.doc {
border: 1px solid black;
background: transparent;
border-collapse: collapse;
empty-cells: show;
font-size: 0.85em;
}
table.doc td {
border: 1px solid black;
padding: 0.1em 0.3em;
height: 1.2em;
}
#footer {
font-size: 0.9em;
}
</style>
<style media="print" type="text/css">
body {
margin: 0px 1px;
padding: 0px;
font-size: 10px;
}
a {
text-decoration: none;
}
</style>
</head>
<body>
<h1>STAFLibrary</h1>
<b>Version:</b> 1.0<br>
<b>Scope:</b> test suite<br>
<b>Named arguments: </b>
supported
<h2 id="introduction">Introduction</h2>
<p>STAF Library is a test library for robot framework.</p>
<h2>Shortcuts</h2>
<div class='shortcuts'>
<a href="#Copy Directory Remote" title="Copy local directory to the remote machine">Copy Directory Remote</a>
·
<a href="#Copy File Remote" title="Copy local file to remote machine">Copy File Remote</a>
·
<a href="#Release Staf Handle" title="">Release Staf Handle</a>
·
<a href="#Run Command Remote" title="run command on remote machine">Run Command Remote</a>
·
<a href="#Staf Conf" title="">Staf Conf</a>
</div>
<h2>Keywords</h2>
<table border="1" class="keywords">
<tr>
<th class="kw">Keyword</th>
<th class="arg">Arguments</th>
<th class="doc">Documentation</th>
</tr>
<tr>
<td class="kw"><a name="Copy Directory Remote"></a>Copy Directory Remote</td>
<td class="arg">source, dst, dst_ip=None</td>
<td class="doc">Copy local directory to the remote machine<br />
<br />
Parameters:<br />
<table border="1" class="doc">
<tr>
<td>source=<string></td>
<td>path to the source folder</td>
</tr>
<tr>
<td>dst=<string></td>
<td>the target folder path</td>
</tr>
<tr>
<td>[dst_ip=<string>]</td>
<td>Optional overide to the default destination IP address set in __init__</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="kw"><a name="Copy File Remote"></a>Copy File Remote</td>
<td class="arg">source, dst, dst_ip=None</td>
<td class="doc">Copy local file to remote machine<br />
<br />
Parameters:<br />
<table border="1" class="doc">
<tr>
<td>source=<string></td>
<td>path to the source file</td>
</tr>
<tr>
<td>dst=<string></td>
<td>the target path</td>
</tr>
<tr>
<td>[dst_ip=<string>]</td>
<td>Optional overide to the default destination IP address set in __init__</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="kw"><a name="Release Staf Handle"></a>Release Staf Handle</td>
<td class="arg"></td>
<td class="doc"></td>
</tr>
<tr>
<td class="kw"><a name="Run Command Remote"></a>Run Command Remote</td>
<td class="arg">cmd, params, workdir, dst_ip=None</td>
<td class="doc">run command on remote machine<br />
<br />
Parameters:<br />
<table border="1" class="doc">
<tr>
<td>cmd=<string></td>
<td>full path to the command</td>
</tr>
<tr>
<td>params=<string>]</td>
<td>command parameters</td>
</tr>
<tr>
<td>[workdir=<string>]</td>
<td>Optional command work folder</td>
</tr>
<tr>
<td>[dst_ip=<string>]</td>
<td>Optional overide to the default destination IP address set in __init__</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="kw"><a name="Staf Conf"></a>Staf Conf</td>
<td class="arg">dst_ip</td>
<td class="doc"></td>
</tr>
</table>
<p id="footer">
Altogether 5 keywords.<br />
Generated by <a href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool">libdoc.py</a>
on 2011-07-28 10:11:58.
</p>
</body>
</html>