element.
# For black navbar, do "navbar navbar-inverse"
- 'navbar_class': "navbar navbar-inverse",
+# 'navbar_class': "navbar navbar-inverse",
# Fix navigation bar to top of page?
# Values: "true" (default) or "false"
- 'navbar_fixed_top': "true",
+# 'navbar_fixed_top': "true",
# Location of link to source.
# Options are "nav" (default), "footer" or anything else to exclude.
- 'source_link_position': "",
+# 'source_link_position': "",
# Bootswatch (http://bootswatch.com/) theme.
#
# Options are nothing with "" (default) or the name of a valid theme
# such as "amelia" or "cosmo".
- 'bootswatch_theme': "spacelab",
+# 'bootswatch_theme': "spacelab",
# Choose Bootstrap version.
# Values: "3" (default) or "2" (in quotes)
- 'bootstrap_version': "3",
+# 'bootstrap_version': "3",
}
# Add any paths that contain custom themes here, relative to this directory.
diff --git a/doc/ocarina-config.html b/doc/ocarina-config.html
index 071abab937cabd8bcd0d6b84a959a9b06ff63830..8239f4cdbadd5b9e69e23fa687fe8c7ebb6734da 100644
--- a/doc/ocarina-config.html
+++ b/doc/ocarina-config.html
@@ -1,5 +1,5 @@
-
+
diff --git a/doc/ocarina_config.txt b/doc/ocarina_config.txt
new file mode 100644
index 0000000000000000000000000000000000000000..f7ddc2a70b076b95a742b726904b2a145b5ccda0
--- /dev/null
+++ b/doc/ocarina_config.txt
@@ -0,0 +1,33 @@
+Usage: ocarina-config [OPTIONS]
+Options:
+ No option:
+ Output all the flags (compiler and linker) required
+ to compile your program.
+ [--prefix[=DIR]]
+ Output the directory in which Ocarina architecture-independent
+ files are installed, or set this directory to DIR.
+ [--exec-prefix[=DIR]]
+ Output the directory in which Ocarina architecture-dependent
+ files are installed, or set this directory to DIR.
+ [--version|-v]
+ Output the version of Ocarina.
+ [--config]
+ Output Ocarina's configuration parameters.
+ [--runtime[=
]]
+ Checks the validity and the presence of the given runtime and
+ then, outputs its path. Only one runtime can be requested at
+ a time. If no runtime name is given, outputs the root directory
+ of all runtimes.
+ [--libs]
+ Output the linker flags to use for Ocarina.
+ [--projects]
+ Output the path to GNAT Project files for Ocarina
+ [--properties]
+ Output the location of the standard property file.
+ [--resources]
+ Output the location of resource files
+ (typically the standard properties)
+ [--cflags]
+ Output the compiler flags to use for Ocarina.
+ [--help]
+ Output this message
diff --git a/doc/ocarina_man.html b/doc/ocarina_man.html
index 56ca6956422a7d520ed7d71f704e8ffa117c6582..5a4977c82f8340a8f87d2a2a2ca47265e7b34f5c 100644
--- a/doc/ocarina_man.html
+++ b/doc/ocarina_man.html
@@ -1,5 +1,5 @@
-
+
diff --git a/doc/ocarina_man.txt b/doc/ocarina_man.txt
new file mode 100644
index 0000000000000000000000000000000000000000..01dcba4203a000956d1413186be510ef472a4595
--- /dev/null
+++ b/doc/ocarina_man.txt
@@ -0,0 +1,32 @@
+Usage: ocarina [switches]
+
+ -h, --help Display help and exit
+ --version Display version and exit
+ -v, --verbose Output extra verbose information
+ -q Quiet mode (default)
+ -d Debug mode
+ -s Output default search directory, then exit
+ -aadlv[ARG] AADL version, ARG = 1 for AADL 1.0, 2 for AADL 2.x
+ -f Parse predefined non-standard property sets
+ -disable-annexes=ARG Deactivate annex ARG
+ -r ARG Use ARG as root system
+ -o ARG Specify output file/directory
+ -y Automatically load AADL files
+ -I ARG Add ARG to the directory search list
+ -p Parse and instantiate the model
+ -i Instantiate the model
+ -x Parse AADL file as an AADL scenario file
+ -g ARG Generate code using Ocarina backend 'ARG'
+ --list-backends List available backends
+ -b Compile generated code
+ -z Clean code generated
+ -k ARG Set POK flavor (arinc653/deos/pok/vxworks)
+ -t Run Ocarina in terminal interactive mode
+ -real_theorem ARG Name of the main theorem to evaluate
+ -real_lib ARG Add external library of REAL theorems
+ -real_continue_eval Continue evaluation of REAL theorems after first failure (REAL backend)
+ -boundt_process ARG Generate .tpo file for process ARG (Bound-T backend)
+ -ec Compute coverage metrics
+ -er Execute system
+ -asn1 Generate ASN1 deployment file (PolyORB-HI-C only)
+ -perf Enable profiling with gprof (PolyORB-HI-C only)
diff --git a/doc/usage.rst b/doc/usage.rst
index 580b12bc9a162fbdd10a3e8ddab612d06e69fd08..e8add1592da41c06a6969ee6451896d565917109 100644
--- a/doc/usage.rst
+++ b/doc/usage.rst
@@ -9,109 +9,21 @@ Ocarina command-line
####################
Ocarina has a rich command-line interface, covering all required steps
-to parse, instantiate, analyze or generate code from AADL models::
+to parse, instantiate, analyze or generate code from AADL models.
- Usage:
- ocarina [options] files
- OR
- ocarina -help
- files are a non null sequence of AADL files
-
- General purpose options:
- -V Output Ocarina version, then exit
- -s Output Ocarina search directory, then exit
-
- Scenario file options:
- -b build the generated application code
- -z clean the generated application code
- -ec execute the generated application code and
- retrieve coverage information
- -er execute the generated application code and
- verify that there is no regression
- -p only parse and instantiate the application model
- -c only perform schedulability analysis
-
- Advanced user options:
- -d Debug mode for developpers
- -q Quiet mode (default)
- -t [script] Run Ocarina in terminal interactive mode.
- If a script is given, interpret it then exit.
- -v Verbose mode for users
- -x Parse AADL file as an AADL scenario file
- -f Parse predefined non standard property sets
- -i Instantiate the AADL model
- -r The name of the instance tree root
- -o Specify output file
- -I Specify the inclusion paths
- -aadlv1 Use AADL v1 standard (default)
- -aadlv2 Use AADL v2 standard
- -real_lib Add a REAL file to be used as a theorem libraries by REAL annexes
- -g Generate code from the AADL instance tree
- Registered backends:
- petri_nets
- boundt
- polyorb_hi_ada
- polyorb_qos_ada
- polyorb_hi_c
- polyorb_hi_rtsj
- pok_c
- stats
- subprograms
- real_theorem
- carts
- cheddar
- aadl
- aadl_min
- aadl_annex
- behavior_specification
- real_specification
- -arinc653 Generate code for ARINC653 API (POK backend only)
- -b Generate and build code from the AADL model
- -z Clean code generated from the AADL model
- -disable-annexes=@{annexes@} Desactive one or all annexes
- Annexes :
- all
- behavior
- real
+.. include:: ocarina_man.txt
+ :literal:
ocarina-config
##############
ocarina-config returns path and library information on Ocarina
installation. This script can be used to compile user program that
-uses Ocarina's API.::
+uses Ocarina's API.
+
+.. include:: ocarina_config.txt
+ :literal:
- Usage: ocarina-config [OPTIONS]
- Options:
- No option:
- Output all the flags (compiler and linker) required
- to compile your program.
- [--prefix[=DIR]]
- Output the directory in which Ocarina architecture-independent
- files are installed, or set this directory to DIR.
- [--exec-prefix[=DIR]]
- Output the directory in which Ocarina architecture-dependent
- files are installed, or set this directory to DIR.
- [--version|-v]
- Output the version of Ocarina.
- [--config]
- Output Ocarina's configuration parameters.
- [--runtime[=]]
- Checks the validity and the presence of the given runtime and
- then, outputs its path. Only one runtime can be requested at
- a time. If no runtime name is given, outputs the root directory
- of all runtimes.
- [--libs]
- Output the linker flags to use for Ocarina.
- [--properties]
- Output the location of the standard property file.
- [--resources]
- Output the location of resource files
- (typically the standard properties)
- [--cflags]
- Output the compiler flags to use for Ocarina.
- [--help]
- Output this message