← Back to branch summary

~mandel/ubuntuone-windows-installer/fix_null_pointer_start

« back to all changes in this revision

Viewing changes to tools/Nant/doc/help/elements/NAnt.Core.Types.Argument.html

  • Committer: Manuel de la Pena
  • Date: 2010-07-08 13:22:59 UTC
  • Revision ID: mandel@themacaque.com-20100708132259-y1jgyuyqfe9stt8u
Updated build script to run tests and added all the required tools so far.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tools/Nant/doc/help/elements/NAnt.Core.Types.Argument.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
  <!-- Documenting T:NAnt.Core.Types.Argument-->
 
4
  <head>
 
5
    <meta http-equiv="Content-Language" content="en-ca" />
 
6
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
7
    <link rel="stylesheet" type="text/css" href="../style.css" />
 
8
    <title>&lt;arg&gt; Element</title>
 
9
  </head>
 
10
  <body>
 
11
    <table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
 
12
      <tr>
 
13
        <td class="NavBar-Cell">
 
14
          <a href="http://nant.sourceforge.net">
 
15
            <b>NAnt</b>
 
16
          </a>
 
17
          <img alt="-&gt;" src="../images/arrow.gif" />
 
18
          <a href="../index.html">Help</a>
 
19
          <img alt="-&gt;" src="../images/arrow.gif" />
 
20
          <span>Element Reference</span>
 
21
          <img alt="-&gt;" src="../images/arrow.gif" /> &lt;arg&gt;</td>
 
22
        <td class="NavBar-Cell" align="right">
 
23
                        v0.90</td>
 
24
      </tr>
 
25
    </table>
 
26
    <h1>&lt;arg&gt;</h1>
 
27
    <p> Represents a command-line argument. </p>
 
28
    <p> When passed to an external application, the argument will be quoted when appropriate. This does not apply to the <code>line</code> parameter, which is always passed as is. </p>
 
29
    <h3>Parameters</h3>
 
30
    <div class="table">
 
31
      <table>
 
32
        <tr>
 
33
          <th>Attribute</th>
 
34
          <th style="text-align: center;">Type</th>
 
35
          <th>Description</th>
 
36
          <th style="text-align: center;">Required</th>
 
37
        </tr>
 
38
        <tr>
 
39
          <td valign="top">dir</td>
 
40
          <td style="text-align: center;">directory</td>
 
41
          <td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td>
 
42
          <td style="text-align: center;">False</td>
 
43
        </tr>
 
44
        <tr>
 
45
          <td valign="top">file</td>
 
46
          <td style="text-align: center;">file</td>
 
47
          <td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td>
 
48
          <td style="text-align: center;">False</td>
 
49
        </tr>
 
50
        <tr>
 
51
          <td valign="top">if</td>
 
52
          <td style="text-align: center;">bool</td>
 
53
          <td> Indicates if the argument should be passed to the external program. If <b>true</b> then the argument will be passed; otherwise, skipped. The default is <b>true</b>. </td>
 
54
          <td style="text-align: center;">False</td>
 
55
        </tr>
 
56
        <tr>
 
57
          <td valign="top">line</td>
 
58
          <td style="text-align: center;">string</td>
 
59
          <td> List of command-line arguments; will be passed to the executable as is. </td>
 
60
          <td style="text-align: center;">False</td>
 
61
        </tr>
 
62
        <tr>
 
63
          <td valign="top">path</td>
 
64
          <td style="text-align: center;">&lt;path&gt;</td>
 
65
          <td> The value for a PATH-like command-line argument; you can use <code>:</code> or <code>;</code> as path separators and NAnt will convert it to the platform's local conventions, while resolving references to environment variables. </td>
 
66
          <td style="text-align: center;">False</td>
 
67
        </tr>
 
68
        <tr>
 
69
          <td valign="top">unless</td>
 
70
          <td style="text-align: center;">bool</td>
 
71
          <td> Indicates if the argument should not be passed to the external program. If <b>false</b> then the argument will be passed; otherwise, skipped. The default is <b>false</b>. </td>
 
72
          <td style="text-align: center;">False</td>
 
73
        </tr>
 
74
        <tr>
 
75
          <td valign="top">value</td>
 
76
          <td style="text-align: center;">string</td>
 
77
          <td> A single command-line argument; can contain space characters. </td>
 
78
          <td style="text-align: center;">False</td>
 
79
        </tr>
 
80
      </table>
 
81
    </div>
 
82
    <h3>Nested Elements:</h3>
 
83
    <!--Element-->
 
84
    <h4>
 
85
      <a id="path">
 
86
      </a>
 
87
                    &lt;<a href="../types/path.html">path</a>&gt;
 
88
                </h4>
 
89
    <div class="nested-element"> Sets a single command-line argument and treats it like a PATH - ensures the right separator for the local platform is used. <p /></div>
 
90
    <h4>
 
91
      <a id="path">
 
92
      </a>
 
93
                    &lt;/<a href="../types/path.html">path</a>&gt;
 
94
                </h4>
 
95
    <h3>Examples</h3>
 
96
    <ul class="examples">
 
97
      <li>
 
98
        <p> A single command-line argument containing a space character. </p>
 
99
        <pre class="code">
 
100
&lt;arg value="-l -a" /&gt;
 
101
    </pre>
 
102
      </li>
 
103
      <li>
 
104
        <p> Two separate command-line arguments. </p>
 
105
        <pre class="code">
 
106
&lt;arg line="-l -a" /&gt;
 
107
    </pre>
 
108
      </li>
 
109
      <li>
 
110
        <p> A single command-line argument with the value <code>\dir;\dir2;\dir3</code> on DOS-based systems and <code>/dir:/dir2:/dir3</code> on Unix-like systems. </p>
 
111
        <pre class="code">
 
112
&lt;arg path="/dir;/dir2:\dir3" /&gt;
 
113
    </pre>
 
114
      </li>
 
115
    </ul>
 
116
    <h3>Requirements</h3>
 
117
    <div style="margin-left: 20px;">
 
118
      <b>Assembly:</b> NAnt.Core (0.90.3780.0)
 
119
            </div>
 
120
  </body>
 
121
</html>
 
 
b'\\ No newline at end of file'