doc/reference/Command.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE sconsdoc [
   3     <!ENTITY % scons SYSTEM "../scons.mod">
   4     %scons;
   5 ]>
   6
   7 <section id="sect-Command"
   8          xmlns="http://www.scons.org/dbxsd/v1.0"
   9          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  10          xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">
  11 <title>The Command Builder</title>
  12
  13 <!--
  14
  15   __COPYRIGHT__
  16
  17   Permission is hereby granted, free of charge, to any person obtaining
  18   a copy of this software and associated documentation files (the
  19   "Software"), to deal in the Software without restriction, including
  20   without limitation the rights to use, copy, modify, merge, publish,
  21   distribute, sublicense, and/or sell copies of the Software, and to
  22   permit persons to whom the Software is furnished to do so, subject to
  23   the following conditions:
  24
  25   The above copyright notice and this permission notice shall be included
  26   in all copies or substantial portions of the Software.
  27
  28   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  29   KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  30   WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  31   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  32   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  33   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  34   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  35
  36 -->
  37
  38 <!--
  39
  40 =head2 The C<Command> method
  41
  42 The C<Command> method is a catchall method which can be used to arrange for
  43 any build action to be executed to update the target. For this command, a
  44 target file and list of inputs is provided. In addition, a build action
  45 is specified as the last argument.  The build action is typically a
  46 command line or lines, but may also contain Perl code to be executed;
  47 see the section above on build actions for details.
  48
  49 The C<Command> method is called as follows:
  50
  51   Command $env <target>, <inputs>, <build action>;
  52
  53 The target is made dependent upon the list of input files specified, and the
  54 inputs must be built successfully or Cons will not attempt to build the
  55 target.
  56
  57 To specify a command with multiple targets, you can specify a reference to a
  58 list of targets. In Perl, a list reference can be created by enclosing a
  59 list in square brackets. Hence the following command:
  60
  61   Command $env ['foo.h', 'foo.c'], 'foo.template', q(
  62         gen %1
  63   );
  64
  65 could be used in a case where the command C<gen> creates two files, both
  66 F<foo.h> and F<foo.c>.
  67
  68 -->
  69
  70  <para>
  71
  72    X
  73
  74  </para>
  75
  76  <section>
  77  <title>The &Command; Method</title>
  78
  79    <para>
  80
  81    X
  82
  83    </para>
  84
  85  </section>
  86
  87 </section>