Commit 398a3197 authored by yoogx's avatar yoogx

* Update command line help automatically

parent c371f1ca
......@@ -107,3 +107,6 @@ build_man: $(top_srcdir)/ocarina-config.in
-help2man --no-discard-stderr `which ocarina` > $(top_srcdir)/doc/ocarina.1
echo ".HEAD \"<link rel=\"\"stylesheet\"\" type=\"\"text/css\"\" href=\"\"ocarina.css\"\" >\"" >> $(top_srcdir)/doc/ocarina.1
groff -man -Thtml $(top_srcdir)/doc/ocarina.1 > $(top_srcdir)/doc/ocarina_man.html
groff -man -Thtml $(top_srcdir)/doc/ocarina.1 > $(top_srcdir)/doc/ocarina_man.html
ocarina -h > $(top_srcdir)/doc/ocarina_man.txt
-ocarina-config -h 2> $(top_srcdir)/doc/ocarina_config.txt
......@@ -16,10 +16,10 @@ import sys, os, time
# on_rtd is whether we are on readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_bootstrap_theme
html_theme = 'bootstrap'
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
#if not on_rtd: # only import and set the theme if we're building docs locally
# import sphinx_bootstrap_theme
# html_theme = 'bootstrap'
# html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
......@@ -118,7 +118,7 @@ html_theme_options = {
# 'navbar_title': "Demo",
# Tab name for entire site. (Default: "Site")
'navbar_site_name': "Ocarina User's Guide",
# 'navbar_site_name': "Ocarina User's Guide",
# A list of tuples containing pages or urls to link to.
# Valid tuples should be in the following forms:
......@@ -133,14 +133,14 @@ html_theme_options = {
# ],
# Render the next and previous page links in navbar. (Default: true)
'navbar_sidebarrel': True,
# 'navbar_sidebarrel': True,
# Render the current pages TOC in the navbar. (Default: true)
'navbar_pagenav': True,
# 'navbar_pagenav': True,
# Global TOC depth for "site" navbar tab. (Default: 1)
# Switching to -1 shows all levels.
'globaltoc_depth': 2,
# 'globaltoc_depth': 2,
# Include hidden TOCs in Site navbar?
#
......@@ -149,29 +149,29 @@ html_theme_options = {
# will break.
#
# Values: "true" (default) or "false"
'globaltoc_includehidden': "true",
# 'globaltoc_includehidden': "true",
# HTML navbar class (Default: "navbar") to attach to <div> 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.
......
<!-- Creator : groff version 1.19.2 -->
<!-- CreationDate: Thu Mar 3 14:40:41 2016 -->
<!-- CreationDate: Fri Mar 4 09:18:49 2016 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
......
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[=<Runtime_Name>]]
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
<!-- Creator : groff version 1.19.2 -->
<!-- CreationDate: Thu Mar 3 14:40:41 2016 -->
<!-- CreationDate: Fri Mar 4 09:18:50 2016 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
......
Usage: ocarina [switches] <aadl_files>
-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)
......@@ -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 <name> 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[=<Runtime_Name>]]
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
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment