trick/share/man/man1/trick-CP.1

60 lines
2.0 KiB
Groff
Raw Normal View History

.TH trick-CP 1 "July 29, 2016" "Trick" "Trick User's Manual"
2015-02-26 15:02:31 +00:00
.SH NAME
trick-CP \- Trick Configuration Processor
2015-02-26 15:02:31 +00:00
.SH SYNOPSIS
\fBtrick-CP\fP [OPTION]...
2015-02-26 15:02:31 +00:00
.SH DESCRIPTION
\fBtrick-CP\fP is the Trick environment Configuration Processor. trick-CP parses the
simulation definition file, S_define, searching for math models to include in
the simulation. trick-CP will search for the math models within the search paths
included in TRICK_CFLAGS and TRICK_CXXFLAGS environment variables. trick-CP will
generate code to call math models listed in the S_define file and will generate
a makefile to build these math models.
2015-02-26 15:02:31 +00:00
.SS Options
.TP
\fB-g, --debug\fP
Print the \fIS_define\fP file as it is processed by trick-CP. (This may help the
2015-02-26 15:02:31 +00:00
user find problems with his/her simulation configuration).
.TP
\fB-h, --help\fP
Print the trick-CP help message
2015-02-26 15:02:31 +00:00
.TP
\fB-o, --outfile\fP \fIFILE_NAME\fP
Send CP output to FILE_NAME
2015-02-26 15:02:31 +00:00
.TP
\fB-p, --no-python\fP
Exclude python input processor from simulation.
2015-02-26 15:02:31 +00:00
.TP
\fB-t\fP
Create a unit test simulation where TRICK_UNIT_TEST is defined during compilation
2015-02-26 15:02:31 +00:00
.TP
\fB-v, --verbose\fP
Set the verbose level. Valid entries are 0-3
2015-02-26 15:02:31 +00:00
.SH FILES
.TP
\fIbuild/S_source.cpp\fP
The simulation-specific executive source code file.
2015-02-26 15:02:31 +00:00
.TP
\fIbuild/S_library_list\fP
2015-02-26 15:02:31 +00:00
The simulation-specific object code link list file.
.TP
.SH ENVIRONMENT
.TP
\fB${TRICK_CPFLAGS}\fP
Arguments to send to trick-CP
2015-02-26 15:02:31 +00:00
.TP
\fB${TRICK_HOME}\fP
Contains path to Trick root directory
2015-02-26 15:02:31 +00:00
.SH "SEE ALSO"
All Trick model developers and users should go through the tutorial found
in the \fITrick Simulation Environment User Training Materials\fP.
The canonical reference for all Trick commands, files and utilities is the
\fITrick Simulation Environment User's Guide\fP. Information specific to a
given release of Trick tools is contained in the \fITrick Simulation
Environment Version Description\fP for that release.
.SH HISTORY
1991-2002 : The \fBtrick-CP\fP utility in C was written by Rob Bailey.
2003-2016 : The \fBtrick-CP\fP utility ported to Perl was written by Alex Lin.