| 1 |
.TH CAMITK-@APPLICATION_NAME@ "1" "@CURRENT_DATE@" "camitk-@APPLICATION_NAME@ @CAMITK_VERSION_MAJOR@.@CAMITK_VERSION_MINOR@" "User Commands" |
| 2 |
.SH NAME |
| 3 |
camitk-@APPLICATION_NAME@ \- CamiTK Extension Project skeleton generator |
| 4 |
.SH SYNOPSIS |
| 5 |
.B camitk-@APPLICATION_NAME@ |
| 6 |
[\fIOPTIONS\fR]... |
| 7 |
.SH DESCRIPTION |
| 8 |
.B camitk\-@APPLICATION_NAME@ is build using CamiTK @CAMITK_VERSION_MAJOR@.@CAMITK_VERSION_MINOR@ |
| 9 |
.br |
| 10 |
Please visit <\fBhttps://camitk.imag.fr\fR> for more information. |
| 11 |
.br |
| 12 |
(c) Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, France |
| 13 |
.PP |
| 14 |
camitk\-@APPLICATION_NAME@ is a developer tool for CamiTK, the Computer Assisted |
| 15 |
Medical Intervention Tool Kit. |
| 16 |
.PP |
| 17 |
camitk-cepgenerator creates a CamiTK Extension Project (CEP) skeleton |
| 18 |
from a description given in a XML file (valid CamiTK cepcoreschema language) |
| 19 |
.PP |
| 20 |
Using this command line only you can generate a CEP directory tree and |
| 21 |
the component and action extension C++ code corresponding to the |
| 22 |
content of the given XML file. |
| 23 |
.PP |
| 24 |
To successfully run camitk\-@APPLICATION_NAME@ you need to provide two |
| 25 |
arguments: the CamiTK core XML document and a directory where |
| 26 |
the C++ classes and CMake configuration files will be written. |
| 27 |
.PP |
| 28 |
The targeted users are developers in R&D departments or laboratories. |
| 29 |
.PP |
| 30 |
.SH "OPTIONS" |
| 31 |
|
| 32 |
.\" |
| 33 |
.\" The following documentation was generated by CLI, a command |
| 34 |
.\" line interface compiler for C++. |
| 35 |
.\" |
| 36 |
.IP "\fB--help\fP|\fB-h\fP" |
| 37 |
Print usage information and exit\. |
| 38 |
|
| 39 |
.IP "\fB--version\fP|\fB-v\fP" |
| 40 |
Print CamiTK version message and exit |
| 41 |
|
| 42 |
.IP "\fB--file\fP|\fB-f\fP \fIfile\fP" |
| 43 |
input CamiTK CEPCoreSchema XML document describing the extension to generate |
| 44 |
(needed)\. |
| 45 |
|
| 46 |
This should be a valid CEPCoreSchema XML document\. The input XML \fIfile\fP |
| 47 |
is \fBmandatory\fP\. |
| 48 |
|
| 49 |
.IP "\fB--directory\fP|\fB-d\fP \fIpath\fP" |
| 50 |
CamiTK Extension Project output directory (needed)\. |
| 51 |
|
| 52 |
This is the path to the directory where the CEP skeleton files will be |
| 53 |
generated\. The output \fIpath\fP is \fBmandatory\fP\. |
| 54 |
|
| 55 |
.SH "AUTHORS" |
| 56 |
CamiTK and camitk\-@APPLICATION_NAME@ is mainly developed by the Univ. Grenoble Alpes, |
| 57 |
CNRS, Grenoble INP - UGA in the TIMC UMR 5525 laboratory (CAMI team). |
| 58 |
.SH "SEE ALSO" |
| 59 |
Please visit <\fBhttps://camitk.imag.fr\fR> for more documentation on |
| 60 |
.B camitk\-@APPLICATION_NAME@ |
| 61 |
.br |