<!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 http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Bovem
— Documentation by YARD 0.8.7
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '';
framesUrl = "frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="_index.html">Index (B)</a> »
<span class="title">Bovem</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Bovem
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/bovem/shell.rb<span class="defines">,<br />
lib/bovem/parser.rb,<br /> lib/bovem/option.rb,<br /> lib/bovem/errors.rb,<br /> lib/bovem/logger.rb,<br /> lib/bovem/command.rb,<br /> lib/bovem/console.rb,<br /> lib/bovem/version.rb,<br /> lib/bovem/localizer.rb,<br /> lib/bovem/application.rb,<br /> lib/bovem/configuration.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This file is part of the bovem gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Bovem/CommandMethods.html" title="Bovem::CommandMethods (module)">CommandMethods</a></span>, <span class='object_link'><a href="Bovem/ConsoleMethods.html" title="Bovem::ConsoleMethods (module)">ConsoleMethods</a></span>, <span class='object_link'><a href="Bovem/Errors.html" title="Bovem::Errors (module)">Errors</a></span>, <span class='object_link'><a href="Bovem/ParserMethods.html" title="Bovem::ParserMethods (module)">ParserMethods</a></span>, <span class='object_link'><a href="Bovem/ShellMethods.html" title="Bovem::ShellMethods (module)">ShellMethods</a></span>, <span class='object_link'><a href="Bovem/Version.html" title="Bovem::Version (module)">Version</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Bovem/Application.html" title="Bovem::Application (class)">Application</a></span>, <span class='object_link'><a href="Bovem/Command.html" title="Bovem::Command (class)">Command</a></span>, <span class='object_link'><a href="Bovem/Configuration.html" title="Bovem::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="Bovem/Console.html" title="Bovem::Console (class)">Console</a></span>, <span class='object_link'><a href="Bovem/Localizer.html" title="Bovem::Localizer (class)">Localizer</a></span>, <span class='object_link'><a href="Bovem/Logger.html" title="Bovem::Logger (class)">Logger</a></span>, <span class='object_link'><a href="Bovem/Option.html" title="Bovem::Option (class)">Option</a></span>, <span class='object_link'><a href="Bovem/Parser.html" title="Bovem::Parser (class)">Parser</a></span>, <span class='object_link'><a href="Bovem/Shell.html" title="Bovem::Shell (class)">Shell</a></span>
</p>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="OPTION_TYPES-constant" class="">OPTION_TYPES =
<div class="docstring">
<div class="discussion">
<p>List of valid option types.</p>
<p>Values are the default values for that type.</p>
<p>For any unknown type, the default value is <code>false</code>, it means that any unknown type is managed as a Boolean value with no argument.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbrace'>{</span><span class='const'>String</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='const'>Integer</span> <span class='op'>=></span> <span class='int'>0</span><span class='comma'>,</span> <span class='const'>Float</span> <span class='op'>=></span> <span class='float'>0.0</span><span class='comma'>,</span> <span class='const'>Array</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rbrace'>}</span></pre></dd>
<dt id="TERM_COLORS-constant" class="">TERM_COLORS =
<div class="docstring">
<div class="discussion">
<p>List of valid terminal colors.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbrace'>{</span> <span class='label'>black:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='label'>red:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>green:</span> <span class='int'>2</span><span class='comma'>,</span> <span class='label'>yellow:</span> <span class='int'>3</span><span class='comma'>,</span> <span class='label'>blue:</span> <span class='int'>4</span><span class='comma'>,</span> <span class='label'>magenta:</span> <span class='int'>5</span><span class='comma'>,</span> <span class='label'>cyan:</span> <span class='int'>6</span><span class='comma'>,</span> <span class='label'>white:</span> <span class='int'>7</span><span class='comma'>,</span> <span class='label'>default:</span> <span class='int'>9</span><span class='rbrace'>}</span></pre></dd>
<dt id="TERM_EFFECTS-constant" class="">TERM_EFFECTS =
<div class="docstring">
<div class="discussion">
<p>List of valid terminal text effects.</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='lbrace'>{</span> <span class='label'>reset:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='label'>bright:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>italic:</span> <span class='int'>3</span><span class='comma'>,</span> <span class='label'>underline:</span> <span class='int'>4</span><span class='comma'>,</span> <span class='label'>blink:</span> <span class='int'>5</span><span class='comma'>,</span> <span class='label'>inverse:</span> <span class='int'>7</span><span class='comma'>,</span> <span class='label'>hide:</span> <span class='int'>8</span> <span class='rbrace'>}</span></pre></dd>
</dl>
</div>
<div id="footer">
Generated on Sat Aug 3 13:50:14 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7 (ruby-2.0.0).
</div>
</body>
</html>