* Update man pages

853547dd · yoogx · 84d6e574 · 853547dd · 853547dd · 853547dd
Commit 853547dd authored Mar 04, 2016 by yoogx
Showing with 298 additions and 213 deletions

doc/ocarina-config.1 doc/ocarina-config.1 +1 -1

doc/ocarina-config.html doc/ocarina-config.html +1 -1

doc/ocarina.1 doc/ocarina.1 +112 -0

doc/ocarina_man.html doc/ocarina_man.html +184 -211

No files found.
--- a/doc/ocarina-config.1
+++ b/doc/ocarina-config.1
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
-.TH OCARINA "1" "avril 2013" "Ocarina 2.0w" "User Commands"
+.TH OCARINA "1" "mars 2016" "Ocarina 2.0w" "User Commands"
 .SH NAME
 Ocarina \- manual page for Ocarina 2.0w
 .SH SYNOPSIS

--- a/doc/ocarina-config.html
+++ b/doc/ocarina-config.html
 <!-- Creator     : groff version 1.19.2 -->
-<!-- CreationDate: Thu Apr 18 14:42:34 2013 -->
+<!-- CreationDate: Thu Mar  3 14:40:41 2016 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
 "http://www.w3.org/TR/html4/loose.dtd">
 <html>

--- a/doc/ocarina.1
+++ b/doc/ocarina.1
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.10.
+.TH OCARINA "1" "mars 2016" "Ocarina 2.0w (Working Copy from rb472173)" "User Commands"
+.SH NAME
+Ocarina \- manual page for Ocarina 2.0w (Working Copy from rb472173)
+.SH SYNOPSIS
+.B ocarina
+[\fIswitches\fR] \fI<aadl_files>\fR
+.SH DESCRIPTION
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Display help and exit
+.TP
+\fB\-\-version\fR
+Display version and exit
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Output extra verbose information
+.TP
+\fB\-q\fR
+Quiet mode (default)
+.TP
+\fB\-d\fR
+Debug mode
+.TP
+\fB\-s\fR
+Output default search directory, then exit
+.TP
+\fB\-aadlv[ARG]\fR
+AADL version, ARG = 1 for AADL 1.0, 2 for AADL 2.x
+.TP
+\fB\-f\fR
+Parse predefined non\-standard property sets
+.HP
+\fB\-disable\-annexes\fR=\fIARG\fR Deactivate annex ARG
+.TP
+\fB\-r\fR ARG
+Use ARG as root system
+.TP
+\fB\-o\fR ARG
+Specify output file/directory
+.TP
+\fB\-y\fR
+Automatically load AADL files
+.TP
+\fB\-I\fR ARG
+Add ARG to the directory search list
+.TP
+\fB\-p\fR
+Parse and instantiate the model
+.TP
+\fB\-i\fR
+Instantiate the model
+.TP
+\fB\-x\fR
+Parse AADL file as an AADL scenario file
+.TP
+\fB\-g\fR ARG
+Generate code using Ocarina backend 'ARG'
+.TP
+\fB\-\-list\-backends\fR
+List available backends
+.TP
+\fB\-b\fR
+Compile generated code
+.TP
+\fB\-z\fR
+Clean code generated
+.TP
+\fB\-k\fR ARG
+Set POK flavor (arinc653/deos/pok/vxworks)
+.TP
+\fB\-t\fR
+Run Ocarina in terminal interactive mode
+.TP
+\fB\-real_theorem\fR ARG
+Name of the main theorem to evaluate
+.TP
+\fB\-real_lib\fR ARG
+Add external library of REAL theorems
+.TP
+\fB\-real_continue_eval\fR
+Continue evaluation of REAL theorems after first failure (REAL backend)
+.TP
+\fB\-boundt_process\fR ARG
+Generate .tpo file for process ARG (Bound\-T backend)
+.TP
+\fB\-ec\fR
+Compute coverage metrics
+.TP
+\fB\-er\fR
+Execute system
+.TP
+\fB\-asn1\fR
+Generate ASN1 deployment file (PolyORB\-HI\-C only)
+.TP
+\fB\-perf\fR
+Enable profiling with gprof (PolyORB\-HI\-C only)
+.SH COPYRIGHT
+Copyright \(co 2003\-2009 Telecom ParisTech, 2010\-2016 ESA & ISAE
+Build date:
+.SH "SEE ALSO"
+The full documentation for
+.B Ocarina
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B Ocarina
+programs are properly installed at your site, the command
+.IP
+.B info Ocarina
+.PP
+should give you access to the complete manual.
 .HEAD "<link rel=""stylesheet"" type=""text/css"" href=""ocarina.css"" >"
--- a/doc/ocarina_man.html
+++ b/doc/ocarina_man.html
 <!-- Creator     : groff version 1.19.2 -->
-<!-- CreationDate: Tue Apr 30 08:00:19 2013 -->
+<!-- CreationDate: Thu Mar  3 14:40:41 2016 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
 "http://www.w3.org/TR/html4/loose.dtd">
 <html>
@@ -21,7 +21,9 @@
 <h1 align=center>OCARINA</h1>

 <a href="#NAME">NAME</a><br>
+<a href="#SYNOPSIS">SYNOPSIS</a><br>
 <a href="#DESCRIPTION">DESCRIPTION</a><br>
+<a href="#COPYRIGHT">COPYRIGHT</a><br>
 <a href="#SEE ALSO">SEE ALSO</a><br>

 <hr>
@@ -32,23 +34,36 @@


 <p style="margin-left:11%; margin-top: 1em">Ocarina &minus;
-manual page for Ocarina 2.0w (Working Copy from )</p>
+manual page for Ocarina 2.0w (Working Copy from
+rb472173)</p>
+
+<a name="SYNOPSIS"></a>
+<h2>SYNOPSIS</h2>
+
+
+<p style="margin-left:11%; margin-top: 1em"><b>ocarina</b>
+[<i>switches</i>] <i>&lt;aadl_files&gt;</i></p>

 <a name="DESCRIPTION"></a>
 <h2>DESCRIPTION</h2>



-<p style="margin-left:11%; margin-top: 1em"><b>Usage:</b></p>
+<p style="margin-left:11%; margin-top: 1em"><b>&minus;h</b>,
+<b>&minus;&minus;help</b></p>
+
+<p style="margin-left:22%;">Display help and exit</p>
+
+
+<p style="margin-left:11%;"><b>&minus;&minus;version</b></p>

-<p style="margin-left:22%;">ocarina [options] files OR
-ocarina <b>&minus;help</b></p>
+<p style="margin-left:22%;">Display version and exit</p>

-<p style="margin-left:22%; margin-top: 1em">files are a non
-null sequence of AADL files</p>
+<p style="margin-left:11%;"><b>&minus;v</b>,
+<b>&minus;&minus;verbose</b></p>

-<p style="margin-left:22%; margin-top: 1em">General purpose
-options:</p>
+<p style="margin-left:22%;">Output extra verbose
+information</p>

 <table width="100%" border=0 rules="none" frame="void"
       cellspacing="0" cellpadding="0">
@@ -58,13 +73,13 @@ options:</p>



-<p style="margin-top: 1em" valign="top"><b>&minus;V</b></p> </td>
+<p style="margin-top: 1em" valign="top"><b>&minus;q</b></p> </td>
 <td width="8%"></td>
 <td width="64%">


-<p style="margin-top: 1em" valign="top">Output Ocarina
-version, then exit</p></td>
+<p style="margin-top: 1em" valign="top">Quiet mode
+(default)</p> </td>
 <td width="14%">
 </td>
 <tr valign="top" align="left">
@@ -73,314 +88,304 @@ version, then exit</p></td>



-<p style="margin-top: 1em" valign="top"><b>&minus;s</b></p> </td>
+<p style="margin-top: 1em" valign="top"><b>&minus;d</b></p> </td>
 <td width="8%"></td>
 <td width="64%">


-<p style="margin-top: 1em" valign="top">Output Ocarina
-search directory, then exit</p></td>
+<p style="margin-top: 1em" valign="top">Debug mode</p></td>
 <td width="14%">
 </td>
-</table>
-
-<p style="margin-left:22%; margin-top: 1em">Scenario file
-options:</p>
-
-<table width="100%" border=0 rules="none" frame="void"
-       cellspacing="0" cellpadding="0">
 <tr valign="top" align="left">
 <td width="11%"></td>
 <td width="3%">



-<p style="margin-top: 1em" valign="top"><b>&minus;b</b></p> </td>
+<p style="margin-top: 1em" valign="top"><b>&minus;s</b></p> </td>
 <td width="8%"></td>
-<td width="66%">
+<td width="64%">


-<p style="margin-top: 1em" valign="top">Generate and build
-code from the AADL model</p></td>
-<td width="12%">
+<p style="margin-top: 1em" valign="top">Output default
+search directory, then exit</p></td>
+<td width="14%">
 </td>
+</table>
+
+<p style="margin-left:11%;"><b>&minus;aadlv[ARG]</b></p>
+
+<p style="margin-left:22%;">AADL version, ARG = 1 for AADL
+1.0, 2 for AADL 2.x</p>
+
+<table width="100%" border=0 rules="none" frame="void"
+       cellspacing="0" cellpadding="0">
 <tr valign="top" align="left">
 <td width="11%"></td>
 <td width="3%">



-<p style="margin-top: 1em" valign="top"><b>&minus;z</b></p> </td>
+<p style="margin-top: 1em" valign="top"><b>&minus;f</b></p> </td>
 <td width="8%"></td>
 <td width="66%">


-<p style="margin-top: 1em" valign="top">Clean code
-generated from the AADL model</p></td>
+<p style="margin-top: 1em" valign="top">Parse predefined
+non&minus;standard property sets</p></td>
 <td width="12%">
 </td>
 </table>


-<p style="margin-left:22%; margin-top: 1em"><b>&minus;ec</b>
-Execute the generated application code and</p>
-
-<p style="margin-left:22%; margin-top: 1em">retrieve
-coverage information</p>
-
-
-<p style="margin-left:22%; margin-top: 1em"><b>&minus;er</b>
-Execute the generated application code and</p>
-
-<p style="margin-left:22%; margin-top: 1em">verify that
-there is no regression</p>
+<p style="margin-left:22%; margin-top: 1em"><b>&minus;disable&minus;annexes</b>=<i>ARG</i>
+Deactivate annex ARG</p>

 <table width="100%" border=0 rules="none" frame="void"
       cellspacing="0" cellpadding="0">
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
+<td width="9%">


+<p style="margin-top: 1em" valign="top"><b>&minus;r</b>
+ARG</p> </td>
+<td width="2%"></td>
+<td width="63%">

-<p style="margin-top: 1em" valign="top"><b>&minus;p</b></p> </td>
-<td width="8%"></td>
-<td width="73%">

-
-<p style="margin-top: 1em" valign="top">Only parse and
-instantiate the application model</p></td>
-<td width="5%">
+<p style="margin-top: 1em" valign="top">Use ARG as root
+system</p> </td>
+<td width="15%">
 </td>
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
+<td width="9%">


-
-<p style="margin-top: 1em" valign="top"><b>&minus;c</b></p> </td>
-<td width="8%"></td>
-<td width="73%">
+<p style="margin-top: 1em" valign="top"><b>&minus;o</b>
+ARG</p> </td>
+<td width="2%"></td>
+<td width="63%">


-<p style="margin-top: 1em" valign="top">Only perform
-schedulability analysis</p></td>
-<td width="5%">
+<p style="margin-top: 1em" valign="top">Specify output
+file/directory</p> </td>
+<td width="15%">
 </td>
-</table>
-
-<p style="margin-left:22%; margin-top: 1em">Advanced user
-options:</p>
-
-<table width="100%" border=0 rules="none" frame="void"
-       cellspacing="0" cellpadding="0">
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
+<td width="9%">



-<p style="margin-top: 1em" valign="top"><b>&minus;d</b></p> </td>
-<td width="8%"></td>
-<td width="78%">
+<p style="margin-top: 1em" valign="top"><b>&minus;y</b></p> </td>
+<td width="2%"></td>
+<td width="63%">


-<p style="margin-top: 1em" valign="top">Debug mode for
-developpers</p> </td>
+<p style="margin-top: 1em" valign="top">Automatically load
+AADL files</p></td>
+<td width="15%">
+</td>
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
-
+<td width="9%">


-<p style="margin-top: 1em" valign="top"><b>&minus;q</b></p> </td>
-<td width="8%"></td>
-<td width="78%">
+<p style="margin-top: 1em" valign="top"><b>&minus;I</b>
+ARG</p> </td>
+<td width="2%"></td>
+<td width="63%">


-<p style="margin-top: 1em" valign="top">Quiet mode
-(default)</p> </td>
+<p style="margin-top: 1em" valign="top">Add ARG to the
+directory search list</p></td>
+<td width="15%">
+</td>
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
+<td width="9%">



-<p style="margin-top: 1em" valign="top"><b>&minus;t</b></p> </td>
-<td width="8%"></td>
-<td width="78%">
+<p style="margin-top: 1em" valign="top"><b>&minus;p</b></p> </td>
+<td width="2%"></td>
+<td width="63%">


-<p style="margin-top: 1em" valign="top">[script] Run
-Ocarina in terminal interactive mode. If a script is given,
-interpret it then exit.</p></td>
+<p style="margin-top: 1em" valign="top">Parse and
+instantiate the model</p></td>
+<td width="15%">
+</td>
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
+<td width="9%">



-<p style="margin-top: 1em" valign="top"><b>&minus;v</b></p> </td>
-<td width="8%"></td>
-<td width="78%">
+<p style="margin-top: 1em" valign="top"><b>&minus;i</b></p> </td>
+<td width="2%"></td>
+<td width="63%">


-<p style="margin-top: 1em" valign="top">Verbose mode for
-users</p> </td>
+<p style="margin-top: 1em" valign="top">Instantiate the
+model</p> </td>
+<td width="15%">
+</td>
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
+<td width="9%">



 <p style="margin-top: 1em" valign="top"><b>&minus;x</b></p> </td>
-<td width="8%"></td>
-<td width="78%">
+<td width="2%"></td>
+<td width="63%">


 <p style="margin-top: 1em" valign="top">Parse AADL file as
 an AADL scenario file</p></td>
+<td width="15%">
+</td>
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
-
-
+<td width="9%">

-<p style="margin-top: 1em" valign="top"><b>&minus;y</b></p> </td>
-<td width="8%"></td>
-<td width="78%">

+<p style="margin-top: 1em" valign="top"><b>&minus;g</b>
+ARG</p> </td>
+<td width="2%"></td>
+<td width="63%">

-<p style="margin-top: 1em" valign="top">Automatically load
-AADL files on demand</p></td>
-<tr valign="top" align="left">
-<td width="11%"></td>
-<td width="3%">

+<p style="margin-top: 1em" valign="top">Generate code using
+Ocarina backend &rsquo;ARG&rsquo;</p></td>
+<td width="15%">
+</td>
+</table>


-<p style="margin-top: 1em" valign="top"><b>&minus;f</b></p> </td>
-<td width="8%"></td>
-<td width="78%">
+<p style="margin-left:11%;"><b>&minus;&minus;list&minus;backends</b></p>

+<p style="margin-left:22%;">List available backends</p>

-<p style="margin-top: 1em" valign="top">Parse predefined
-non standard property sets</p></td>
+<table width="100%" border=0 rules="none" frame="void"
+       cellspacing="0" cellpadding="0">
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
+<td width="9%">



-<p style="margin-top: 1em" valign="top"><b>&minus;i</b></p> </td>
-<td width="8%"></td>
-<td width="78%">
+<p style="margin-top: 1em" valign="top"><b>&minus;b</b></p> </td>
+<td width="2%"></td>
+<td width="64%">


-<p style="margin-top: 1em" valign="top">Instantiate the
-AADL model</p></td>
+<p style="margin-top: 1em" valign="top">Compile generated
+code</p> </td>
+<td width="14%">
+</td>
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
+<td width="9%">



-<p style="margin-top: 1em" valign="top"><b>&minus;r</b></p> </td>
-<td width="8%"></td>
-<td width="78%">
+<p style="margin-top: 1em" valign="top"><b>&minus;z</b></p> </td>
+<td width="2%"></td>
+<td width="64%">


-<p style="margin-top: 1em" valign="top">&lt;name&gt; The
-name of the instance tree root</p></td>
+<p style="margin-top: 1em" valign="top">Clean code
+generated</p> </td>
+<td width="14%">
+</td>
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
-
+<td width="9%">


-<p style="margin-top: 1em" valign="top"><b>&minus;o</b></p> </td>
-<td width="8%"></td>
-<td width="78%">
+<p style="margin-top: 1em" valign="top"><b>&minus;k</b>
+ARG</p> </td>
+<td width="2%"></td>
+<td width="64%">


-<p style="margin-top: 1em" valign="top">Specify output
-file</p> </td>
+<p style="margin-top: 1em" valign="top">Set POK flavor
+(arinc653/deos/pok/vxworks)</p> </td>
+<td width="14%">
+</td>
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
+<td width="9%">



-<p style="margin-top: 1em" valign="top"><b>&minus;I</b></p> </td>
-<td width="8%"></td>
-<td width="78%">
+<p style="margin-top: 1em" valign="top"><b>&minus;t</b></p> </td>
+<td width="2%"></td>
+<td width="64%">


-<p style="margin-top: 1em" valign="top">Specify the
-inclusion paths</p></td>
+<p style="margin-top: 1em" valign="top">Run Ocarina in
+terminal interactive mode</p></td>
+<td width="14%">
+</td>
 </table>

-<p style="margin-left:11%;"><b>&minus;aadlv1</b></p>
+<p style="margin-left:11%;"><b>&minus;real_theorem</b>
+ARG</p>

-<p style="margin-left:22%;">Use AADL v1 standard
-(default)</p>
+<p style="margin-left:22%;">Name of the main theorem to
+evaluate</p>

-<p style="margin-left:11%;"><b>&minus;aadlv2</b></p>
+<p style="margin-left:11%;"><b>&minus;real_lib</b> ARG</p>

-<p style="margin-left:22%;">Use AADL v2 standard</p>
+<p style="margin-left:22%;">Add external library of REAL
+theorems</p>


-<p style="margin-left:22%; margin-top: 1em"><b>&minus;real_lib</b>
-Add a REAL file to be used as a theorem library by REAL
-annexes</p>
+<p style="margin-left:11%;"><b>&minus;real_continue_eval</b></p>

+<p style="margin-left:22%;">Continue evaluation of REAL
+theorems after first failure (REAL backend)</p>

-<p style="margin-left:22%; margin-top: 1em"><b>&minus;real_theorem</b>
-&lt;theorem&gt; Evaluate only theorem</p>
+<p style="margin-left:11%;"><b>&minus;boundt_process</b>
+ARG</p>

-
-<p style="margin-left:22%; margin-top: 1em"><b>&minus;real_continue_eval</b>
-Continue evaluation in case of failures</p>
+<p style="margin-left:22%;">Generate .tpo file for process
+ARG (Bound&minus;T backend)</p>

 <table width="100%" border=0 rules="none" frame="void"
       cellspacing="0" cellpadding="0">
 <tr valign="top" align="left">
 <td width="11%"></td>
-<td width="3%">
-
+<td width="7%">


-<p style="margin-top: 1em" valign="top"><b>&minus;g</b></p> </td>
-<td width="8%"></td>
-<td width="78%">

+<p style="margin-top: 1em" valign="top"><b>&minus;ec</b></p> </td>
+<td width="4%"></td>
+<td width="75%">

-<p style="margin-top: 1em" valign="top">Generate code from
-the AADL instance tree Registered backends:</p></td>
-</table>
-
-<p style="margin-left:22%; margin-top: 1em">arinc653_conf
-petri_nets boundt mast polyorb_hi_ada polyorb_hi_c
-polyorb_hi_rtsj pok_c xtratum_configuration stats
-subprograms real_theorem carts asn1_deployment cheddar
-connection_matrix function_matrix aadl_xml aadl aadl_min
-aadl_annex behavior_specification real_specification</p>

-<table width="100%" border=0 rules="none" frame="void"
-       cellspacing="0" cellpadding="0">
+<p style="margin-top: 1em" valign="top">Compute coverage
+metrics</p> </td>
+<td width="3%">
+</td>
 <tr valign="top" align="left">
 <td width="11%"></td>
 <td width="7%">



-<p style="margin-top: 1em" valign="top"><b>&minus;perf</b></p> </td>
+<p style="margin-top: 1em" valign="top"><b>&minus;er</b></p> </td>
 <td width="4%"></td>
 <td width="75%">


-<p style="margin-top: 1em" valign="top">Enable profiling
-with gprof (PolyORB&minus;HI&minus;C only)</p></td>