command line doc. done

This commit is contained in:
Dhanya Maliakal
2017-08-17 17:08:55 +02:00
parent e2af1de83f
commit e0c29190a2
17 changed files with 345 additions and 290 deletions

View File

@ -40,25 +40,25 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<h1><a class="anchor" id="output">Output settings </a></h1><p>Commands to setup the file destination and format</p>
<ul>
<li><b>outdir [dir]</b> Sets/gets the file output directory (string)</li>
<li><b>outdir [dir]</b> Sets/gets the file output directory. <code>Returns</code> <code></code>(string)</li>
</ul>
<ul>
<li><b>fname [fn]</b> Sets/gets the root of the output file name (string)</li>
<li><b>fname [fn]</b> Sets/gets the root of the output file name <code>Returns</code> <code></code>(string)</li>
</ul>
<ul>
<li><b>index [i]</b> Sets/gets the current file index (int)</li>
<li><b>index [i]</b> Sets/gets the current file index. <code>Returns</code> <code></code>(int)</li>
</ul>
<ul>
<li><b>enablefwrite [i]</b> Enables/disables file writing. 1 enables, 0 disables.</li>
<li><b>enablefwrite [i]</b> Enables/disables file writing. 1 enables, 0 disables. <code>Returns</code> <code></code>(int)</li>
</ul>
<ul>
<li><b>overwrite [i]</b> enables(1) /disables(0) file overwriting</li>
<li><b>overwrite [i]</b> enables(1) /disables(0) file overwriting. <code>Returns</code> <code></code>(int)</li>
</ul>
<ul>
<li><b>currentfname</b> gets the filename for the data without index and extension</li>
<li><b>currentfname</b> gets the filename for the data without index and extension. MYTHEN only. <code>Returns</code> <code></code>(string)</li>
</ul>
<ul>
<li><b>fileformat</b> sets/gets the file format for data in receiver. Options: [ascii, binary, hdf5]. Ascii is not implemented in Receiver. </li>
<li><b>fileformat</b> sets/gets the file format for data in receiver. Options: [ascii, binary, hdf5]. Ascii is not implemented in Receiver. <code>Returns</code> <code></code>(string) </li>
</ul>
</div>
<!--- window showing the filter options -->