<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<title>File: README.rdoc [RDoc Documentation]</title>
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
<script src="./js/jquery.js" type="text/javascript"
charset="utf-8"></script>
<script src="./js/thickbox-compressed.js" type="text/javascript"
charset="utf-8"></script>
<script src="./js/quicksearch.js" type="text/javascript"
charset="utf-8"></script>
<script src="./js/darkfish.js" type="text/javascript"
charset="utf-8"></script>
</head>
<body class="file">
<div id="metadata">
<div id="home-metadata">
<div id="home-section" class="section">
<h3 class="section-header">
<a href="./index.html">Home</a>
<a href="./index.html#classes">Classes</a>
<a href="./index.html#methods">Methods</a>
</h3>
</div>
</div>
<div id="project-metadata">
<div id="fileindex-section" class="section project-section">
<h3 class="section-header">Files</h3>
<ul>
<li class="file"><a href="./EasyLogger_rdoc.html">EasyLogger.rdoc</a></li>
<li class="file"><a href="./Gemfile.html">Gemfile</a></li>
<li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
<li class="file"><a href="./Rakefile.html">Rakefile</a></li>
<li class="file"><a href="./nbproject/private/rake-d_txt.html">rake-d.txt</a></li>
</ul>
</div>
<div id="classindex-section" class="section project-section">
<h3 class="section-header">Class Index
<span class="search-toggle"><img src="./images/find.png"
height="16" width="16" alt="[+]"
title="show/hide quicksearch" /></span></h3>
<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
<fieldset>
<legend>Quicksearch</legend>
<input type="text" name="quicksearch" value=""
class="quicksearch-field" />
</fieldset>
</form>
<ul class="link-list">
<li><a href="./EasyLogger.html">EasyLogger</a></li>
<li><a href="./EasyLogger/EasyLogger.html">EasyLogger::EasyLogger</a></li>
<li><a href="./ArubaOverrides.html">ArubaOverrides</a></li>
<li><a href="./File.html">File</a></li>
</ul>
<div id="no-class-search-results" style="display: none;">No matching classes.</div>
</div>
</div>
</div>
<div id="documentation">
<h1><a href="EasyLogger.html">EasyLogger</a></h1>
<p>
Describe your project here
</p>
<h1><tt>EasyLogger</tt></h1>
<pre>
EasyLogger [global options] command_name [command-specific options] [--] arguments...
</pre>
<ul>
<li><p>
Use the command <tt>help</tt> to get a summary of commands
</p>
</li>
<li><p>
Use the command <tt>help command_name</tt> to get a help for
<tt>command_name</tt>
</p>
</li>
<li><p>
Use <tt>--</tt> to stop command line argument processing; useful if your
arguments have dashes in them
</p>
</li>
</ul>
<h2>Global Options</h2>
<p>
These options are available for any command and are specified before the
name of the command
</p>
<dl>
<dt><tt>-f, --filemode</tt></dt><dd><p>
file-mode
</p>
<p>
if set, easy logger will sho only the matching past line of the file and
exit.
</p>
</dd>
</dl>
<p>
if both file-mode and tail-mode is activated, file-mode will be chosen.
</p>
<dl>
<dt><tt>-m, --model=arg</tt></dt><dd><p>
model(s) to match
</p>
<p>
The model(s) to match in the log file. Can be mixed with method to match
</p>
</dd>
<dt><tt>-n, --method=arg</tt></dt><dd><p>
method(s) to match
</p>
<p>
The method(s) to match in the log file. Can be mixed with model to match
</p>
</dd>
<dt><tt>-t, --tailmode</tt></dt><dd><p>
tail-mode
</p>
<p>
if set, easy logger will show only the new lines
</p>
</dd>
<dt><tt>-v, --verbose</tt></dt><dd><p>
verbose
</p>
<p>
Switch to verbose mode where more outputs will be shown
</p>
</dd>
</dl>
<h2>Commands</h2>
<dl>
<dt><tt>help</tt></dt><dd><p>
Shows list of commands or help for one command
</p>
</dd>
<dt><tt>text</tt></dt><dd><p>
View the line matching model and/or methods on a log file in command line
</p>
</dd>
</dl>
<h3><tt>help [command]</tt></h3>
<p>
Shows list of commands or help for one command
</p>
<p>
Gets help for the application or its commands. Can also list the commands
in a way helpful to creating a bash-style completion function
</p>
<h4>Options</h4>
<p>
These options are specified <b>after</b> the command.
</p>
<dl>
<dt><tt>-c, --completion</tt></dt><dd><p>
List all commands one line at a time, for use with shell completion
([command] argument is partial command to match)
</p>
</dd>
</dl>
<h3><tt>text log_file [command]</tt></h3>
<p>
View the line matching model and/or methods on a log file in command line
</p>
<p>
This will display the lines of the log file matching the model and/or the
method in a command line mode. If tail-mode is set, only the new lines
matching will be displayed whereas if file-mode is set, it will be only the
the already logged lines matching that will be displayed. Without any of
these options, both of them will be displayed.
</p>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
Rdoc Generator</a> 1.1.6</small>.</p>
</div>
</body>
</html>