2017-11-09 02:08:41 +00:00
|
|
|
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8"/>
|
2017-11-17 22:01:08 +00:00
|
|
|
<title>Pluie.OutputFormatter.usage_command – pluie-echo-0.2 – Vala Binding Reference</title>
|
2017-11-09 02:08:41 +00:00
|
|
|
<link href="../style.css" rel="stylesheet" type="text/css"/><script src="../scripts.js" type="text/javascript">
|
|
|
|
|
</script>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
2017-11-17 22:01:08 +00:00
|
|
|
<div class="site_header">Pluie.OutputFormatter.usage_command – pluie-echo-0.2 Reference Manual</div>
|
2017-11-09 02:08:41 +00:00
|
|
|
<div class="site_body">
|
|
|
|
|
<div class="site_navigation">
|
|
|
|
|
<ul class="navi_main">
|
|
|
|
|
<li class="package_index"><a href="../index.html">Packages</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<hr class="navi_hr"/>
|
|
|
|
|
<ul class="navi_main">
|
2017-11-17 22:01:08 +00:00
|
|
|
<li class="package"><a href="index.htm">pluie-echo-0.2</a></li>
|
2017-11-09 02:08:41 +00:00
|
|
|
</ul>
|
|
|
|
|
<hr class="navi_hr"/>
|
|
|
|
|
<ul class="navi_main">
|
|
|
|
|
<li class="namespace"><a href="Pluie.html">Pluie</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<hr class="navi_hr"/>
|
|
|
|
|
<ul class="navi_main">
|
|
|
|
|
<li class="class"><a href="Pluie.OutputFormatter.html">OutputFormatter</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<hr class="navi_hr"/>
|
|
|
|
|
<ul class="navi_main">
|
|
|
|
|
<li class="creation_method"><a href="Pluie.OutputFormatter.OutputFormatter.html">OutputFormatter</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.action.html">action</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.c.html">c</a></li>
|
2017-11-17 22:01:08 +00:00
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.echo.html">echo</a></li>
|
2017-11-09 02:08:41 +00:00
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.echo_up.html">echo_up</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.error.html">error</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.keyval.html">keyval</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.move_down.html">move_down</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.move_up.html">move_up</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.rs.html">rs</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.s_indent.html">s_indent</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.state.html">state</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.test.html">test</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.title.html">title</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.title_sep.html">title_sep</a></li>
|
2017-11-17 22:01:08 +00:00
|
|
|
<li class="method">usage_command</li>
|
2017-11-09 02:08:41 +00:00
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.usage_option.html">usage_option</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.warn.html">warn</a></li>
|
|
|
|
|
<li class="method"><a href="Pluie.OutputFormatter.wordwrap.html">wordwrap</a></li>
|
|
|
|
|
<li class="field"><a href="Pluie.OutputFormatter.conf.html">conf</a></li>
|
|
|
|
|
<li class="field"><a href="Pluie.OutputFormatter.indent.html">indent</a></li>
|
2017-11-17 22:01:08 +00:00
|
|
|
<li class="field"><a href="Pluie.OutputFormatter.key_maxlen.html">key_maxlen</a></li>
|
2017-11-09 02:08:41 +00:00
|
|
|
<li class="field"><a href="Pluie.OutputFormatter.term_width.html">term_width</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="site_content">
|
2017-11-17 22:01:08 +00:00
|
|
|
<h1 class="main_title">usage_command</h1>
|
2017-11-09 02:08:41 +00:00
|
|
|
<hr class="main_hr"/>
|
|
|
|
|
<h2 class="main_title">Description:</h2>
|
2017-11-17 22:01:08 +00:00
|
|
|
<div class="main_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">void</span> <b><span class="method">usage_command</span></b> (<span class="main_basic_type"><span class="class">string</span></span> bin, <span class="main_basic_type"><span class="class">string</span></span> command, <span class="main_basic_type"><span class="class">string</span></span> param = <span class="main_literal">""</span>, <span class="main_basic_type"><span class="class">string</span></span>? comment = <span class="main_literal">null</span>)
|
2017-11-09 02:08:41 +00:00
|
|
|
</div>
|
|
|
|
|
<div class="description">
|
2017-11-17 22:01:08 +00:00
|
|
|
<p>display usage command</p>
|
2017-11-09 02:08:41 +00:00
|
|
|
<h2 class="main_title">Parameters:</h2>
|
|
|
|
|
<table class="main_parameter_table">
|
|
|
|
|
<tr>
|
2017-11-17 22:01:08 +00:00
|
|
|
<td class="main_parameter_table_name">bin</td>
|
2017-11-09 02:08:41 +00:00
|
|
|
<td>
|
2017-11-17 22:01:08 +00:00
|
|
|
<p>the binary name </p>
|
2017-11-09 02:08:41 +00:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2017-11-17 22:01:08 +00:00
|
|
|
<td class="main_parameter_table_name">command</td>
|
2017-11-09 02:08:41 +00:00
|
|
|
<td>
|
2017-11-17 22:01:08 +00:00
|
|
|
<p>the command name </p>
|
2017-11-09 02:08:41 +00:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2017-11-17 22:01:08 +00:00
|
|
|
<td class="main_parameter_table_name">param</td>
|
2017-11-09 02:08:41 +00:00
|
|
|
<td>
|
2017-11-17 22:01:08 +00:00
|
|
|
<p>the optional paramter </p>
|
2017-11-09 02:08:41 +00:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
2017-11-17 22:01:08 +00:00
|
|
|
<td class="main_parameter_table_name">comment</td>
|
2017-11-09 02:08:41 +00:00
|
|
|
<td>
|
2017-11-17 22:01:08 +00:00
|
|
|
<p>the optional comment </p>
|
2017-11-09 02:08:41 +00:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div><br/>
|
|
|
|
|
<div class="site_footer">Generated by <a href="http://www.valadoc.org/">Valadoc</a>
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
