ExternalVendorCode/trick
1
0
Fork 0
mirror of https://github.com/nasa/trick.git synced 2024-12-24 07:16:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

man pages completely out of date #253

Browse Source 
Created man pages for each executable we have in bin.  Updated the
couple of man pages we did have in there.  Modified trick-CP
to accept arguments.  Updated the version number reported by ICG
as well.
This commit is contained in:
Alex Lin 2016-08-02 09:56:43 -05:00
parent b2293a14ff
commit ca02209d8f
22 changed files with 544 additions and 181 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bin/trick-CP
View File

@ -22,7 +22,7 @@ foreach $argnum (0 .. $#ARGV) {
} elsif ($arg =~ /-t/ ) { } elsif ($arg =~ /-t/ ) {
$makefileAddArgs = $makefileAddArgs . " test "; $makefileAddArgs = $makefileAddArgs . " test ";
} else { } else {
print "Warning: Ignoring unrecognized argument $arg\n" $ENV{TRICK_CPFLAGS} .= " $arg" ;
} }
} }

2
libexec/trick/configuration_processor
View File

@ -32,7 +32,7 @@ $sim{args}{p} = 1 ;
#-------------------------------------------------------------- #--------------------------------------------------------------
# Process command line arguments # Process command line arguments
Getopt::Long::Configure ("bundling"); Getopt::Long::Configure ("bundling");
GetOptions ( "no_python|p" => sub { $sim{args}{p} = 0 } , GetOptions ( "no-python|p" => sub { $sim{args}{p} = 0 } ,
"debug|g" => sub { $sim{args}{v} = 3 ; } , "debug|g" => sub { $sim{args}{v} = 3 ; } ,
"help|h|?" => \$sim{args}{h} , "help|h|?" => \$sim{args}{h} ,
"outfile|o=s" => \$sim{args}{o} , "outfile|o=s" => \$sim{args}{o} ,

123
share/man/man1/trick-CP.1
View File

@ -1,100 +1,53 @@
.TH CP 1 "May 27, 2000" "Trick" "Trick User's Manual" .TH trick-CP 1 "July 29, 2016" "Trick" "Trick User's Manual"
.SH NAME .SH NAME
CP \- run the Trick Configuration Processor trick-CP \- Trick Configuration Processor
.SH SYNOPSIS .SH SYNOPSIS
\fBCP\fP [\fB-d\fP | \fB-e\fP | \fB-g\fP | \fB-h\fP | \fB-l\fP | \fB-m\fP | \fB-r\fP | \fB-s\fP | \fB-v\fP] \fBtrick-CP\fP [OPTION]...
.SH DESCRIPTION .SH DESCRIPTION
\fBCP\fP is the Trick environment Configuration Processor. When executed \fBtrick-CP\fP is the Trick environment Configuration Processor. trick-CP parses the
without options, \fBCP\fP executes every option except \fB-g\fP. This command simulation definition file, S_define, searching for math models to include in
must be executed in an existing simulation directory whose name is prefixed the simulation. trick-CP will search for the math models within the search paths
with \fI${SIM_DIR_PREFIX}\fP, which contains a simulation definition file named included in TRICK_CFLAGS and TRICK_CXXFLAGS environment variables. trick-CP will
\fIS_define\fP, and an optional title file named \fITitle\fP. generate code to call math models listed in the S_define file and will generate
a makefile to build these math models.
.SS Options .SS Options
.TP .TP
\fB-d\fP \fB-g, --debug\fP
Create the \fIS_default.dat\fP and \fIDefault.dat\fP (Default data files) file. Print the \fIS_define\fP file as it is processed by trick-CP. (This may help the
.TP
\fB-e\fP
Create the \fIS_main${HOST_CPU}.exe\fP (Master executable) file.
.TP
\fB-g\fP
Print the \fIS_define\fP file as it is processed by CP. (This may help the
user find problems with his/her simulation configuration). user find problems with his/her simulation configuration).
.TP .TP
\fB-h\fP \fB-h, --help\fP
Create the \fIS_structures\fP (Default structure list) file. Print the trick-CP help message
.TP .TP
\fB-l\fP \fB-o, --outfile\fP \fIFILE_NAME\fP
Create the \fIS_library_list\fP (Object library link list) file. Send CP output to FILE_NAME
.TP .TP
\fB-m\fP \fB-p, --no-python\fP
Create the (simulation) \fIMakefile\fP. Exclude python input processor from simulation.
.TP .TP
\fB-r\fP \fB-t\fP
Create the \fIS_sie.resource\fP (Smart Input Editor data base) file. Create a unit test simulation where TRICK_UNIT_TEST is defined during compilation
.TP .TP
\fB-s\fP \fB-v, --verbose\fP
Create the \fIS_source.c\fP (Simulation specific executive source code) file. Set the verbose level. Valid entries are 0-3
.TP
\fB-v\fP
Create the \fIS_variables.db\fP (Simulation parameter data base) file.
.SH FILES .SH FILES
.TP .TP
\fI${TRICK_HOME}/catalog/catalog\fP \fIbuild/S_source.cpp\fP
Contains paths to all model catalog directories.
.TP
<model_directory>/\fIcatalog/structures\fP
Contains database information about the data structures which is used by
\fBCP\fP(1).
.TP
<model_directory>/\fIcatalog/enumerated\fP
Contains database information about the enumerated data types which is used by
\fBCP\fP(1).
.TP
<model_directory>/\fIcatalog/depends\fP
Contains database information about which files depend on which other files.
\fBICG\fP(1) inserts dependency information for header files, \fBMIS\fP(1)
inserts dependency information for source code files. This information is
used by \fBCP\fP.
.TP
\fI${TRICK_USER_HOME}/\fP<simulation_directory>\fI/S_library_list\fP
The simulation-specific object code link list file.
.TP
\fI${TRICK_USER_HOME}/\fP<simulation_directory>\fI/S_structures\fP
The simulation-specific data structures summary file.
.TP
\fI${TRICK_USER_HOME}/\fP<simulation_directory>\fI/S_default.dat\fP
The simulation-specific default initialization data file.
.TP
\fI${TRICK_USER_HOME}/\fP<simulation_directory>\fI/S_source.c\fP
The simulation-specific executive source code file. The simulation-specific executive source code file.
.TP .TP
\fI${TRICK_USER_HOME}/\fP<simulation_directory>\fI/S_main_${HOST_CPU}.exe\fP \fIbuild/S_library_list\fP
The simulation-specific, architecture-specific executable file. The simulation-specific object code link list file.
.TP .TP
\fI${TRICK_USER_HOME}/\fP<simulation_directory>\fI/S_sie.resource\fP \fIS_default.dat\fP
The simulation-specific SIE resource file. The simulation-specific default initialization data file.
.TP
\fI${TRICK_USER_HOME}/\fP<simulation_directory>\fI/S_variables.db\fP
The simulation-specific non-readable ASCII database file. Can be processed to
yield information about every global data structure in the simulation.
.TP
\fI${TRICK_USER_HOME}/\fP<simulation_directory>\fI/S_job_execution\fP
The simulation-specific job execution order summary file.
.SH ENVIRONMENT .SH ENVIRONMENT
.TP .TP
\fB${TRICK_HOME}, ${TRICK_USER_HOME}\fP \fB${TRICK_CPFLAGS}\fP
These contain paths which are set by the user's \fI.Trick_cshrc\fP and used by Arguments to send to trick-CP
nearly all Trick programs and utilities.
.TP .TP
\fB.Trickrc\fP \fB${TRICK_HOME}\fP
Trick's parses this file with the \fIgte\fP call to gather user configurable Contains path to Trick root directory
Trick environment variables (not to be confused with UNIX environment
variables).
.TP
\fB${SIM_DIR_PREFIX}\fP
Contains a pattern, normally "SIM_", which must match the first characters of
the simulation directory's name.
.SH "SEE ALSO" .SH "SEE ALSO"
All Trick model developers and users should go through the tutorial found All Trick model developers and users should go through the tutorial found
in the \fITrick Simulation Environment User Training Materials\fP. in the \fITrick Simulation Environment User Training Materials\fP.
@ -102,13 +55,7 @@ The canonical reference for all Trick commands, files and utilities is the
\fITrick Simulation Environment User's Guide\fP. Information specific to a \fITrick Simulation Environment User's Guide\fP. Information specific to a
given release of Trick tools is contained in the \fITrick Simulation given release of Trick tools is contained in the \fITrick Simulation
Environment Version Description\fP for that release. Environment Version Description\fP for that release.
.\" .SH DIAGNOSTICS .SH HISTORY
.\" How to determine why the command failed. 1991-2002 : The \fBtrick-CP\fP utility in C was written by Rob Bailey.
.SH BUGS
Known bugs will be placed in the \fIVersion Description Document\fP located in 2003-2016 : The \fBtrick-CP\fP utility ported to Perl was written by Alex Lin.
$TRICK_HOME/docs area. If you would like to report a bug, contact
vetter@lincom-asg.com.
.SH AUTHORS
The \fBCP\fP command was written by Rob Bailey and is maintained by the
Trick development staff. This man page was written by Rick Sykes,
address all discrepancies to sykes@lincom-asg.com.

117
share/man/man1/trick-ICG.1
View File

@ -1,76 +1,63 @@
.TH ICG 1 "May 17, 2000" "Trick" "Trick User's Manual" .TH trick-ICG 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME .SH NAME
ICG \- run the Trick Interface Code Generator trick-ICG \- run the Trick Interface Code Generator
.SH SYNOPSIS .SH SYNOPSIS
\fBICG\fP [\fB-d\fP] [\fB-c\fP] \fI<data_structure_file_name.h>\fP \fBtrick-ICG\fP [OPTIONS]...
.PP
\fBICG\fP [\fB-u\fP] for measurement unit summary
.SH DESCRIPTION .SH DESCRIPTION
\fBICG\fP \fIstructure_file.h\fP invokes the Trick Interface Code Generator \fBtrick-ICG\fP \fIstructure_file.h\fP invokes the Trick Interface Code Generator
on the data structure and/or enumerated type definition file on the data structures and/or enumerated types definition file
\fIstructure_file.h\fP. \fIstructure_file.h\fP.
\fBICG\fP generates source code (in C) which is used by the Trick executive \fBtrick-ICG\fP generates source code (in C++) which is used by the Trick memory manager
to perform input and output to/from the data structures defined in to perform input and output to/from the data structures defined in
\fIstructure_file.h\fP. \fIstructure_file.h\fP.
\fBICG\fP also generates catalog database entries for all data
structures and enumerated types which it parses, and Hypertext Mark-up Language
(HTML) which helps to document the data structures and enumerated types.
.PP .PP
\fBICG\fP \fBtrick-ICG\fP should be executed from the directory containing \fIstructure_file.h\fP.
should be executed from the directory containing \fIstructure_file.h\fP.
This may be the model directory itself, or a directory called \fIinclude\fP This may be the model directory itself, or a directory called \fIinclude\fP
in the model directory. The catalog information, source code and HTML in the model directory. The source code generated by \fBtrick-ICG\fP are placed
generated by \fBICG\fP are placed in directories called \fIcatalog\fP, in a directory called \fIio_src\fP.
\fIio_src\fP, and \fIhtml\fP, respectively, in the model directory.
.PP
\fBICG\fP must be performed on all data structure files before the
\fBMIS\fP(1) or \fBmake_build\fP(1) processors are run. These two tools
process all the source code files in the version directory, including those
generated by \fBICG\fP.
.SS Options
.TP .TP
\fB-d\fP \fB-D=<define>\fP
Debug mode. \fBICG\fP will echo \fIstructure_file.h\fP to the screen as Predefine \fIdefine\fP as a macro, with definition 1
it is processed. This helps the user find errors in his structure definition
file.
.TP .TP
\fB-c\fP \fB-I=<directory>\fP
Do not trap the common UNIX and USER signals. This feature allows a core to be dumped. Add the directory \fIdirectory\P to the list of directories to be searched for header files.
.TP .TP
\fB-u\fP \fB-d=<int>\fP
Display units. \fBICG\fP will display a list of the valid measurement units Set the debug level of prints. Valid values are 0-4.
components. These are used in the measurement units fields of the .TP
parameter comments in a structure definition (.h) file. \fB-f\fP
Force all io_src files to be regenerated even if they were marked up-to-date.
.TP
\fB-help\fP
Print quick summary of arguments.
.TP
\fB-m\fP
In addition to the io_src files, create the structure map files used by a simulation. Not
usually run by users.
.TP
\fB-o=<string>\fP
Output all files to \fIstring\fP
.TP
\fB-s\fP
Process the Trick header files when building Trick itself. Should not run outside of building
Trick.
.TP
\fB-units-truth-is-scary\fP
Supress units conversion warnings.
.TP
\fB-v=<int>\fP
Select version of attributes to produce. Currently 10 is the only valid option.
.TP
\fB-version\fP
Prints the trick-ICG version and exits.
.SH FILES .SH FILES
.TP .TP
\fIio_src/io_\fPstructure_file\fI.c\fP \fIio_src/io_\fPstructure_file\fI.cpp\fP
The I/O code is put in files with names of the form: The I/O code is put in files with names of the form:
\fIio_\fPstructure_file\fI.c\fP, one for each \fIstructure_file.h\fP processed \fIio_\fPstructure_file\fI.cpp\fP, one for each \fIstructure_file.h\fP processed
by \fBICG\fP. by \fBICG\fP.
.TP
\fIhtml/io_\fPstructure_file\fI.h.html\fP
The HTML is put in files with names of the form:
\fIio_\fPstructure_file\fI.h.html\fP, one for each \fIstructure_file.h\fP
processed by \fBICG\fP.
.TP
\fIcatalog/structures\fP
Contains database information about the data structures which is used by
\fBCP\fP(1).
.TP
\fIcatalog/enumerated\fP
Contains database information about the enumerated data types which is used by
\fBCP\fP(1).
.TP
\fIcatalog/depends\fP
Contains database information about which files depend on which other files.
\fBICG\fP inserts dependency information for header files, \fBMIS\fP(1) inserts
dependency information for source code files. This information is used by
\fBCP\fP(1).
.TP
\fI${TRICK_HOME}/catalog/catalog\fP
Contains paths to all model catalog directories.
.SH "SEE ALSO" .SH "SEE ALSO"
\fBcatalog\fP(1), \fBCP\fP(1), \fBmake_build\fP(1) \fBtrick-CP\fP(1)
.PP .PP
All Trick model developers and users should go through the tutorial found All Trick model developers and users should go through the tutorial found
in the \fITrick Simulation Environment User Training Materials\fP. in the \fITrick Simulation Environment User Training Materials\fP.
@ -78,13 +65,9 @@ The canonical reference for all Trick commands, files and utilities is the
\fITrick Simulation Environment User's Guide\fP. Information specific to a \fITrick Simulation Environment User's Guide\fP. Information specific to a
given release of Trick tools is contained in the \fITrick Simulation given release of Trick tools is contained in the \fITrick Simulation
Environment Version Description\fP for that release. Environment Version Description\fP for that release.
.\" .SH DIAGNOSTICS .SH HISTORY
.\" How to determine why the command failed. 1991-2003 : The original \fBtrick-ICG\fP command was written by Rob Bailey
.SH BUGS
Known bugs will be placed in the \fIVersion Description Document\fP located in 2003-2012 : \fBtrick-ICG\fP ported to Perl by Alex Lin
$TRICK_HOME/docs area. If you would like to report a bug, contact
vetter@lincom-asg.com. 2013-present : \fBtrick-ICG\fP ported to C++ and uses clang/llvm to parse header files.
.SH AUTHORS
The \fBICG\fP command was written by Rob Bailey and is maintained by the
Trick development staff. This man page was written by Rick Sykes,
address all discrepancies to sykes@lincom-asg.com.

39
share/man/man1/trick-dp.1 Normal file
View File

@ -0,0 +1,39 @@
.TH trick-dp 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-dp \- Trick data products tools
.SH SYNOPSIS
\fBtrick-dp\fP
.SH DESCRIPTION
Trick data products are simulation data post processors designed to visualize
data recorded in a Trick simulation. The data products can plot ASCII, binary and
HDF5 data. \fItrick-dp\fP is the front end to the tool set allowing users to
choose which simulation runs to plot and which plots/tables to produce based on
which data product files are chosen.
.SH FILES
.TP
\fISIM_<simulation>/RUN_<run>\fP
The simulation directories containing recorded data.
.TP
\fISIM_<simulation>/DP_Product\fP
Directory containing data product files. Data product files specify how to layout
plots and tables and specify which simulation variables to plot.
.TP
\fISession.xml\fP
Saves the state of the trick-dp selections. Can be used to bring up plots and
tables without starting a trick-dp interactive session.
.SH "SEE ALSO"
\fBtrick-qp\fP(1), \fBtrick-fxplot\fP(1), \fBtrick-gxplot\fP(1), \fBtrick-jxplot\fP(1)
.PP
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-2000 : The original \fBtrick-dp\fP command was written by Rob Bailey and Eddie Paddock
2001-2009 : \fBtrick-dp\fP ported to Tcl/TK by Keith Vetter
2010-present : \fBtrick-dp\fP ported to Java by Hong Chen

29
share/man/man1/trick-dre.1 Normal file
View File

@ -0,0 +1,29 @@
.TH trick-dre 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-dre \- Trick Data Recording Editor
.SH SYNOPSIS
\fBtrick-dre\fP
.SH DESCRIPTION
The Trick Data Recording Editor creates input files describing data recording groups.
The dre presents a hierarchial list of variables the user may select to include in the
data recording group. The user is alos able to set the various parameters associated
with a data recording group such as name and recording frequency.
.SH FILES
.TP
\fISIM_<simulation>/Modified_data/file_name.dr\fP
The output of the dre is typically stored in the Modified_data directory and ends
in the suffix .dr.
.SH "SEE ALSO"
\fBtrick-dp\fP(1), \fBtrick-qp\fP(1)
.PP
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
2001-2009 : \fBtrick-dre\fP originally written in Tcl/TK by Keith Vetter
2010-present : \fBtrick-dre\fP ported to Java by Hong Chen

33
share/man/man1/trick-fxplot.1 Normal file
View File

@ -0,0 +1,33 @@
.TH trick-fxplot 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-fxplot \- Trick plot utility using the X-windows fermi-ware widget set.
.SH SYNOPSIS
\fBtrick-fxplot\fP <session_file>.xml
.SH DESCRIPTION
trick-fxplot is an X-windows based 2-D plotter of Trick simulation recorded data.
The input to trick-fxplot is a session file that lists the simulation directories
to plot, the layout of the plots, and the variables to place in each plot.
The session files are created through the \fBtrick-dp\fP command. trick-fxplot may
be brought up directly through the \fBtrick-dp\fP GUI.
.SH FILES
.TP
\fI/tmp/Session_<user>.xml\fP
The default session file name created by \fBtrick-dp\fP used as an arugment to
start \fBtrick-fxplot\fP
.SH "SEE ALSO"
\fBtrick-dp\fP(1), \fBtrick-qp\fP(1)
.PP
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-2000 : \fBfplot\fP originally written in C by Rob Bailey and Eddie Paddock
2001-2009 : \fBfplot\fP ported to C++ Keith Vetter
2010-present : \fBtrick-fxplot\fP rewritten by John Penn

33
share/man/man1/trick-gte.1 Normal file
View File

@ -0,0 +1,33 @@
.TH trick-gte 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-gte \- Trick Get Trick Environment
.SH SYNOPSIS
\fBtrick-gte\fP [OPTIONS]...
.SH DESCRIPTION
The Trick Get Trick Environment (trick-gte) command prints out the value of environment
variables used by Trick. trick-gte will print the value of the environment variable
if the user has set it, or trick-gte will print a default values it stores within itself.
.TP
\fBENVIRONMENT_VARIABLE\fP
Prints the value of the environemnt variable if it exists or prints out the default value
stored in trick-gte.
.TP
\fBS_source\fP
Used by trick-CP to store the values of all Trick environment variables into the simulation.
Not typically used outside of trick-CP.
.TP
\fB-e<pattern>\fP
Print out all Trick environment variables that match \fIpattern\fP. The pattern may be
a string or perl regular expression.
.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
1996-2002 : \fBgte\fP originally written in C by Greg Alexander
2003-present : \fBtrick-gte\fP ported to Perl by Alex Lin

33
share/man/man1/trick-gxplot.1 Normal file
View File

@ -0,0 +1,33 @@
.TH trick-gxplot 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-gxplot \- Trick plot utility using GNUPlot
.SH SYNOPSIS
\fBtrick-gxplot\fP <session_file>.xml
.SH DESCRIPTION
trick-gxplot uses GNUPlot to plot Trick simulation recorded data.
The input to trick-gxplot is a session file that lists the simulation directories
to plot, the layout of the plots, and the variables to place in each plot.
The session files are created through the \fBtrick-dp\fP command. trick-gxplot may
be brought up directly through the \fBtrick-dp\fP GUI.
.SH FILES
.TP
\fI/tmp/Session_<user>.xml\fP
The default session file name created by \fBtrick-dp\fP used as an arugment to
start \fBtrick-gxplot\fP
.SH "SEE ALSO"
\fBtrick-dp\fP(1), \fBtrick-qp\fP(1)
.PP
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-2000 : \fBgplot\fP originally written in C by Rob Bailey and Eddie Paddock
2001-2009 : \fBgplot\fP ported to C++ Keith Vetter
2010-present : \fBtrick-gxplot\fP rewritten by John Penn

29
share/man/man1/trick-jxplot.1 Normal file
View File

@ -0,0 +1,29 @@
.TH trick-jxplot 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-jxplot \- Trick plot utility using Java JFreeChart.
.SH SYNOPSIS
\fBtrick-jxplot\fP <session_file>.xml
.SH DESCRIPTION
trick-jxplot is a java JFreeChart plotter of Trick simulation recorded data.
The input to trick-jxplot is a session file that lists the simulation directories
to plot, the layout of the plots, and the variables to place in each plot.
The session files are created through the \fBtrick-dp\fP command. trick-jxplot may
be brought up directly through the \fBtrick-dp\fP GUI.
.SH FILES
.TP
\fI/tmp/Session_<user>.xml\fP
The default session file name created by \fBtrick-dp\fP used as an arugment to
start \fBtrick-jxplot\fP
.SH "SEE ALSO"
\fBtrick-dp\fP(1), \fBtrick-qp\fP(1)
.PP
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
2010-present : \fBtrick-jxplot\fP written by Hong Chen

29
share/man/man1/trick-killsim.1
View File

@ -1,17 +1,11 @@
.TH kill_sim 1 "May 17, 2000" "Trick" "Trick User's Manual" .TH trick-killsim 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME .SH NAME
kill_sim \- Kill Trick simulation and clean up associated shared memory and semaphores trick-killsim \- Kill Trick simulations
.SH SYNOPSIS .SH SYNOPSIS
\fBkill_sim\fP [\fIhostname\fP] \fBtrick-killsim\fP
.SH DESCRIPTION .SH DESCRIPTION
\fBkill_sim\fP is a bourne shell script whick kills Trick simulation processes for \fBtrick-killsim\fP is a bourne shell script whick kills all Trick simulation processes for
a user. \fBkill_sim\fP cleans up shared memory and semaphore entries as well as killing processes. With no arguments \fBkill_sim\fP will execute on the local machine. If called with a hostname \fBkill_sim\fP runs on the specified host. a user.
.SH FILES
.TP
.SH DEPENDENCY
.TP
\fBDependencies\fP: /bin/sh, echo, cut, ipcs, ipcrm, grep, ps
.TP
.SH "SEE ALSO" .SH "SEE ALSO"
All Trick model developers and users should go through the tutorial found All Trick model developers and users should go through the tutorial found
in the \fITrick Simulation Environment User Training Materials\fP. in the \fITrick Simulation Environment User Training Materials\fP.
@ -19,15 +13,6 @@ The canonical reference for all Trick commands, files and utilities is the
\fITrick Simulation Environment User's Guide\fP. Information specific to a \fITrick Simulation Environment User's Guide\fP. Information specific to a
given release of Trick tools is contained in the \fITrick Simulation given release of Trick tools is contained in the \fITrick Simulation
Environment Version Description\fP for that release. Environment Version Description\fP for that release.
.PP .SH HISTORY
.\" .SH DIAGNOSTICS 1997-present : \fBtrick-killsim\fP was written by Greg Alexander
.\" How to determine why the command failed.
.SH BUGS
Known bugs will be placed in the \fIVersion Description Document\fP located in
$TRICK_HOME/docs area. If you would like to report a bug, contact
vetter@lincom-asg.com.
.SH AUTHORS
The \fBkill_sim\fP command was written by Greg Alexander and is maintained by the
Trick development staff. This man page was written by Greg Alexander,
address all discrepancies to grega@lincom-asg.com.

19
share/man/man1/trick-mm.1 Normal file
View File

@ -0,0 +1,19 @@
.TH trick-mm 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-mm \- Trick Monte Monitor
.SH SYNOPSIS
\fBtrick-mm\fP
.SH DESCRIPTION
The Trick Monte Monitor diplays the status of a running Trick monte carlo simulation.
The Monte Monitor connects to the Trick monte carlo master simulation through the simulation
variable server.
.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
2013-present : \fBtrick-mm\fP written in Java by Danny Strauss

20
share/man/man1/trick-mtv.1 Normal file
View File

@ -0,0 +1,20 @@
.TH trick-mtv 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-mtv \- Trick Malfunctions Trick Viewer
.SH SYNOPSIS
\fBtrick-mtv\fP
.SH DESCRIPTION
The Trick Malfunctions Trick Viewer (mtv) displays all malfunctions and events defined in
a simulation. The mtv connects to the simulation through the simulation
variable server. Users may create, modify, trigger, and disable malfunctions
within the simulation using mtv.
.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 comtvands, 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
2013-present : \fBtrick-mtv\fP written in Java by Danny Strauss

29
share/man/man1/trick-qp.1 Normal file
View File

@ -0,0 +1,29 @@
.TH trick-qp 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-qp \- Trick Quick Plot
.SH SYNOPSIS
\fBtrick-qp\fP
.SH DESCRIPTION
Quick plot may be used to select simulation variables and to layout plots and tables
using these variables. Quick plot can use \fBtrick-fxplot\fP, \fBtrick-gxplot\fP, and
\fBtrick-jxplot\fP to visualize the user selections. Quick plot is used to save this
layout information to data product files used with \fBtrick-dp\fP.
.SH FILES
.TP
\fI/tmp/DP_<alin>.xml\fP
Used to temporarily save the state of the trick-qp selections when calling the
plotting utilities from trick-qp.
.SH "SEE ALSO"
\fBtrick-qp\fP(1), \fBtrick-fxplot\fP(1), \fBtrick-gxplot\fP(1), \fBtrick-jxplot\fP(1)
.PP
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
2003-2009 : \fBtrick-qp\fP written n Tcl/TK by Keith Vetter
2010-present : \fBtrick-qp\fP ported to Java by Hong Chen

39
share/man/man1/trick-sie.1 Normal file
View File

@ -0,0 +1,39 @@
.TH trick-sie 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-sie \- Trick Smart Input Editor
.SH SYNOPSIS
\fBtrick-sie\fP [substring]
.SH DESCRIPTION
The Trick Smart Input Editor (sie) is a simulation variable query utility.
The Monte Monitor connects to the Trick monte carlo master simulation through the simulation
variable server.
.PP
Without arguments \fBtrick-sie\fP starts a GUI wih a hierarchial tree of simulation_objects,
structures/classes, and the variables contained within. Selecting a variable shows the
C/C++ type of the variable, the Trick input/output capabilities, the measurement units,
and the comment associated with the variable.
.TP
\fBsubstring\fP
Calling trick-sie with a \fIsubstring\fP does not start the GUI. Instead the tree of
variable names is searched for \fIsubstring\fP. All variable names containing \fIsubstring\fP
will be printed along with the Trick input/output capabilities, the measurement units,
and the comment associated with the variable.
.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 cosieands, 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
The sie started as an input file text editor. The sie was aware of simulation
sim_objects and the variable names contained within math model structures. sie
was not used much as users favored more capable editors such as vi and emacs. sie
was later repurposed as a simulation variable query utility. This is why the
Smart Input Editor has no editing capabilites.
1991-2000 : \fBsie\fP written in C by Rob Bailey and Eddie Paddock
2001-2009 : \fBsie\fP written in Tck/Tk by Keith Vetter
2010-present : \fBtrick-sie\fP written in Java by Hong Chen

38
share/man/man1/trick-simcontrol.1 Normal file
View File

@ -0,0 +1,38 @@
.TH trick-simcontrol 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-simcontrol \- Trick Simulation Control panel
.SH SYNOPSIS
\fBtrick-simcontrol\fP [host port]
.SH DESCRIPTION
The Trick Simulation Control panel (sim_control_panel) sends control commands to a simulation
and views the status of a simulation.
The sim_control_panel is able to start/freeze/unpause/shutdown a simulation. The sim_control_panel
is also able to turn on/off real-time synchronization and simulation data recording.
The sim_control_panel displays the current running mode of the simulation, the simulation
elapsed time, and status messages outputted by the sim.
The sim_control_panel is used to launch other Trick runtime GUIs including the Trick View,
\fBtrick-tv\fP, and the Malfunctions Trick View, \fBtrick-mtv\fP.
.TP
\fBhost port\fP
Specify a hostname and port of a simulation to connect to. The port number is the
variable server port of the simulation.
.SH "SEE ALSO"
\fBtrick-mtv\fP(1), \fBtrick-tv\fP(1)
.PP
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-2000 : \fBsim_control\fP written in C by Rob Bailey and Eddie Paddock
2001-2009 : \fBsim_control.tcl\fP written in Tcl/TK by Keith Vetter
2010-present : \fBtrick-simcontrol\fP written in Java by Hong Chen

24
share/man/man1/trick-sniffer.1 Normal file
View File

@ -0,0 +1,24 @@
.TH trick-sniffer 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-sniffer \- Trick Simulation Sniffer
.SH SYNOPSIS
\fBtrick-sniffer\fP
.SH DESCRIPTION
The Trick Simulation Sniffer listens for simulation broadcast messages emmitted by all simulations.
The sniffer lists the simulations and provides the capability to connect a \fBtrick-simcontrol\fP
, \fBtrick-tv\fP, \fBtrick-mtv\fP, or \fBtrick-mm\fP to the simulation.
.SH "SEE ALSO"
\fBtrick-mm\fP(1), \fBtrick-mtv\fP(1), \fBtrick-simcontrol\fP(1), \fBtrick-tv\fP(1)
.PP
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
2007-2012 : \fBtrick-sniffer\fP written in Tcl/TK by Alex Lin
2013-present : \fBtrick-sniffer\fP written in Java by Hong Chen

34
share/man/man1/trick-trk2ascii.1 Normal file
View File

@ -0,0 +1,34 @@
.TH trick-trk2ascii 1 "August 1, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-trk2ascii \- converts Trick data recording files from binary to ASCII
.SH SYNOPSIS
\fBtrick-trk2ascii\fP[OPTIONS]...
.SH DESCRIPTION
trick-trk2ascii converts Trick data recording files from binary to ASCII.
.TP
\fB-help\fP
Prints help message
.TP
\fB-csv, ascii\fP
Generates a comma-separated value (CSV) file.
.TP
\fB-fix\fP
Generates a fixed column width ascii file.
.TP
\fB-xml\fP
Generates an eXtensible Markup Language (XML) file.
.TP
\fBdelimiter='<delimit_string>'\fP
Change the default delimiter used in csv & fix ascii formats from comma separated ","
to another character or string.
.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
2007-present : \fBtrick-trk2ascii\fP written in C++ by Warwick Woodard

22
share/man/man1/trick-tv.1 Normal file
View File

@ -0,0 +1,22 @@
.TH trick-tv 1 "August 2, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-tv \- Trick Viewer
.SH SYNOPSIS
\fBtrick-tv\fP
.SH DESCRIPTION
The Trick Viewer (tv) is a graphical user interface that allows users to
view and modify Trick managed variables in a simulation while it is running.
It also provides for the launching of integrated strip charts and can save and
restore lists of variables and their associated strip charts.
.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 cotvands, 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
2001-2010 : \fBtrick_tv\fP written in Tcl/TK by Keith Vetter
2013-present : \fBtrick-tv\fP ported to Java by Derek Bankieris

27
share/man/man1/trick-version.1 Normal file
View File

@ -0,0 +1,27 @@
.TH trick-version 1 "August 2, 2016" "Trick" "Trick User's Manual"
.SH NAME
trick-version \- Trick Version
.SH SYNOPSIS
\fBtrick-version\fP[OPTIONS]...
.SH DESCRIPTION
The Trick Version prints the current version of Trick. Wee! Without arguments
trick-version prints the full Trick version.
.TP
\fB-f, -full, -v, -version\fP
Prints the full version including year (major), minor, and patchlevel
.TP
\fB-m, -minor\fP
Prints the minor version
.TP
\fB-y, -year\fP
Prints the year (major) version
.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 coversionands, 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
2003-present : \fBtrick-version\fP written in Perl by Alex Lin

2
trick_source/codegen/Interface_Code_Gen/main.cpp
View File

@ -46,7 +46,7 @@ llvm::cl::list< std::string > pre_compiled_headers("include", llvm::cl::Prefix,
//llvm::cl::opt< bool > show_units ("u", llvm::cl::desc("List recognized units")) ; //llvm::cl::opt< bool > show_units ("u", llvm::cl::desc("List recognized units")) ;
void ICG_version() { void ICG_version() {
std::cout << "Trick Interface Code Generator (ICG) 13.dev" << std::endl ; std::cout << "Trick Interface Code Generator (trick-ICG) " << TRICK_VERSION << std::endl ;
} }
/** /**

2
trick_source/codegen/Interface_Code_Gen/makefile
View File

@ -60,7 +60,7 @@ $(ICG): $(OBJECTS) $(UDUNITS_OBJS)
# Only FieldDescription.cpp includes the units conversion header. # Only FieldDescription.cpp includes the units conversion header.
$(OBJ_DIR)/FieldDescription.o : CXXFLAGS += -I$(TRICK_HOME)/include $(OBJ_DIR)/FieldDescription.o : CXXFLAGS += -I$(TRICK_HOME)/include
$(OBJ_DIR)/HeaderSearchDirs.o : CXXFLAGS += -DLLVM_HOME=\"${LLVM_HOME}\" $(OBJ_DIR)/HeaderSearchDirs.o : CXXFLAGS += -DLLVM_HOME=\"${LLVM_HOME}\"
$(OBJ_DIR)/main.o : CXXFLAGS += $(UNITS_CONV_INCLUDE) $(OBJ_DIR)/main.o : CXXFLAGS += $(UNITS_CONV_INCLUDE) -DTRICK_VERSION=\"${TRICK_VERSION}\"
$(OBJECTS): $(OBJ_DIR)/%.o : %.cpp $(OBJECTS): $(OBJ_DIR)/%.o : %.cpp
$(CXX) $(CXXFLAGS) -c $< -o $@ $(CXX) $(CXXFLAGS) -c $< -o $@