[Pkg-ace-devel] r301 - /branches/manpages/debian/mpc.sgml
tgg-guest at users.alioth.debian.org
tgg-guest at users.alioth.debian.org
Sat May 6 13:34:46 UTC 2006
Author: tgg-guest
Date: Sat May 6 13:34:44 2006
New Revision: 301
URL: http://svn.debian.org/wsvn/pkg-ace/?sc=1&rev=301
Log:
At last, I'm done with this man page.
I will submit it to upstream asap.
Modified:
branches/manpages/debian/mpc.sgml
Modified: branches/manpages/debian/mpc.sgml
URL: http://svn.debian.org/wsvn/pkg-ace/branches/manpages/debian/mpc.sgml?rev=301&op=diff
==============================================================================
--- branches/manpages/debian/mpc.sgml (original)
+++ branches/manpages/debian/mpc.sgml Sat May 6 13:34:44 2006
@@ -1,7 +1,10 @@
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
- <!ENTITY mpc "mpc">
- <!ENTITY mwc "mwc">
+ <!ENTITY mpc "mpc.pl">
+ <!ENTITY mwc "mwc.pl">
]>
+<!-- This file was written by Thomas Girard <thomas.g.girard at free.fr> -->
+<!-- on May 2006 for the Debian GNU/Linux operating system. -->
+<!-- It is mainly a plain text to DocBook conversion of the USAGE file. -->
<refentry>
<refmeta>
<refentrytitle>MPC</refentrytitle>
@@ -27,13 +30,29 @@
<refsect1>
<title>DESCRIPTION</title>
<para>
- <command>&mpc;</command> and <command>&mwc;</command>, the Makefile,
- Project and Workspace Creator generate platform and compiler specific
- files to automate the compilation process.
+ <command>&mpc;</command> and <command>&mwc;</command>, the Makefile,
+ Project and Workspace Creator generate platform and compiler specific
+ files to automate the compilation process
+ (e.g. <filename>GNUmakefile</filename>
+ and <filename>Makefile.am</filename>).
</para>
<para>
- Such files include <filename>GNUmakefile</filename> and
- <filename>Makefile.am</filename>.
+ The most common way to use the Make Project Creator is to run the
+ workspace generator (<command>&mwc;</command>). This script will
+ generate projects and a single workspace that contains the generated
+ projects. If no input
+ <replaceable>FILE</replaceable> (<filename>.mwc</filename> file)
+ is specified, it will recurse into
+ the directory in which the script was started. It looks for
+ <filename>.mpc</filename> files and generates a project or projects
+ for each one found.
+ </para>
+ <para>
+ Most of what is stated about <command>&mwc;</command> applies to
+ <command>&mpc;</command> except that it only generates projects. If an
+ input <replaceable>FILE</replaceable> (<filename>.mpc</filename> file) is
+ not provided, the project creator will attempt to create a default
+ project in the directory from which the script was started.
</para>
<variablelist>
<varlistentry>
@@ -41,7 +60,8 @@
<listitem>
<para>
specifies the global input file. Values stored within this file are
- applied to all projects
+ applied to all projects. If not specified, defaults to
+ <filename>config/global.mpb</filename>
</para>
</listitem>
</varlistentry>
@@ -51,16 +71,22 @@
<para>
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
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>-recurse</parameter></term>
+ multiple times to add directories. Two include directories
+ are used by default (<filename class="directory">config</filename>
+ and <filename class="directory">templates</filename>)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>-recurse</parameter>[=<replaceable>directories</replaceable>]</term>
<listitem>
<para>
recurse from the current directory and generate from all found
- input files
+ input files. If <replaceable>directories</replaceable> are
+ passed in a comma separated list
+ (e.g. <parameter>-recurse=examples,apps,TAO</parameter>), then
+ those directories will be excluded when searching for project or
+ workspace files
</para>
</listitem>
</varlistentry>
@@ -69,7 +95,17 @@
<listitem>
<para>
specifies the template input file (with no extension) for the
- specific type, e.g. <parameter>-ti dll_exe:vc8exe</parameter>
+ specific type, e.g. <parameter>-ti dll_exe:vc8exe</parameter>. Each
+ project creator has a default template input file for each type of
+ project (<parameter>dll_exe</parameter>, <parameter>lib_exe</parameter>,
+ <parameter>dll</parameter>, <parameter>lib</parameter>). You can
+ override the default template input file name with the
+ <parameter>-ti</parameter> option. The file must have a
+ <filename>mpt</filename> extension and must reside within the
+ include search directories. NOTE: the <parameter>lib</parameter>
+ and the <parameter>lib_exe</parameter> template input files are only
+ used if the project creator makes a separate project file for dynamic
+ libraries and static libraries
</para>
</listitem>
</varlistentry>
@@ -77,7 +113,13 @@
<term><parameter>-hierarchy</parameter></term>
<listitem>
<para>
- generate a workspace in a hierarchical fashion
+ generate a workspace in a hierarchical fashion. Forces the
+ generation of a hierarchical workspace at each directory level in
+ between the toplevel directory and the location of the
+ <filename>.mpc</filename> file that is being processed. This is the
+ default for <parameter>make</parameter> based workspace creators.
+ NOTE: This option only has no effect when when used with
+ <command>&mpc;</command>
</para>
</listitem>
</varlistentry>
@@ -85,7 +127,11 @@
<term><parameter>-template</parameter> <replaceable>file</replaceable></term>
<listitem>
<para>
- specifies the template name (with no extension)
+ specifies the template name (with no extension).
+ <replaceable>file</replaceable> should have a
+ <filename>.mpd</filename> extension and sit in one of the include
+ search directories. NOTE: The <parameter>-template</parameter>
+ option overrides the template file for all types specified
</para>
</listitem>
</varlistentry>
@@ -97,7 +143,7 @@
<replaceable>name</replaceable> is replaced by
<replaceable>var</replaceable> only if
<replaceable>var</replaceable> can be made into a relative path based
- on the current working directory.
+ on the current working directory
</para>
</listitem>
</varlistentry>
@@ -108,7 +154,7 @@
add <replaceable>project</replaceable> as a base project to each
generated project file. Do not provide a file extension, the
<filename>.mpb</filename> extension will be tried first; if that
- fails the <filename>.mpc</filename> extension will be tried.
+ fails the <filename>.mpc</filename> extension will be tried
</para>
</listitem>
</varlistentry>
@@ -116,7 +162,8 @@
<term><parameter>-noreldefs</parameter></term>
<listitem>
<para>
- do not try to generate default relative definitions
+ do not try to generate default relative definitions for
+ <varname>*_ROOT</varname>, which come from environment variables
</para>
</listitem>
</varlistentry>
@@ -125,7 +172,11 @@
<listitem>
<para>
do not generate the top level target file. Files are still process,
- but no top level file is created
+ but no top level file is created. For <command>&mwc;</command>, it
+ says process all projects for a workspace, but do not generate the
+ top level workspace file. For <command>&mpc;</command>, it says
+ process the <filename>.mpc</filename> files, but do not generate
+ the project files
</para>
</listitem>
</varlistentry>
@@ -134,7 +185,32 @@
<listitem>
<para>
specifies that only static projects will be generated. By default,
- only dynamic projects will be generated
+ only dynamic projects will be generated. This parameter was
+ previously <parameter>-static_only</parameter>. Currently,
+ <command>&mpc;</command> only supports generating dynamic projects
+ or static projects, but not both during the same run. To generate
+ them both you must run <command>&mpc;</command> twice, once with the
+ <parameter>-static</parameter> option and once without.
+ Additionally, the <parameter>vc6</parameter>,
+ <parameter>em3</parameter>, <parameter>vc7</parameter>,
+ <parameter>vc71</parameter> and <parameter>vc8</parameter> project
+ names will no longer automatically have
+ <filename>_Static</filename> appended to the project name when
+ generating static projects. This can still be achieved by using the
+ <parameter>-name_modifier</parameter> option.
+ </para>
+ <para>
+ When generating static projects, inter-project dependencies will
+ not be generated for libraries within <parameter>vc6</parameter>,
+ <parameter>em3</parameter>, <parameter>vc7</parameter>,
+ <parameter>vc71</parameter> and <parameter>vc8</parameter>
+ workspaces. The reason is due to the fact that each static
+ library that depended upon another would be combined at the
+ library creation stage, resulting in extremely large libraries.
+ This behavior can be modified by setting the
+ <envar>MPC_DEPENDENCY_COMBINED_STATIC_LIBRARY</envar> environment
+ variable. It will force <command>&mpc;</command> to generate
+ inter-project dependencies for libraries within a single workspace
</para>
</listitem>
</varlistentry>
@@ -142,8 +218,11 @@
<term><parameter>-genins</parameter></term>
<listitem>
<para>
- generate <filename>.ins</filename> files for use with
- <command>prj_install.pl</command>
+ generate <filename>.ins</filename> files after
+ processing each project that can be used in conjunction with the
+ <command>prj_install.pl</command> script to install different
+ parts of the project (such as header files) into an alternate
+ location
</para>
</listitem>
</varlistentry>
@@ -165,7 +244,7 @@
<replaceable>val</replaceable> to the
<replaceable>name</replaceable>'s value. Use
<parameter>-=</parameter> to subtract and <parameter>=</parameter> to
- override the value.
+ override the value
</para>
</listitem>
</varlistentry>
@@ -196,8 +275,14 @@
<term><parameter>-feature_file</parameter> <replaceable>file</replaceable></term>
<listitem>
<para>
- specifies the feature file to read before processing. The default
- feature file is <filename>default.features</filename> under the
+ specifies the features file to read before processing. These
+ feature names can be anything, but they should correspond
+ to values used for the <property>requires</property> and
+ <property>avoids</property> keywords. If a feature is required and
+ is not enabled then the project will not be created. If a feature
+ is to be avoided and it is enabled then the project will not be
+ created. The default feature file is
+ <filename>default.features</filename> under the
<filename class="directory">config</filename> directory
</para>
</listitem>
@@ -216,7 +301,9 @@
<term><parameter>-features</parameter> <replaceable>features</replaceable></term>
<listitem>
<para>
- specifies the feature list to set before processing
+ specifies the feature list to set before processing. Values
+ specified by this option overwrite values from features files,
+ e.g. <parameter>-features "qos=1,ssl=0"</parameter>
</para>
</listitem>
</varlistentry>
@@ -224,7 +311,9 @@
<term><parameter>-exclude</parameter> <replaceable>directories</replaceable></term>
<listitem>
<para>
- use this option to exclude directories when searching for input files
+ use this option to exclude directories when searching for input
+ files. NOTE: This option has no effect when used with
+ <command>&mpc;</command>
</para>
</listitem>
</varlistentry>
@@ -232,10 +321,14 @@
<term><parameter>-name_modifier</parameter> <replaceable>pattern</replaceable></term>
<listitem>
<para>
- modify output names. The <replaceable>pattern</replaceable> passed
+ modify generated workspace or project names. The
+ <replaceable>pattern</replaceable> passed
to this parameter will have the <filename>*</filename> portion
replaced with the actual output name. For example
- <parameter>-name_modifier '*_Static'</parameter>
+ <parameter>-name_modifier '*_Static'</parameter> will result in all
+ workspace and project names ending in <filename>_Static</filename>,
+ e.g. <filename>FOO_Static.dsw</filename> and
+ <filename>FOO_Static.dsp</filename>
</para>
</listitem>
</varlistentry>
@@ -244,7 +337,9 @@
<listitem>
<para>
when used in conjunction with <parameter>-name_modifier</parameter>,
- it applies the name modifier to the project name also
+ it applies the name modifier to the project name also. NOTE: this
+ option has no effect without the
+ <parameter>-name_modifier</parameter> option
</para>
</listitem>
</varlistentry>
@@ -281,7 +376,8 @@
specifies the type of project file to generate. This option can
be used multiple times to generate multiple types. If
<parameter>-type</parameter> is not used, it defaults to
- <parameter>make</parameter>
+ <parameter>make</parameter>. NOTE: The <parameter>-ti</parameter>
+ option overrides the template input file for all types specified
</para>
</listitem>
</varlistentry>
@@ -292,7 +388,70 @@
<title>ENVIRONMENT VARIABLES</title>
<para>
The following environment variables could affect
- <command>mwc</command> and <command>mpc</command>:
+ <command>&mwc;</command> and <command>&mpc;</command>:
+
+ <variablelist>
+ <varlistentry>
+ <term><envar>MPC_COMMANDLINE</envar></term>
+ <listitem>
+ <para>
+ the value of this environment variable will be
+ prepended to the options passed to
+ <command>&mwc;</command> or <command>&mpc;</command> (if any
+ are passed)
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><envar>MPC_VERBOSE_ORDERING</envar></term>
+ <listitem>
+ <para>
+ if this is set, <command>&mwc;</command> will warn the user about
+ references to projects in the <property>after</property> keyword
+ that have not been processed
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><envar>MPC_DEPENDENCY_COMBINED_STATIC_LIBRARY</envar></term>
+ <listitem>
+ <para>
+ see the help on <parameter>-static</parameter> parameter above
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><envar>MPC_SILENT</envar></term>
+ <listitem>
+ <para>
+ if this is set, <command>&mpc;</command> will not print out any
+ information or warnings when processing projects or
+ workspaces. Errors are always printed if any are encountered
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><envar>MPC_LOGGING</envar></term>
+ <listitem>
+ <para>
+ if this is set, <command>&mpc;</command> will parse the value
+ and provide informational, warning, diagnostic and detail
+ messages depending on it's setting. If the
+ <envar>MPC_LOGGING</envar> value contains
+ <property>info=1</property>, informational
+ messages will be printed. If it contains
+ <property>warn=1</property>, warning
+ messages will be printed. If it contains
+ <property>diag=1</property>, diagnostic
+ messages will be printed. And lastly, if it contains
+ <property>detail=1</property>,
+ detail messages will be printed. If it contains none of these,
+ <command>&mpc;</command> will act as if <envar>MPC_SILENT</envar>
+ was set.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
</refsect1>
</refentry>
More information about the Pkg-ace-devel
mailing list