@@ -129,9 +129,8 @@ cFS applications are generated using the Ogma command `cfs`, which accepts
129129the following arguments:
130130- ` --input-file FILENAME ` : location of the specification or source file for
131131 which a cFS application is being generated.
132- - ` --app-target-dir DIR ` : location where the cFS application files must be
133- stored.
134- - ` --app-template-dir DIR ` : location of the cFS application template to use.
132+ - ` --target-dir DIR ` : location where the cFS application files must be stored.
133+ - ` --template-dir DIR ` : location of the cFS application template to use.
135134- ` --variable-file FILENAME ` : a file containing a list of variables to monitor
136135in the cFS application.
137136- ` --variable-db FILENAME ` : a file containing a database of known variables,
@@ -228,12 +227,12 @@ with a set of files with a cFS application template, which Ogma will use
228227instead.
229228
230229To choose this feature, one must call Ogma's `cfs` command with the argument
231- `--app- template-dir DIR`, where `DIR` is the path to a directory containing a
232- cFS application template. For example, assuming that the directory
233- `my_template` contains a custom cFS application template, one can execute:
230+ `--template-dir DIR`, where `DIR` is the path to a directory containing a cFS
231+ application template. For example, assuming that the directory `my_template`
232+ contains a custom cFS application template, one can execute:
234233
235234```
236- $ ogma cfs --app- template-dir my_template/ --variable-db examples/cfs-variable-db.json --variable-file examples/cfs-variables
235+ $ ogma cfs --template-dir my_template/ --variable-db examples/cfs-variable-db.json --variable-file examples/cfs-variables
237236```
238237
239238Ogma will copy the files in that directory to the target path, filling in
@@ -304,9 +303,9 @@ for ROS app generation is considered preliminary.
304303
305304ROS applications are generated using the Ogma command `ros`, which receives
306305five main arguments:
307- - `--app- target-dir DIR`: location where the ROS application files must be
306+ - `--target-dir DIR`: location where the ROS application files must be
308307 stored.
309- - `--app- template-dir DIR`: location of the ROS application template to use.
308+ - `--template-dir DIR`: location of the ROS application template to use.
310309- `--variable-file FILENAME`: a file containing a list of variables that must
311310be made available to the monitor.
312311- `--variable-db FILENAME`: a file containing a database of known variables,
@@ -319,7 +318,7 @@ and the topic they are included with.
319318The following execution generates an initial ROS application for runtime
320319monitoring using Copilot:
321320```sh
322- $ ogma ros --handlers filename --variable-file variables --variable-db ros-variable-db.json --app- target-dir ros_demo
321+ $ ogma ros --handlers filename --variable-file variables --variable-db ros-variable-db.json --target-dir ros_demo
323322```
324323
325324The application generated by Ogma contains the following files:
@@ -418,12 +417,12 @@ package. It's possible to customize the output by providing a directory with a
418417set of files with a ROS package template, which Ogma will use instead.
419418
420419To choose this feature, one must call Ogma's ` ros ` command with the argument
421- ` --app- template-dir DIR ` , where ` DIR ` is the path to a directory containing a
422- ROS 2 package template. For example, assuming that the directory ` my_template `
420+ ` --template-dir DIR ` , where ` DIR ` is the path to a directory containing a ROS 2
421+ package template. For example, assuming that the directory ` my_template `
423422contains a custom ROS package template, one can execute:
424423
425424```
426- $ ogma ros --app- template-dir my_template/ --handlers filename --variable-file variables --variable-db ros-variable-db.json --app -target-dir ros_demo
425+ $ ogma ros --template-dir my_template/ --handlers filename --variable-file variables --variable-db ros-variable-db.json --target-dir ros_demo
427426```
428427
429428Ogma will copy the files in that directory to the target path, filling in
@@ -475,9 +474,8 @@ for F' component generation is considered preliminary.
475474
476475F' components are generated using the Ogma command ` fprime ` , which receives
477476five main arguments:
478- - ` --app-target-dir DIR ` : location where the F' application files must be
479- stored.
480- - ` --app-template-dir DIR ` : directory holding F' component source template.
477+ - ` --target-dir DIR ` : location where the F' application files must be stored.
478+ - ` --template-dir DIR ` : directory holding F' component source template.
481479- ` --variable-file FILENAME ` : a file containing a list of variables that must
482480be made available to the monitor.
483481- ` --variable-db FILENAME ` : a file containing a database of known variables,
@@ -490,7 +488,7 @@ and their types.
490488The following execution generates an initial F' component for runtime
491489monitoring using Copilot:
492490``` sh
493- $ ogma fprime --handlers filename --variable-file filename --variable-db fprime-variable-db.json --app- target-dir fprime_demo
491+ $ ogma fprime --handlers filename --variable-file filename --variable-db fprime-variable-db.json --target-dir fprime_demo
494492```
495493
496494The component generated by Ogma contains the following files:
@@ -565,12 +563,12 @@ component. It's possible to customize the output by providing a directory with
565563a set of files with an F' component template, which Ogma will use instead.
566564
567565To choose this feature, one must call Ogma's ` fprime ` command with the argument
568- ` --app- template-dir DIR ` , where ` DIR ` is the path to a directory containing an
569- F' component specification template. For example, assuming that the directory
566+ ` --template-dir DIR ` , where ` DIR ` is the path to a directory containing an F'
567+ component specification template. For example, assuming that the directory
570568` my_template ` contains a custom F' component template, one can execute:
571569
572570```
573- $ ogma fprime --app- template-dir my_template/ --handlers filename --variable-file variables --variable-db fprime-variable-db.json --app -target-dir fprime_demo
571+ $ ogma fprime --template-dir my_template/ --handlers filename --variable-file variables --variable-db fprime-variable-db.json --target-dir fprime_demo
574572```
575573
576574Ogma will copy the files in that directory to the target path, filling in
@@ -633,7 +631,7 @@ files generated.
633631 code being generated. See the files under ` ogma-core/templates/diagram/ ` , as
634632well as other commands supporting template customization, to understand how to
635633customize the template.
636- - ` --file-name FILENAME ` : File with the diagram being transformed.
634+ - ` --input-file FILENAME ` : File with the diagram being transformed.
637635- ` -f,--input-format FORMAT_NAME ` : Name of the input format. See below for
638636 details.
639637- ` -p,--prop-format FORMAT_NAME ` : Format for the boolean properties or
@@ -751,7 +749,7 @@ typedef struct {
751749Ogma can generate that code automatically with the ` structs ` subcommand:
752750
753751``` haskell
754- $ ogma structs -- header -file-name examples/point.h
752+ $ ogma structs -- input -file examples/point.h
755753data Point = Point
756754 { pX :: Field " x" Double
757755 , pY :: Field " y" Double
0 commit comments