<?xml version="1.0" encoding="utf-8"?>
<html>
<head>
<meta charset="UTF-8"/>
<title>Pluie.OutputFormatter.usage_option – pluie-echo-0.1 – Vala Binding Reference</title>
<link href="../style.css" rel="stylesheet" type="text/css"/><script src="../scripts.js" type="text/javascript">
</script>
</head>
<body>
<div class="site_header">Pluie.OutputFormatter.usage_option – pluie-echo-0.1 Reference Manual</div>
<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">
<li class="package"><a href="index.htm">pluie-echo-0.1</a></li>
</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>
<li class="method"><a href="Pluie.OutputFormatter.echo.html">echo</a></li>
<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>
<li class="method">usage_option</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>
<li class="field"><a href="Pluie.OutputFormatter.term_width.html">term_width</a></li>
</ul>
</div>
<div class="site_content">
<h1 class="main_title">usage_option</h1>
<hr class="main_hr"/>
<h2 class="main_title">Description:</h2>
<div class="main_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">void</span> <b><span class="method">usage_option</span></b> (<span class="main_basic_type"><span class="class">string</span></span>? name = <span class="main_literal">null</span>, <span class="main_basic_type"><span class="class">string</span></span>? shortname = <span class="main_literal">null</span>, <span class="main_basic_type"><span class="class">string</span></span>? argname = <span class="main_literal">null</span>, <span class="main_basic_type"><span class="struct">bool</span></span> val = <span class="main_literal">false</span>, <span class="main_basic_type"><span class="struct">int</span></span> echo_up = <span class="main_literal">0</span>)
</div>
<div class="description">
<p>display usage option</p>
<h2 class="main_title">Parameters:</h2>
<table class="main_parameter_table">
<tr>
<td class="main_parameter_table_name">name</td>
<td>
<p>the option name </p>
</td>
</tr>
<tr>
<td class="main_parameter_table_name">shortname</td>
<td>
<p>the option shortname </p>
</td>
</tr>
<tr>
<td class="main_parameter_table_name">argname</td>
<td>
<p>the option argument </p>
</td>
</tr>
<tr>
<td class="main_parameter_table_name">val</td>
<td>
<p>specifyed optional value argument </p>
</td>
</tr>
<tr>
<td class="main_parameter_table_name">echo_up</td>
<td>
<p>line to move up on displaying option definition </p>
</td>
</tr>
</table>
</div>
</div>
</div><br/>
<div class="site_footer">Generated by <a href="http://www.valadoc.org/">Valadoc</a>
</div>
</body>
</html>