Updated Readme

This commit is contained in:
Craig Yamato
2018-09-25 18:23:58 +00:00
parent b6a4870f1b
commit 00b72a3f57
28 changed files with 8448 additions and 253 deletions

View File

@ -52,8 +52,9 @@
<div class="class-description">A class to work with syslog messages using UDP, TCP, or TLS transport.
There is suport for Syslog message formating RFC-3164, RFC-5424 including
Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
Event Format). The meesaging is fully configurabule and Ansi foreground
colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
Event Format).
Syslog formating classes can be used as input into a Syslog class to be used
simultatniusly to the same Syslog server. *</div>
</header>
@ -80,7 +81,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line99">line 99</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line106">line 106</a>
</li></ul></dd>
@ -126,7 +127,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<div class="description">
Construct a new Syslog object with user options
Construct a new Syslog transport object with user options
</div>
@ -755,7 +756,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line205">line 205</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line212">line 212</a>
</li></ul></dd>
@ -824,7 +825,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line174">line 174</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line181">line 181</a>
</li></ul></dd>
@ -893,7 +894,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line197">line 197</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line204">line 204</a>
</li></ul></dd>
@ -962,7 +963,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line152">line 152</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line159">line 159</a>
</li></ul></dd>
@ -1031,7 +1032,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line149">line 149</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line156">line 156</a>
</li></ul></dd>
@ -1100,7 +1101,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line181">line 181</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line188">line 188</a>
</li></ul></dd>
@ -1169,7 +1170,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line189">line 189</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line196">line 196</a>
</li></ul></dd>
@ -1238,7 +1239,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line147">line 147</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line154">line 154</a>
</li></ul></dd>
@ -1307,7 +1308,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line154">line 154</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line161">line 161</a>
</li></ul></dd>
@ -1376,7 +1377,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line165">line 165</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line172">line 172</a>
</li></ul></dd>
@ -1445,7 +1446,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line169">line 169</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line176">line 176</a>
</li></ul></dd>
@ -1514,7 +1515,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line161">line 161</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line168">line 168</a>
</li></ul></dd>
@ -1583,7 +1584,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line239">line 239</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line246">line 246</a>
</li></ul></dd>
@ -1652,7 +1653,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line235">line 235</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line242">line 242</a>
</li></ul></dd>
@ -1847,7 +1848,7 @@ input as a file location straing and add it to an array of certificates
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line405">line 405</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line412">line 412</a>
</li></ul></dd>
@ -2059,7 +2060,7 @@ selected transport.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line287">line 287</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line294">line 294</a>
</li></ul></dd>
@ -2270,7 +2271,7 @@ selected transport.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line333">line 333</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line340">line 340</a>
</li></ul></dd>
@ -2481,7 +2482,7 @@ selected transport.
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line257">line 257</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line264">line 264</a>
</li></ul></dd>
@ -2668,7 +2669,7 @@ selected transport.
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 24 2018 06:41:36 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>