RADE

Multi-Workspace Application Builder

mkmk Handbook

Summary of mkmk capabilities
Quick Reference

Purpose

This page is intended for developers and people getting started with mkmk and related tools.

The reader will find here how to set up his environment to access commands and a brief description on the most useful commands and topics. Note that all commands or options are not given here, please refer to the manual pages to get them.

We advice you to add a bookmark to this page or to print it.
Build objects Manage prerequisites (frameworks)
Run applications Main file suffixes

[Top]

Build objects

Purpose Commands Parameter(s)
Get a command usage command_name -h (h for help)
Build a framework cd ws_root_dir/framework
mkmk

or

cd ws_root_dir
mkmk

-a (a for all)

nbsp;
 

{framework}
Build a module cd ws_root_dir/fw_name/module_name
mkmk

or

cd ws_root_dir/fw_name
mkmk module_name

 

 

{framework/module}
Build an identity card cd ws_root_dir/framework
mkmk -idcard or mkCI

 

(*) If you have set the "Workspace Manager" environment, you already have access to build commands.

(**) The given example may not correspond to your local installation, please ask your administrator for the location of your own installation.

[Top]

Manage prerequisites (frameworks)

Purpose Commands Parameter(s)
Specify prerequisites of a framework Edit file

framework/IdentityCard/IdentityCard.h

 Add following line for each
prerequisite framework:

AddPrereqComponent("framework", Public);
Refer prerequisites for dynamic access mkGetPreq -p ws_root_dir[:ws_root_dir]
[-simu]
Refer prerequisites for static access mkCopyPreq -p ws_root_dir[:ws_root_dir]
[-f] [-d] [-copysrc | -copyall] [-simu]

[Top]

Run applications

Purpose Commands Parameter(s)
Set environment before
running a program		 mkCreateRuntimeView [-c | -l | -f] [-d]
Run "CATIA based" application
built in current workspace		 mkrun -c command_name
[{command_parameters}]

[Top]

Main file suffixes

Here are the main file suffixes that are used in CATIA developments and the corresponding locations in the file tree.
Following suffixes must be used in order to let mkmk chooses the right compiler for the right file.

Suffix Location Meaning
.h framework/PublicInterfaces/ C or C++ header file defining the framework services for clients.
  framework/PrivateInterfaces/ C or C++ header file providing services from a module to the other modules of the same framework. Such resources are not visible outside the framework.
  framework/ProtectedInterfaces/ C or C++ header file defining the framework services for internal clients.
  framework/module.m/LocalInterfaces/ C or C++ header file private to the module.
.cpp framework/module.m/src/ C++ source file.
.c framework/module.m/src/ C source file.
.mk framework/module.m/ Template for mkmk and specifying what to produce from this module.
.f framework/module.m/src/ Fortran source file.
.l or .lc framework/module.m/src/ Lex source file, use .l to generate C++ source code and .lc to generate C source code.( only on UNIX plateform)
.y or .yc framework/module.m/src/ Yacc source file, use .y to generate C++ source code and .yc to generate C source code. (only on UNIX plateform)
.sh framework.tst/FunctionTests/TestCases/...
framework.tst/FunctionTests/SwitchTestCases/...		 Shell program used for tests or for any purpose.
.idl framework/PublicInterfaces/ IDL (Interface Definition Language).

[Top]

History

Version: 1 [Mar 2000] Document created
[Top]

Copyright © 2000, Dassault Systèmes. All rights reserved.