/
CLI.html
334 lines (226 loc) · 15.5 KB
/
CLI.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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<!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" xml:lang="en" lang="en">
<head>
<meta name="Content-Type" content="text/html; charset=utf-8" />
<title>Class: Plist4r::CLI</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../css/custom.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '..';
if (relpath != '') relpath += '/';
</script>
<base id="base_target" target="_top" />
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/autocomplete.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/live.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="../object_index.html" target="_self" title="Index (C)">Index (C)</a>
»
<span class='title'><a href="../Plist4r.html" target="_self" title="Plist4r (module)">Plist4r</a></span>
»
<span class="title">CLI</span>
<div class="noframes">
<span class="title"></span>
<a id="frames_link" class="link_disabled">Frames</a> |
<a target="_top" id="noframes_link" class="link_disabled">No Frames</a>
<span class="title"></span>
</div>
</div>
<div id="search2">
<div class="search2_center">
<form class="search2" onsubmit="return false;" action="">
<input name="q" type="search" placeholder="Search" id="search_box2" size="30" value="" />
</form>
</div>
<script type="text/javascript" charset="utf-8">
$('#search_box2').focus(function(){
var search_index = relpath + 'search_index.json';
jQuery.getJSON(search_index, go_data);
function go_data(adata) {
$('#search_box2').autocomplete(adata, {
width: 300,
matchContains: true,
formatItem: function(item) {
return item.text;
}
}).result(function(event, item) {
if (window.location.search) {
window.location.href = relpath + $(item.href_tag).attr("href");
} else {
location.href = relpath + $(item.href_tag).attr("href");
}
});
}
});
</script>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Plist4r::CLI
</h1>
<div id="info_box">
<dl class="box">
<dt class="r1">Includes:</dt>
<dd class="r1"><a href="Mixlib/CLI.html" target="_self" title="Plist4r::Mixlib::CLI (module)">Mixlib::CLI</a></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">
lib/plist4r/cli.rb
</dd>
</dl>
</div>
<div class="clear"></div>
<h3 class="inherited">Class Methods</h3>
<ul id="methods_ribbon">
<li class="r1"><a href="#plist4r_cli_options-class_method" target="_self" title="Plist4r::CLI.plist4r_cli_options (method)">plist4r_cli_options</a></li>
</ul>
<h3 class="inherited">Instance Methods</h3>
<ul id="methods_ribbon">
<li class="r1"><a href="#parse-instance_method" target="_self" title="Plist4r::CLI#parse (method)">parse</a></li>
</ul>
<h3 class="inherited">Methods included from <a href="Mixlib/CLI.html" target="_self" title="Plist4r::Mixlib::CLI (module)">Mixlib::CLI</a></h3>
<p class="inherited"><a href="Mixlib/CLI.html#build_option_arguments-instance_method" target="_self" title="Plist4r::Mixlib::CLI#build_option_arguments (method)">#build_option_arguments</a>, <a href="Mixlib/CLI.html#initialize-instance_method" target="_self" title="Plist4r::Mixlib::CLI#initialize (method)">#initialize</a>, <a href="Mixlib/CLI.html#parse_options-instance_method" target="_self" title="Plist4r::Mixlib::CLI#parse_options (method)">#parse_options</a></p>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>
Defines options for the <tt>plist4r</tt> command line utility
</p>
</div>
</div>
<div class="tags">
</div>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <a href="Mixlib/CLI.html#initialize-instance_method" target="_self" title="Plist4r::Mixlib::CLI#initialize (method)">Plist4r::Mixlib::CLI</a></p>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first" id="plist4r_cli_options-class_method">
<p class="signature first"">
+ (<tt><a href="../Object.html" target="_self" title="Object (class)">Object</a></tt>) <strong>plist4r_cli_options</strong>
</p><div class="docstring">
<div class="discussion">
<p>
The Plist4r CLI Options
</p>
</div>
</div>
<div class="tags">
<div class="examples">
<h3>Examples:</h3>
<h4><div class='inline'></div></h4>
<pre class="example code"><span class='Usage constant id'>Usage</span><span class='colon op'>:</span> <span class='bin identifier id'>bin</span><span class='div op'>/</span><span class='plist4r identifier id'>plist4r</span> <span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span>
<span class='minus op'>-</span><span class='b identifier id'>b</span><span class='comma token'>,</span> <span class='minus op'>-</span><span class='minus op'>-</span><span class='brew identifier id'>brew</span> <span class='Customize constant id'>Customize</span> <span class='for for kw'>for</span> <span class='Brew constant id'>Brew</span><span class='dot token'>.</span> <span class='Use constant id'>Use</span> <span class='with identifier id'>with</span> <span class='minus op'>-</span><span class='minus op'>-</span><span class='ruby identifier id'>ruby</span><span class='minus op'>-</span><span class='lib identifier id'>lib</span><span class='dot token'>.</span>
<span class='minus op'>-</span><span class='d identifier id'>d</span><span class='comma token'>,</span> <span class='minus op'>-</span><span class='minus op'>-</span><span class='dir identifier id'>dir</span> <span class='DIR constant id'>DIR</span> <span class='The constant id'>The</span> <span class='directory identifier id'>directory</span> <span class='to identifier id'>to</span> <span class='dump identifier id'>dump</span> <span class='files identifier id'>files</span> <span class='into identifier id'>into</span><span class='dot token'>.</span> <span class='Use constant id'>Use</span> <span class='with identifier id'>with</span> <span class='minus op'>-</span><span class='minus op'>-</span><span class='ruby identifier id'>ruby</span><span class='minus op'>-</span><span class='lib identifier id'>lib</span><span class='dot token'>.</span> <span class='Defaults constant id'>Defaults</span> <span class='to identifier id'>to</span> <span class='cwd identifier id'>cwd</span><span class='dot token'>.</span>
<span class='minus op'>-</span><span class='r identifier id'>r</span><span class='comma token'>,</span> <span class='minus op'>-</span><span class='minus op'>-</span><span class='ruby identifier id'>ruby</span><span class='minus op'>-</span><span class='lib identifier id'>lib</span> <span class='Convert constant id'>Convert</span> <span class='plist4r identifier id'>plist4r</span> <span class='gem identifier id'>gem</span> <span class='into identifier id'>into</span> <span class='a identifier id'>a</span> <span class='ruby identifier id'>ruby</span> <span class='lib identifier id'>lib</span><span class='comma token'>,</span> <span class='and and kw'>and</span> <span class='write identifier id'>write</span> <span class='to identifier id'>to</span> <span class='the identifier id'>the</span> <span class='filesystem identifier id'>filesystem</span><span class='dot token'>.</span> <span class='lparen token'>(</span><span class='required identifier id'>required</span><span class='rparen token'>)</span>
<span class='minus op'>-</span><span class='h identifier id'>h</span><span class='comma token'>,</span> <span class='minus op'>-</span><span class='minus op'>-</span><span class='help identifier id'>help</span> <span class='Show constant id'>Show</span> <span class='this identifier id'>this</span> <span class='message identifier id'>message</span>
</pre>
</div>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/plist4r/cli.rb', line 17</span>
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='plist4r_cli_options identifier id'>plist4r_cli_options</span>
<span class='option identifier id'>option</span> <span class='symbol val'>:ruby_lib</span><span class='comma token'>,</span> <span class='symbol val'>:required</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='true true kw'>true</span><span class='comma token'>,</span>
<span class='symbol val'>:short</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"-r"</span><span class='comma token'>,</span> <span class='symbol val'>:long</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"--ruby-lib"</span><span class='comma token'>,</span> <span class='symbol val'>:boolean</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='true true kw'>true</span><span class='comma token'>,</span> <span class='symbol val'>:default</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='false false kw'>false</span><span class='comma token'>,</span>
<span class='symbol val'>:description</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"Convert plist4r gem into a ruby lib, and write to the filesystem."</span>
<span class='option identifier id'>option</span> <span class='symbol val'>:brew</span><span class='comma token'>,</span>
<span class='symbol val'>:short</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"-b"</span><span class='comma token'>,</span> <span class='symbol val'>:long</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"--brew"</span><span class='comma token'>,</span> <span class='symbol val'>:boolean</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='true true kw'>true</span><span class='comma token'>,</span> <span class='symbol val'>:default</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='false false kw'>false</span><span class='comma token'>,</span>
<span class='symbol val'>:description</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"Customize for Brew. Use with --ruby-lib."</span>
<span class='option identifier id'>option</span> <span class='symbol val'>:dir</span><span class='comma token'>,</span>
<span class='symbol val'>:short</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"-d DIR"</span><span class='comma token'>,</span> <span class='symbol val'>:long</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"--dir DIR"</span><span class='comma token'>,</span> <span class='symbol val'>:default</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span>
<span class='symbol val'>:description</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"The directory to dump files into. Use with --ruby-lib. Defaults to cwd."</span>
<span class='option identifier id'>option</span> <span class='symbol val'>:help</span><span class='comma token'>,</span> <span class='symbol val'>:short</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"-h"</span><span class='comma token'>,</span> <span class='symbol val'>:long</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"--help"</span><span class='comma token'>,</span> <span class='symbol val'>:boolean</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='true true kw'>true</span><span class='comma token'>,</span>
<span class='symbol val'>:description</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"Show this message"</span><span class='comma token'>,</span>
<span class='symbol val'>:on</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='symbol val'>:tail</span><span class='comma token'>,</span>
<span class='symbol val'>:show_options</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='true true kw'>true</span><span class='comma token'>,</span>
<span class='symbol val'>:exit</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='integer val'>0</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first" id="parse-instance_method">
<p class="signature first"">
- (<tt><a href="../Object.html" target="_self" title="Object (class)">Object</a></tt>) <strong>parse</strong>(argv = ARGV) { ... }
</p><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<h3>Yields:</h3>
<ul class="yield">
<li>
<span class='type'></span>
<div class='inline'><p>
Some block to yield
</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/plist4r/cli.rb', line 39</span>
<span class='def def kw'>def</span> <span class='parse identifier id'>parse</span> <span class='argv identifier id'>argv</span><span class='assign token'>=</span><span class='ARGV constant id'>ARGV</span>
<span class='parse_options identifier id'>parse_options</span><span class='lparen token'>(</span><span class='argv identifier id'>argv</span><span class='rparen token'>)</span>
<span class='config identifier id'>config</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Aug 18 16:27:44 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.8 and the
<a href="http://github.com/dreamcat4/yard-slipstream">yard-slipstream</a> plugin
(ruby-1.8.7).
</div>
</body>
</html>