add 66-parser doc

217602f2 · Eric Vidal · b1761137 · 217602f2
Commit 217602f2 authored 5 years ago by Eric Vidal
--- a/doc/66-parser.html
+++ b/doc/66-parser.html
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <meta http-equiv="Content-Language" content="en" />
+    <title>The 66 Suite: 66-parser</title>
+    <meta name="Description" content="Detailed documentation for the 66-parser command which is part of the 66 software suite" />
+    <meta name="Keywords" content="66 command 66-parser service supervision supervise start service parse write" />
+    <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
+  </head>
+<body>
+
+<p>
+<a href="index.html">66</a><br />
+<a href="//obarun.org/">www.obarun.org</a>
+</p>
+
+<h1>66-parser</h1>
+
+	<p>
+      This command parses <a href="frontend.html"><em>frontend</em></a> service file and write the result to a directory.
+    </p>
+
+<h2> Interface </h2>
+	<pre>
+	66-parser [ -h ] [ -v <em>verbosity</em> ] [ -f ] service destination</em>
+	</pre>
+
+	<ul>
+		<li>It open and reads the <em>frontend</em> <em>service</em> file.</li>
+		<li>It run a parser on the file.</li>
+		<li>It write the parsing result to <em>destination</em> directory.</li>
+	</ul>
+	<p> An absolute path is expected for <em>service</em> and <em>destination</em>.
+<h2> Options </h2>
+
+	<ul>
+	 <li> <tt>-h&nbsp;</tt>&nbsp;: prints this help. </li>
+	 
+	 <li>
+		<tt>-v&nbsp;<em>verbosity</em>&nbsp;</tt>: increases/decreases 
+		the verbosity of the command. <tt>1(Default)</tt>: Only print 
+		error messages. <tt>2</tt>: Also print warning messages. 
+		<tt>3</tt>: Also print debugging messages.
+	 </li>
+	 
+	 <li> 
+		<tt>-f&nbsp;</tt>: force to owerwrite an existing parsing result at <em>destination</em>.
+	</li>
+	</ul>
+	
+<h2> Notes </h2>
+<p>It will not try to read and parse any services declared at <em>@depends</em> field. This tools should be used for debugging purpose and see the result of a parse process before trying to enable the service on the system. 
+Also, it's recommended to <strong>not set the [environment] section</strong>. This tool use the exact same parser as <a href="66-enable.html">66-enable</a> which write by default the configuration file at /etc/66/conf/<em>service_name</em>. That's mean that a corresponding file will be overwritten.</p>
+</body>
+</html>