summaryrefslogtreecommitdiff
path: root/bin/MakeProjectCreator/USAGE
blob: 90bcfafd863f34da0e165987cdcaaaa1312f42a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
Running the Workspace Generator
-------------------------------

The most common way to use the Make Project Creator is to run the
workspace generator (mwc.pl).  This script will generate projects and a
single workspace that contains the generated projects.  If no input file
(.mwc file) is specified, it will recurse into the directory in which the
script was started.  It looks for .mpc files and generates a project or
projects for each one found.


Usage: mwc.pl [-global <file>] [-include <directory>] [-recurse]
              [-ti <dll | lib | dll_exe | lib_exe>:<file>]
              [-template <file>] [-relative NAME=VAR] [-base <project>]
              [-noreldefs] [-notoplevel] [-static] [-static_only]
              [-value_template <NAME+=VAL | NAME=VAL | NAME-=VAL>]
              [-value_project <NAME+=VAL | NAME=VAL | NAME-=VAL>]
              [-type <borland | em3 | ghs | gnu | make | nmake |
                      va4 | vc6 | vc7>]
              [files]

       -base           Add <project> as a base project to each generated
                       project file.
       -global         Specifies the global input file.  Values stored
                       within this file are applied to all projects.
       -include        Specifies a directory to search when looking for base
                       projects, template input files and templates.  This
                       option can be used multiple times to add directories.
       -ti             Specifies the template input file (with no extension)
                       for the specific type as shown above
                       (ex. -ti dll_exe:vc8exe)
       -template       Specifies the template name (with no extension).
       -static         Specifies that static projects will be generated in
                       addition to dynamic projects.
       -static_only    Specifies that only static projects will be generated.
       -recurse        Recurse from the current directory and generate from
                       all found input files.
       -relative       Any $() variable in an mpc that is matched to NAME
                       is replaced by VAR only if VAR can be made into a
                       relative path based on the current working directory.
       -noreldefs      Do not try to generate default relative definitions.
       -notoplevel     Do not generate the top level target file.  Files
                       are still process, but no top level file is created.
       -value_template This option allows modification of a template input
                       name value pair.  Use += to add VAL to the NAME's
                       value.  Use -= to subtract and = to override the value.
                       It is important to note that this will only modify
                       existing template input name value pairs and can not
                       be used to introduce new name value pairs.
       -value_project  This option allows modification of a project variable
                       assignment .  Use += to add VAL to the NAME's value.
                       Use -= to subtract and = to override the value.
                       This can be used to introduce new name value pairs to
                       a project.  However, it must be a valid project
                       assignment.
       -type           Specifies the type of project file to generate.  This
                       option can be used multiple times to generate multiple
                       types.  If -type is not used, it defaults to 'gnu'.

The default global input file
(ACE_wrappers/bin/MakeProjectCreator/config/global.mpb) is used if -global
is not specified on the command line.

Two include directories are used by default
(ACE_wrappers/bin/MakeProjectCreator/config and
ACE_wrappers/bin/MakeProjectCreator/templates).

Each project creator has a default template input file for each type of
project (dll_exe, lib_exe, dll, lib).  You can override the default template
input file name with the -ti option.  The file must have a 'mpt' extension
and must reside within the include search directories.  NOTE: the 'lib' and
the 'lib_exe' template input files are only used if the project creator makes
a separate project file for dynamic libraries and static libraries.

The -template option is used to override the default template name.  This
file should have a .mpd extension and sit in one of the include search
directories.  NOTE: The -template option overrides the template file for all
types specified.

The -static option can be used to generate static project files in addition
to dynamic project files.  This currently only applies to the vc6 type.

The -static_only option can be used to avoid generating dynamic project
files.  This currently only applies to the vc6 type.

The -noreldefs option says not to generate default relative definitions for
ACE_ROOT and TAO_ROOT (which would come from environment variables).

The -notoplevel option tells mwc.pl to generate all projects for a
workspace, but do not generate the top level workspace file.  For mpc.pl, it
says process the mpc files, but do not generate the project files.

The -type option can be used multiple times on the same command line to
generate projects of different types per mpc file.  The default type is
always gnu.  NOTE: The -ti option overrides the template input file for all
types specified.


Running only the Project Generator
----------------------------------

Most of what is stated about the Workspace Generator applies to the Project
Generator except that it only generates projects.  If an input file (.mpc
file) is not provided, the project creator will attempt to create a default
project in the directory from which the script was started.


Usage: mpc.pl [-global <file>] [-include <directory>] [-recurse]
              [-ti <dll | lib | dll_exe | lib_exe>:<file>]
              [-template <file>] [-relative NAME=VAR] [-base <project>]
              [-noreldefs] [-notoplevel] [-static] [-static_only]
              [-value_template <NAME+=VAL | NAME=VAL | NAME-=VAL>]
              [-value_project <NAME+=VAL | NAME=VAL | NAME-=VAL>]
              [-type <borland | em3 | ghs | gnu | make | nmake |
                      va4 | vc6 | vc7>]
              [files]

       -base           Add <project> as a base project to each generated
                       project file.
       -global         Specifies the global input file.  Values stored
                       within this file are applied to all projects.
       -include        Specifies a directory to search when looking for base
                       projects, template input files and templates.  This
                       option can be used multiple times to add directories.
       -ti             Specifies the template input file (with no extension)
                       for the specific type as shown above
                       (ex. -ti dll_exe:vc8exe)
       -template       Specifies the template name (with no extension).
       -static         Specifies that static projects will be generated in
                       addition to dynamic projects.
       -static_only    Specifies that only static projects will be generated.
       -recurse        Recurse from the current directory and generate from
                       all found input files.
       -relative       Any $() variable in an mpc that is matched to NAME
                       is replaced by VAR only if VAR can be made into a
                       relative path based on the current working directory.
       -noreldefs      Do not try to generate default relative definitions.
       -notoplevel     Do not generate the top level target file.  Files
                       are still process, but no top level file is created.
       -value_template This option allows modification of a template input
                       name value pair.  Use += to add VAL to the NAME's
                       value.  Use -= to subtract and = to override the value.
                       It is important to note that this will only modify
                       existing template input name value pairs and can not
                       be used to introduce new name value pairs.
       -value_project  This option allows modification of a project variable
                       assignment .  Use += to add VAL to the NAME's value.
                       Use -= to subtract and = to override the value.
                       This can be used to introduce new name value pairs to
                       a project.  However, it must be a valid project
                       assignment.
       -type           Specifies the type of project file to generate.  This
                       option can be used multiple times to generate multiple
                       types.  If -type is not used, it defaults to 'gnu'.