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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<!-- Documenting T:NAnt.Core.Tasks.SysInfoTask-->
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title><sysinfo> Task</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a href="http://nant.sourceforge.net">
<b>NAnt</b>
</a>
<img alt="->" src="../images/arrow.gif" />
<a href="../index.html">Help</a>
<img alt="->" src="../images/arrow.gif" />
<a href="../tasks/index.html">Task Reference</a>
<img alt="->" src="../images/arrow.gif" /> <sysinfo></td>
<td class="NavBar-Cell" align="right">
v0.85</td>
</tr>
</table>
<h1><sysinfo></h1>
<p> Sets properties with system information. </p>
<p>Sets a number of properties with information about the system environment. The intent of this task is for nightly build logs to have a record of system information so that the build was performed on.</p>
<div class="table">
<table>
<tr>
<th>Property</th>
<th>Value</th>
</tr>
<tr>
<td><<code>prefix</code>>.clr.version</td>
<td>Common Language Runtime version number.</td>
</tr>
<tr>
<td><<code>prefix</code>>.env.*</td>
<td>Environment variables (e.g., <<code>prefix</code>>.env.PATH).</td>
</tr>
<tr>
<td><<code>prefix</code>>.os.platform</td>
<td>Operating system platform ID.</td>
</tr>
<tr>
<td><<code>prefix</code>>.os.version</td>
<td>Operating system version.</td>
</tr>
<tr>
<td><<code>prefix</code>>.os</td>
<td>Operating system version string.</td>
</tr>
<tr>
<td><<code>prefix</code>>.os.folder.applicationdata</td>
<td>The directory that serves as a common repository for application-specific data for the current roaming user.</td>
</tr>
<tr>
<td><<code>prefix</code>>.os.folder.commonapplicationdata</td>
<td>The directory that serves as a common repository for application-specific data that is used by all users.</td>
</tr>
<tr>
<td><<code>prefix</code>>.os.folder.commonprogramfiles</td>
<td>The directory for components that are shared across applications.</td>
</tr>
<tr>
<td><<code>prefix</code>>.os.folder.desktopdirectory</td>
<td>The directory used to physically store file objects on the desktop. Do not confuse this directory with the desktop folder itself, which is a virtual folder.</td>
</tr>
<tr>
<td><<code>prefix</code>>.os.folder.programfiles</td>
<td>The Program Files directory.</td>
</tr>
<tr>
<td><<code>prefix</code>>.os.folder.system</td>
<td>The System directory.</td>
</tr>
<tr>
<td><<code>prefix</code>>.os.folder.temp</td>
<td>The temporary directory.</td>
</tr>
</table>
</div>
<p> When the name of an environment variable is not a valid property name, the task will fail. In that case, set <code>failonerror</code> to <b>true</b> to allow that environment variable to be skipped. </p>
<p class="i2">
<b>Note:</b> we advise you to use the following functions instead: </p>
<div class="table">
<table>
<tr>
<th>Function</th>
<th>Description</th>
</tr>
<tr>
<td>
<a href="../functions/environment.get-operating-system.html">environment::get-operating-system()</a>
</td>
<td>Gets a <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemOperatingSystemClassTopic.asp">OperatingSystem</a> object that identifies this operating system.</td>
</tr>
<tr>
<td>
<a href="../functions/environment.get-folder-path.html">environment::get-folder-path()</a>
</td>
<td>Gets the path to a system special folder.</td>
</tr>
<tr>
<td>
<a href="../functions/environment.get-variable.html">environment::get-variable()</a>
</td>
<td>Returns the value of a environment variable.</td>
</tr>
<tr>
<td>
<a href="../functions/path.get-temp-path.html">path::get-temp-path()</a>
</td>
<td>Gets the path to the temporary directory.</td>
</tr>
<tr>
<td>
<a href="../functions/environment.get-version.html">environment::get-version()</a>
</td>
<td>Gets the Common Language Runtime version.</td>
</tr>
</table>
</div>
<h3>Parameters</h3>
<div class="table">
<table>
<tr>
<th>Attribute</th>
<th style="text-align: center;">Type</th>
<th>Description</th>
<th style="text-align: center;">Required</th>
</tr>
<tr>
<td valign="top">prefix</td>
<td style="text-align: center;">string</td>
<td> The string to prefix the property names with. The default is "sys.". </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">failonerror</td>
<td style="text-align: center;">bool</td>
<td> Determines if task failure stops the build, or is just reported. The default is <b>true</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">if</td>
<td style="text-align: center;">bool</td>
<td> If <b>true</b> then the task will be executed; otherwise, skipped. The default is <b>true</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">unless</td>
<td style="text-align: center;">bool</td>
<td> Opposite of <code>if</code>. If <b>false</b> then the task will be executed; otherwise, skipped. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">verbose</td>
<td style="text-align: center;">bool</td>
<td> Determines whether the task should report detailed build log messages. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
</table>
</div>
<h3>Examples</h3>
<ul class="examples">
<li>
<p>Register the properties with the default property prefix.</p>
<pre class="code">
<sysinfo />
</pre>
</li>
<li>
<p>Register the properties without a prefix.</p>
<pre class="code">
<sysinfo prefix="" />
</pre>
</li>
<li>
<p>Register properties and display a summary.</p>
<pre class="code">
<sysinfo verbose="true" />
</pre>
</li>
</ul>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
</div>
</body>
</html>
|
