This commit is contained in:
sbohlen
2010-09-20 20:03:52 +00:00
parent 07d0fd08b3
commit cb6e0a3654
252 changed files with 30891 additions and 25973 deletions

View File

@@ -1,340 +1,340 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.

View File

@@ -1,144 +1,158 @@
NAnt
What is it?
-----------
NAnt is a .NET based build tool. In theory it is kind of like make without
make's wrinkles. In practice it's a lot like Ant.
If you are not familiar with Jakarta Ant you can get more information at the
Ant project web site (http://ant.apache.org/).
Why NAnt?
---------
Because Ant was too Java specific.
Because Ant needed the Java runtime. NAnt only needs the .NET
or Mono runtime.
The Latest Version
------------------
Details of the latest version can be found on the NAnt project web site
http://nant.sourceforge.net/
Compilation and Installation
-------------------------------
a. Build Requirements
--------------------
To build NAnt, you will need the following components:
on Windows
* A version of the Microsoft .NET Framework
Available from http://msdn.microsoft.com/netframework/
you will need the .NET Framework SDK as well as the runtime components
if you intend to compile programs.
note that NAnt currently supports versions 1.0, 1.1 and 2.0 (Beta 1)
of the Microsoft .NET Framework.
or
* Mono for Windows (version 1.0 or higher)
Available from http://www.mono-project.com/downloads/
Linux/Unix
* GNU toolchain - including GNU make
* pkg-config
Available from: http://www.freedesktop.org/Software/pkgconfig
* A working Mono installation and development libraries (version 1.0 or higher)
Available from: http://www.mono-project.com/downloads/
b. Building the Software
------------------------
Build NAnt using Microsoft .NET
GNU Make
--------
make install MONO= MCS=csc prefix=<installation path>
eg. make install MONO= MCS=csc prefix="c:\Program Files"
NMake
-----
nmake -f Makefile.nmake install prefix=<installation path>
eg. nmake -f Makefile.nmake install prefix="c:\Program Files"
Building NAnt using Mono
GNU Make
--------
make install prefix=<installation path>
eg. make install prefix="c:\Program Files"
NMake
-----
nmake -f Makefile.nmake install MONO=mono CSC=mcs prefix=<installation path>
eg. nmake -f Makefile.nmake install MONO=mono CSC=mcs prefix=/usr/local/
Note:
These instructions only apply to the source distribution of NAntContrib, as the binary distribution
contains pre-built assemblies.
Documentation
-------------
Documentation is available in HTML format, in the doc/ directory.
License
-------
Copyright (C) 2001-2005 Gerry Shaw
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
As a special exception, the copyright holders of this software give you
permission to link the assemblies with independent modules to produce new
assemblies, regardless of the license terms of these independent modules,
and to copy and distribute the resulting assemblies under terms of your
choice, provided that you also meet, for each linked independent module,
the terms and conditions of the license of that module. An independent
module is a module which is not derived from or based on these assemblies.
If you modify this software, you may extend this exception to your version
of the software, but you are not obligated to do so. If you do not wish to
do so, delete this exception statement from your version.
A copy of the GNU General Public License is available in the COPYING.txt file
included with all NAnt distributions.
For more licensing information refer to the GNU General Public License on the
GNU Project web site.
http://www.gnu.org/copyleft/gpl.html
NAnt
What is it?
-----------
NAnt is a .NET based build tool. In theory it is kind of like make without
make's wrinkles. In practice it's a lot like Ant.
If you are not familiar with Jakarta Ant you can get more information at the
Ant project web site (http://ant.apache.org/).
Why NAnt?
---------
Because Ant was too Java specific.
Because Ant needed the Java runtime. NAnt only needs the .NET
or Mono runtime.
The Latest Version
------------------
Details of the latest version can be found on the NAnt project web site
http://nant.sourceforge.net/
Files
-----
README.txt - This file.
Makefile - Makefile for compilation with GNU Make.
Makefile.nmake - Makefile for compilation with Microsoft NMake.
Compilation and Installation
----------------------------
a. Overview
-----------
The compilation process uses NAnt to build NAnt.
The approach is to first compile a copy of NAnt (using make/nmake) for
bootstrapping purpose. Next, the bootstrapped version of NAnt is used in
conjunction with NAnt build file (NAnt.build) to build the full version.
b. Prerequisites
----------------
To build NAnt, you will need the following components:
Windows
-------
* A version of the Microsoft .NET Framework
Available from http://msdn.microsoft.com/netframework/
You will need the .NET Framework SDK as well as the runtime
components if you intend to compile programs.
Note: NAnt currently supports versions 1.0, 1.1 and 2.0
of the Microsoft .NET Framework.
or
* Mono for Windows (version 1.0 or higher)
Available from http://www.mono-project.com/downloads/
Linux/Unix
----------
* GNU toolchain - including GNU make
* pkg-config
Available from: http://www.freedesktop.org/Software/pkgconfig
* A working Mono installation and development libraries (version 1.0 or higher)
Available from: http://www.mono-project.com/downloads/
b. Building the Software
------------------------
Build NAnt using Microsoft .NET:
GNU Make
--------
make install MONO= MCS=csc prefix=<installation path> [DESTDIR=<staging path>]
eg. make install MONO= MCS=csc prefix="c:\Program Files"
NMake
-----
nmake -f Makefile.nmake install prefix=<installation path> [DESTDIR=<staging path>]
eg. nmake -f Makefile.nmake install prefix="c:\Program Files"
Building NAnt using Mono:
GNU Make
--------
make install prefix=<installation path> [DESTDIR=<staging path>]
eg. make install prefix="c:\Program Files"
NMake
-----
nmake -f Makefile.nmake install MONO=mono CSC=mcs prefix=<installation path> [DESTDIR=<staging path>]
eg. nmake -f Makefile.nmake install MONO=mono CSC=mcs prefix=/usr/local/
Note:
These instructions only apply to the source distribution of NAnt, as the binary distribution
contains pre-built assemblies.
Documentation
-------------
Documentation is available in HTML format, in the doc/ directory.
License
-------
Copyright (C) 2001-2008 Gerry Shaw
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
As a special exception, the copyright holders of this software give you
permission to link the assemblies with independent modules to produce new
assemblies, regardless of the license terms of these independent modules,
and to copy and distribute the resulting assemblies under terms of your
choice, provided that you also meet, for each linked independent module,
the terms and conditions of the license of that module. An independent
module is a module which is not derived from or based on these assemblies.
If you modify this software, you may extend this exception to your version
of the software, but you are not obligated to do so. If you do not wish to
do so, delete this exception statement from your version.
A copy of the GNU General Public License is available in the COPYING.txt file
included with all NAnt distributions.
For more licensing information refer to the GNU General Public License on the
GNU Project web site.
http://www.gnu.org/copyleft/gpl.html

View File

@@ -4,132 +4,17 @@
<name>NAnt.CompressionTasks</name>
</assembly>
<members>
<member name="T:NAnt.Compression.Tasks.GUnzip">
<summary>
Expands a file packed using GZip compression.
</summary>
<example>
<para>Expands &quot;test.tar.gz&quot; to &quot;test2.tar&quot;.</para>
<code>
<![CDATA[
<gunzip src="test.tar.gz" dest="test.tar" />
]]>
</code>
</example>
<member name="T:NAnt.Compression.Tasks.ExpandBaseTask">
<summary>
Summary description for ExpandTask.
</summary>
</member>
<member name="M:NAnt.Compression.Tasks.GUnzip.ExecuteTask">
<summary>
Extracts the file from the gzip archive.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.GUnzip.SrcFile">
<summary>
The file to expand.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.GUnzip.DestFile">
<summary>
The destination file.
</summary>
</member>
<member name="T:NAnt.Compression.Tasks.TarTask">
<summary>
Creates a tar file from the specified filesets.
</summary>
<remarks>
<para>Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see> (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#.</para>
</remarks>
<example>
<para>
Tar all files in <c>${build.dir}</c> and <c>${doc.dir}</c> into a file
called &quot;backup.tar.gz&quot;, and apply gzip compression to it.
</para>
<code>
<![CDATA[
<tar destfile="backup.tar.gz" compression="GZip">
<fileset basedir="${bin.dir}" prefix="bin">
<include name="**/*" />
</fileset>
<fileset basedir="${doc.dir}" prefix="doc">
<include name="**/*" />
</fileset>
</tar>
]]>
</code>
</example>
</member>
<member name="M:NAnt.Compression.Tasks.TarTask.ExecuteTask">
<summary>
Creates the tar file.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.TarTask.DestFile">
<summary>
The tar file to create.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.TarTask.IncludeEmptyDirs">
<summary>
Include empty directories in the generated tar file. The default is
<see langword="false" />.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.TarTask.TarFileSets">
<summary>
The set of files to be included in the archive.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.TarTask.CompressionMethod">
<summary>
The compression method. The default is <see cref="F:NAnt.Compression.Tasks.TarCompressionMethod.None"/>.
</summary>
</member>
<member name="T:NAnt.Compression.Tasks.TarCompressionMethod">
<summary>
Specifies the compression methods supported by <see cref="T:NAnt.Compression.Tasks.TarTask"/>.
</summary>
</member>
<member name="F:NAnt.Compression.Tasks.TarCompressionMethod.None">
<summary>
No compression.
</summary>
</member>
<member name="F:NAnt.Compression.Tasks.TarCompressionMethod.GZip">
<summary>
GZIP compression.
</summary>
</member>
<member name="F:NAnt.Compression.Tasks.TarCompressionMethod.BZip2">
<summary>
BZIP2 compression.
</summary>
</member>
<member name="T:NAnt.Compression.Tasks.UnZipTask">
<summary>
Extracts files from a zip file.
</summary>
<remarks>
<para>Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see> (SharpZipLib), an open source Zip/GZip library written entirely in C#.</para>
</remarks>
<example>
<para>Extracts all the file from the zip, preserving the directory structure.</para>
<code>
<![CDATA[
<unzip zipfile="backup.zip"/>
]]>
</code>
</example>
</member>
<member name="M:NAnt.Compression.Tasks.UnZipTask.ExecuteTask">
<summary>
Extracts the files from the zip file.
</summary>
</member>
<member name="M:NAnt.Compression.Tasks.UnZipTask.ExtractFile(System.IO.Stream,System.String,System.DateTime,System.Int64)">
<member name="M:NAnt.Compression.Tasks.ExpandBaseTask.ExtractFile(System.IO.Stream,System.String,System.String,System.DateTime,System.Int64)">
<summary>
Extracts a file entry from the specified stream.
</summary>
<param name="inputStream">The <see cref="T:System.IO.Stream"/> containing the compressed entry.</param>
<param name="destDirectory">The directory where to store the expanded file.</param>
<param name="entryName">The name of the entry including directory information.</param>
<param name="entryDate">The date of the entry.</param>
<param name="entrySize">The uncompressed size of the entry.</param>
@@ -144,102 +29,250 @@
directory if it doesn't yet exist.
</remarks>
</member>
<member name="M:NAnt.Compression.Tasks.UnZipTask.ExtractDirectory(System.IO.Stream,System.String,System.DateTime)">
<member name="M:NAnt.Compression.Tasks.ExpandBaseTask.ExtractDirectory(System.IO.Stream,System.String,System.String,System.DateTime)">
<summary>
Extracts a directory entry from the specified stream.
</summary>
<param name="inputStream">The <see cref="T:System.IO.Stream"/> containing the directory entry.</param>
<param name="destDirectory">The directory where to create the subdirectory.</param>
<param name="entryName">The name of the directory entry.</param>
<param name="entryDate">The date of the entry.</param>
<exception cref="T:NAnt.Core.BuildException">
<para>The destination directory for the entry could not be created.</para>
</exception>
</member>
<member name="P:NAnt.Compression.Tasks.UnZipTask.ZipFile">
<member name="P:NAnt.Compression.Tasks.ExpandBaseTask.Overwrite">
<summary>
Overwrite files, even if they are newer than the corresponding
entries in the archive. The default is <see langword="true" />.
</summary>
</member>
<member name="T:NAnt.Compression.Tasks.GUnzip">
<summary>
Expands a file packed using GZip compression.
</summary>
<example>
<para>Expands &quot;test.tar.gz&quot; to &quot;test2.tar&quot;.</para>
<code>
<![CDATA[
<gunzip src="test.tar.gz" dest="test.tar" />
]]>
</code>
</example>
</member>
<member name="M:NAnt.Compression.Tasks.GUnzip.ExecuteTask">
<summary>
Extracts the file from the gzip archive.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.GUnzip.SrcFile">
<summary>
The file to expand.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.GUnzip.DestFile">
<summary>
The destination file.
</summary>
</member>
<member name="T:NAnt.Compression.Tasks.TarTask">
<summary>
Creates a tar file from the specified filesets.
</summary>
<remarks>
<para>Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see> (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#.</para>
</remarks>
<example>
<para>
Tar all files in <c>${build.dir}</c> and <c>${doc.dir}</c> into a file
called &quot;backup.tar.gz&quot;, and apply gzip compression to it.
</para>
<code>
<![CDATA[
<tar destfile="backup.tar.gz" compression="GZip">
<fileset basedir="${bin.dir}" prefix="bin">
<include name="**/*" />
</fileset>
<fileset basedir="${doc.dir}" prefix="doc">
<include name="**/*" />
</fileset>
</tar>
]]>
</code>
</example>
</member>
<member name="M:NAnt.Compression.Tasks.TarTask.ExecuteTask">
<summary>
Creates the tar file.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.TarTask.DestFile">
<summary>
The tar file to create.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.TarTask.IncludeEmptyDirs">
<summary>
Include empty directories in the generated tar file. The default is
<see langword="false" />.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.TarTask.TarFileSets">
<summary>
The set of files to be included in the archive.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.TarTask.CompressionMethod">
<summary>
The archive file to expand.
The compression method. The default is <see cref="F:NAnt.Compression.Types.TarCompressionMethod.None"/>.
</summary>
</member>
<member name="T:NAnt.Compression.Tasks.UnTarTask">
<summary>
Extracts files from a tar archive.
</summary>
<remarks>
<para>
Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see>
(SharpZipLib), an open source Zip/GZip library written entirely in C#.
</para>
</remarks>
<example>
<para>Extracts all files from a gzipped tar, preserving the directory structure.</para>
<code>
<![CDATA[
<untar src="nant-bin.tar.gz" dest="bin" compression="gzip" />
]]>
</code>
</example>
</member>
<member name="M:NAnt.Compression.Tasks.UnTarTask.ExecuteTask">
<summary>
Extracts the files from the archive.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.UnTarTask.SrcFile">
<summary>
The archive file to expand.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.UnTarTask.DestinationDirectory">
<summary>
The directory where to store the expanded file(s). The default is
the project base directory.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.UnTarTask.CompressionMethod">
<summary>
The compression method. The default is <see cref="F:NAnt.Compression.Types.TarCompressionMethod.None"/>.
</summary>
</member>
<member name="T:NAnt.Compression.Tasks.UnZipTask">
<summary>
Extracts files from a zip archive.
</summary>
<remarks>
<para>
Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see>
(SharpZipLib), an open source Zip/GZip library written entirely in C#.
</para>
</remarks>
<example>
<para>Extracts all the file from the zip, preserving the directory structure.</para>
<code>
<![CDATA[
<unzip zipfile="backup.zip"/>
]]>
</code>
</example>
</member>
<member name="M:NAnt.Compression.Tasks.UnZipTask.ExecuteTask">
<summary>
Extracts the files from the zip file.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.UnZipTask.ZipFile">
<summary>
The archive file to expand.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.UnZipTask.ToDirectory">
<summary>
The directory where the expanded files should be stored. The
default is the project base directory.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.UnZipTask.Overwrite">
<summary>
Overwrite files, even if they are newer than the corresponding
entries in the archive. The default is <see langword="true" />.
</summary>
<summary>
The directory where the expanded files should be stored. The
default is the project base directory.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.UnZipTask.Encoding">
<summary>
The character encoding that has been used for filenames inside the
zip file. The default is the system's OEM code page.
</summary>
<summary>
The character encoding that has been used for filenames inside the
zip file. The default is the system's OEM code page.
</summary>
</member>
<member name="T:NAnt.Compression.Tasks.ZipTask">
<summary>
Creates a zip file from the specified filesets.
</summary>
<remarks>
<para>Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see> (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#.</para>
</remarks>
<example>
<para>
Zip all files in <c>${build.dir}</c> and <c>${doc.dir}</c> into a file
called &quot;backup.zip&quot;.
</para>
<code>
<![CDATA[
<zip zipfile="backup.zip">
<fileset basedir="${bin.dir}" prefix="bin">
<include name="**/*" />
</fileset>
<fileset basedir="${doc.dir}" prefix="doc">
<include name="**/*" />
</fileset>
</zip>
]]>
</code>
</example>
<summary>
Creates a zip file from the specified filesets.
</summary>
<remarks>
<para>
Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see>
(SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#.
</para>
</remarks>
<example>
<para>
Zip all files in <c>${build.dir}</c> and <c>${doc.dir}</c> into a file
called &quot;backup.zip&quot;.
</para>
<code>
<![CDATA[
<zip zipfile="backup.zip">
<fileset basedir="${bin.dir}" prefix="bin">
<include name="**/*" />
</fileset>
<fileset basedir="${doc.dir}" prefix="doc">
<include name="**/*" />
</fileset>
</zip>
]]>
</code>
</example>
</member>
<member name="M:NAnt.Compression.Tasks.ZipTask.ExecuteTask">
<summary>
Creates the zip file.
</summary>
<summary>
Creates the zip file.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.ZipTask.ZipFile">
<summary>
The zip file to create.
</summary>
<summary>
The zip file to create.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.ZipTask.Comment">
<summary>
The comment for the file.
</summary>
<summary>
The comment for the file.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.ZipTask.Stamp">
<summary>
Date/time stamp for the files in the format MM/DD/YYYY HH:MM:SS.
</summary>
<summary>
Date/time stamp for the files in the format MM/DD/YYYY HH:MM:SS.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.ZipTask.ZipLevel">
<summary>
Desired level of compression. Possible values are 0 (STORE only)
to 9 (highest). The default is <c>6</c>.
</summary>
<summary>
Desired level of compression. Possible values are 0 (STORE only)
to 9 (highest). The default is <c>6</c>.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.ZipTask.IncludeEmptyDirs">
<summary>
Include empty directories in the generated zip file. The default is
<see langword="false" />.
</summary>
<summary>
Include empty directories in the generated zip file. The default is
<see langword="false" />.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.ZipTask.ZipFileSets">
<summary>
The set of files to be included in the archive.
</summary>
<summary>
The set of files to be included in the archive.
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.ZipTask.DuplicateHandling">
<summary>
@@ -248,31 +281,100 @@
</summary>
</member>
<member name="P:NAnt.Compression.Tasks.ZipTask.Encoding">
<summary>
The character encoding to use for filenames and comment inside the
zip file. The default is the system's OEM code page.
</summary>
<summary>
The character encoding to use for filenames and comment inside the
zip file. The default is the system's OEM code page.
</summary>
</member>
<member name="T:NAnt.Compression.Types.DuplicateHandling">
<summary>
Specifies how entries with the same name should be processed.
</summary>
<summary>
Specifies how entries with the same name should be processed.
</summary>
</member>
<member name="F:NAnt.Compression.Types.DuplicateHandling.Add">
<summary>
Overwrite existing entry with same name.
</summary>
<summary>
Overwrite existing entry with same name.
</summary>
</member>
<member name="F:NAnt.Compression.Types.DuplicateHandling.Preserve">
<summary>
Preserve existing entry with the same name.
</summary>
<summary>
Preserve existing entry with the same name.
</summary>
</member>
<member name="F:NAnt.Compression.Types.DuplicateHandling.Fail">
<summary>
Report failure when two entries have the same name.
</summary>
</member>
<member name="T:NAnt.Compression.Types.DuplicateHandlingConverter">
<summary>
Report failure when two entries have the same name.
Specialized <see cref="T:System.ComponentModel.EnumConverter"/> for <see cref="T:NAnt.Compression.Types.TarCompressionMethod"/>
that ignores case when converting from string.
</summary>
</member>
<member name="M:NAnt.Compression.Types.DuplicateHandlingConverter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:NAnt.Compression.Types.DuplicateHandlingConverter"/>
class.
</summary>
</member>
<member name="M:NAnt.Compression.Types.DuplicateHandlingConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
<summary>
Converts the given object to the type of this converter, using the
specified context and culture information.
</summary>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
<param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
<param name="value">The <see cref="T:System.Object"/> to convert.</param>
<returns>
An <see cref="T:System.Object"/> that represents the converted value.
</returns>
</member>
<member name="T:NAnt.Compression.Types.TarCompressionMethod">
<summary>
Specifies the compression methods supported by <see cref="T:NAnt.Compression.Tasks.TarTask"/>
and <see cref="T:NAnt.Compression.Tasks.UnTarTask"/>.
</summary>
</member>
<member name="F:NAnt.Compression.Types.TarCompressionMethod.None">
<summary>
No compression.
</summary>
</member>
<member name="F:NAnt.Compression.Types.TarCompressionMethod.GZip">
<summary>
GZIP compression.
</summary>
</member>
<member name="F:NAnt.Compression.Types.TarCompressionMethod.BZip2">
<summary>
BZIP2 compression.
</summary>
</member>
<member name="T:NAnt.Compression.Types.TarCompressionMethodConverter">
<summary>
Specialized <see cref="T:System.ComponentModel.EnumConverter"/> for <see cref="T:NAnt.Compression.Types.TarCompressionMethod"/>
that ignores case when converting from string.
</summary>
</member>
<member name="M:NAnt.Compression.Types.TarCompressionMethodConverter.#ctor">
<summary>
Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarCompressionMethodConverter"/>
class.
</summary>
</member>
<member name="M:NAnt.Compression.Types.TarCompressionMethodConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
<summary>
Converts the given object to the type of this converter, using the
specified context and culture information.
</summary>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
<param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
<param name="value">The <see cref="T:System.Object"/> to convert.</param>
<returns>
An <see cref="T:System.Object"/> that represents the converted value.
</returns>
</member>
<member name="T:NAnt.Compression.Types.TarFileSet">
<summary>
A <see cref="T:NAnt.Compression.Types.TarFileSet"/> is a <see cref="T:NAnt.Core.Types.FileSet"/> with extra
@@ -280,45 +382,45 @@
</summary>
</member>
<member name="P:NAnt.Compression.Types.TarFileSet.FileMode">
<summary>
A 3 digit octal string, specify the user, group and other modes
in the standard Unix fashion. Only applies to plain files. The
default is <c>644</c>.
</summary>
<summary>
A 3 digit octal string, specify the user, group and other modes
in the standard Unix fashion. Only applies to plain files. The
default is <c>644</c>.
</summary>
</member>
<member name="P:NAnt.Compression.Types.TarFileSet.DirMode">
<summary>
A 3 digit octal string, specify the user, group and other modes
in the standard Unix fashion. Only applies to directories. The
default is <c>755</c>.
</summary>
<summary>
A 3 digit octal string, specify the user, group and other modes
in the standard Unix fashion. Only applies to directories. The
default is <c>755</c>.
</summary>
</member>
<member name="P:NAnt.Compression.Types.TarFileSet.UserName">
<summary>
The username for the tar entry.
</summary>
<summary>
The username for the tar entry.
</summary>
</member>
<member name="P:NAnt.Compression.Types.TarFileSet.Uid">
<summary>
The user identifier (UID) for the tar entry.
</summary>
<summary>
The user identifier (UID) for the tar entry.
</summary>
</member>
<member name="P:NAnt.Compression.Types.TarFileSet.GroupName">
<summary>
The groupname for the tar entry.
</summary>
<summary>
The groupname for the tar entry.
</summary>
</member>
<member name="P:NAnt.Compression.Types.TarFileSet.Gid">
<summary>
The group identifier (GID) for the tar entry.
</summary>
<summary>
The group identifier (GID) for the tar entry.
</summary>
</member>
<member name="P:NAnt.Compression.Types.TarFileSet.Prefix">
<summary>
The top level directory prefix. If set, all file and directory paths
in the fileset will have this value prepended. Can either be a single
directory name or a "/" separated path.
</summary>
<summary>
The top level directory prefix. If set, all file and directory paths
in the fileset will have this value prepended. Can either be a single
directory name or a "/" separated path.
</summary>
</member>
<member name="T:NAnt.Compression.Types.TarFileSetCollection">
<summary>
@@ -372,11 +474,11 @@
</returns>
</member>
<member name="M:NAnt.Compression.Types.TarFileSetCollection.CopyTo(NAnt.Compression.Types.TarFileSet[],System.Int32)">
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:NAnt.Compression.Types.TarFileSetCollection.IndexOf(NAnt.Compression.Types.TarFileSet)">
<summary>
@@ -409,16 +511,16 @@
<param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to remove from the collection.</param>
</member>
<member name="P:NAnt.Compression.Types.TarFileSetCollection.Item(System.Int32)">
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
</member>
<member name="P:NAnt.Compression.Types.TarFileSetCollection.FileCount">
<summary>
Get the total number of files that are represented by the
filesets in this collection.
</summary>
<summary>
Get the total number of files that are represented by the
filesets in this collection.
</summary>
</member>
<member name="T:NAnt.Compression.Types.TarFileSetEnumerator">
<summary>
@@ -433,28 +535,28 @@
<param name="TarFileSets">The collection that should be enumerated.</param>
</member>
<member name="M:NAnt.Compression.Types.TarFileSetEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
</member>
<member name="M:NAnt.Compression.Types.TarFileSetEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
</member>
<member name="P:NAnt.Compression.Types.TarFileSetEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
</member>
<member name="T:NAnt.Compression.Types.ZipFileSet">
<summary>
@@ -463,11 +565,11 @@
</summary>
</member>
<member name="P:NAnt.Compression.Types.ZipFileSet.Prefix">
<summary>
The top level directory prefix. If set, all file and directory paths
in the fileset will have this value prepended. Can either be a single
directory name or a "/" separated path.
</summary>
<summary>
The top level directory prefix. If set, all file and directory paths
in the fileset will have this value prepended. Can either be a single
directory name or a "/" separated path.
</summary>
</member>
<member name="T:NAnt.Compression.Types.ZipFileSetCollection">
<summary>
@@ -521,11 +623,11 @@
</returns>
</member>
<member name="M:NAnt.Compression.Types.ZipFileSetCollection.CopyTo(NAnt.Compression.Types.ZipFileSet[],System.Int32)">
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:NAnt.Compression.Types.ZipFileSetCollection.IndexOf(NAnt.Compression.Types.ZipFileSet)">
<summary>
@@ -558,16 +660,16 @@
<param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to remove from the collection.</param>
</member>
<member name="P:NAnt.Compression.Types.ZipFileSetCollection.Item(System.Int32)">
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
</member>
<member name="P:NAnt.Compression.Types.ZipFileSetCollection.FileCount">
<summary>
Get the total number of files that are represented by the
filesets in this collection.
</summary>
<summary>
Get the total number of files that are represented by the
filesets in this collection.
</summary>
</member>
<member name="T:NAnt.Compression.Types.ZipFileSetEnumerator">
<summary>
@@ -582,28 +684,28 @@
<param name="ZipFileSets">The collection that should be enumerated.</param>
</member>
<member name="M:NAnt.Compression.Types.ZipFileSetEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
</member>
<member name="M:NAnt.Compression.Types.ZipFileSetEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
</member>
<member name="P:NAnt.Compression.Types.ZipFileSetEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
</member>
</members>
</doc>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -49,22 +49,21 @@
</code>
</example>
</member>
<member name="M:NAnt.MSNet.Tasks.IldasmTask.InitializeTask(System.Xml.XmlNode)">
<summary>
Checks whether the task is initialized with valid attributes.
</summary>
<param name="taskNode">The <see cref="T:System.Xml.XmlNode"/> used to initialize the task.</param>
<member name="M:NAnt.MSNet.Tasks.IldasmTask.Initialize">
<summary>
Checks whether the task is initialized with valid attributes.
</summary>
</member>
<member name="M:NAnt.MSNet.Tasks.IldasmTask.ExecuteTask">
<summary>
Disassembles the PE file(s).
</summary>
<summary>
Disassembles the PE file(s).
</summary>
</member>
<member name="M:NAnt.MSNet.Tasks.IldasmTask.DisassemblyFile(System.IO.FileInfo)">
<summary>
Disassembles the specified PE file.
</summary>
<param name="inputFile">The PE file to disassemble.</param>
<summary>
Disassembles the specified PE file.
</summary>
<param name="inputFile">The PE file to disassemble.</param>
</member>
<member name="M:NAnt.MSNet.Tasks.IldasmTask.GetOutputFile(System.IO.FileInfo)">
<summary>
@@ -81,9 +80,9 @@
<exception cref="T:NAnt.Core.BuildException">The path of the output file could not be determined.</exception>
</member>
<member name="M:NAnt.MSNet.Tasks.IldasmTask.WriteOptions(System.IO.FileInfo,System.IO.FileInfo)">
<summary>
Writes the disassembler options.
</summary>
<summary>
Writes the disassembler options.
</summary>
</member>
<member name="M:NAnt.MSNet.Tasks.IldasmTask.WriteOption(System.IO.StringWriter,System.String)">
<summary>
@@ -116,76 +115,76 @@
</param>
</member>
<member name="M:NAnt.MSNet.Tasks.IldasmTask.NeedsDisassembling(System.IO.FileInfo,System.IO.FileInfo)">
<summary>
Determines whether or not disassembling is needed.
</summary>
<returns>
<see langword="true" /> if disassembling is needed; otherwise,
<see langword="false" />.
</returns>
<summary>
Determines whether or not disassembling is needed.
</summary>
<returns>
<see langword="true" /> if disassembling is needed; otherwise,
<see langword="false" />.
</returns>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.All">
<summary>
Specifies whether or not the disassembler should combine the
<c>/HEADER</c>, <c>/BYTE</c>, and <c>/TOKENS</c> options. The default
is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if the disassembler should combine the
<c>/HEADER</c>, <c>/BYTE</c>, and <c>/TOKENS</c> options;
otherwise, <see langword="false" />. The default is
<see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/ALL</c> flag.
</para>
</remarks>
<summary>
Specifies whether or not the disassembler should combine the
<c>/HEADER</c>, <c>/BYTE</c>, and <c>/TOKENS</c> options. The default
is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if the disassembler should combine the
<c>/HEADER</c>, <c>/BYTE</c>, and <c>/TOKENS</c> options;
otherwise, <see langword="false" />. The default is
<see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/ALL</c> flag.
</para>
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.Bytes">
<summary>
Specifies whether or not the disassembler should generate the
IL stream bytes (in hexadecimal notation) as instruction comments.
The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if the IL stream bytes should be generated
as instruction comments; otherwise, <see langword="false" />. The
default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/BYTE</c> flag.
</para>
</remarks>
<summary>
Specifies whether or not the disassembler should generate the
IL stream bytes (in hexadecimal notation) as instruction comments.
The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if the IL stream bytes should be generated
as instruction comments; otherwise, <see langword="false" />. The
default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/BYTE</c> flag.
</para>
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.ForceRebuild">
<summary>
Instructs NAnt to rebuild the output file regardless of the file
timestamps. The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if the output file should be rebuilt
regardless of its timestamps; otherwise <see langword="false" />.
The default is <see langword="false" />.
</value>
<summary>
Instructs NAnt to rebuild the output file regardless of the file
timestamps. The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if the output file should be rebuilt
regardless of its timestamps; otherwise <see langword="false" />.
The default is <see langword="false" />.
</value>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.Header">
<summary>
Specifies whether or not the disassembler should include PE header
information and runtime header information in the output. The default
is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if PE header information and runtime header
information should be included in the output; otherwise,
<see langword="false" />. The default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/HEADER</c> flag.
</para>
</remarks>
<summary>
Specifies whether or not the disassembler should include PE header
information and runtime header information in the output. The default
is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if PE header information and runtime header
information should be included in the output; otherwise,
<see langword="false" />. The default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/HEADER</c> flag.
</para>
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.InputFile">
<summary>
@@ -197,36 +196,36 @@
</value>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.LineNumbers">
<summary>
Specifies whether or not the disassembler should include
references to original source lines. The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if references to original source lines
should be included; otherwise, <see langword="false" />. The
default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/LINENUM</c> flag.
</para>
</remarks>
<summary>
Specifies whether or not the disassembler should include
references to original source lines. The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if references to original source lines
should be included; otherwise, <see langword="false" />. The
default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/LINENUM</c> flag.
</para>
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.NoIL">
<summary>
Specifies whether or not the disassembler should suppress ILASM
code output. The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if ILASM code output should be suppresses;
otherwise, <see langword="false" />. The default is
<see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/NOIL</c> flag.
</para>
</remarks>
<summary>
Specifies whether or not the disassembler should suppress ILASM
code output. The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if ILASM code output should be suppresses;
otherwise, <see langword="false" />. The default is
<see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/NOIL</c> flag.
</para>
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.PublicOnly">
<summary>
@@ -246,103 +245,103 @@
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.QuoteAllNames">
<summary>
Specifies whether or not the disassembler should enclose all names
in single quotation marks. By default, only names that don't match
the ILASM definition of a simple name are quoted. The default is
<see langword="false" />.
</summary>
<value>
<see langword="true" /> if all names should be enclosed in single
quotation marks; otherwise, <see langword="false" />. The default
is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/QUOTEALLNAMES</c> flag.
</para>
</remarks>
<summary>
Specifies whether or not the disassembler should enclose all names
in single quotation marks. By default, only names that don't match
the ILASM definition of a simple name are quoted. The default is
<see langword="false" />.
</summary>
<value>
<see langword="true" /> if all names should be enclosed in single
quotation marks; otherwise, <see langword="false" />. The default
is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/QUOTEALLNAMES</c> flag.
</para>
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.RawExceptionHandling">
<summary>
Specifies whether or not the disassembler should generate
structured exception handling clauses in canonical (label) form.
The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if structured exception handling clauses
should be generated in canonical form; otherwise,
<see langword="false" />. The default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/RAWEH</c> flag.
</para>
</remarks>
<summary>
Specifies whether or not the disassembler should generate
structured exception handling clauses in canonical (label) form.
The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if structured exception handling clauses
should be generated in canonical form; otherwise,
<see langword="false" />. The default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/RAWEH</c> flag.
</para>
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.Source">
<summary>
Specifies whether or not the disassembler should generate
original source lines as comments. The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if original source lines should be
generated as comments; otherwise, <see langword="false" />.
The default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/SOURCE</c> flag.
</para>
</remarks>
<summary>
Specifies whether or not the disassembler should generate
original source lines as comments. The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if original source lines should be
generated as comments; otherwise, <see langword="false" />.
The default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/SOURCE</c> flag.
</para>
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.Tokens">
<summary>
Specifies whether or not the disassembler should generate metadata
token values as comments. The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if metadata token values should be
generated as comments; otherwise, <see langword="false" />. The
default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/TOKENS</c> flag.
</para>
</remarks>
<summary>
Specifies whether or not the disassembler should generate metadata
token values as comments. The default is <see langword="false" />.
</summary>
<value>
<see langword="true" /> if metadata token values should be
generated as comments; otherwise, <see langword="false" />. The
default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/TOKENS</c> flag.
</para>
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.Unicode">
<summary>
Specifies whether or not the disassembler should use the UNICODE
encoding when generating the output. The default is ANSI.
</summary>
<value>
<see langword="true" /> if the output should be generated using
the UNICODE encoding; otherwise, <see langword="false" />. The
default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/UNICODE</c> flag.
</para>
</remarks>
<summary>
Specifies whether or not the disassembler should use the UNICODE
encoding when generating the output. The default is ANSI.
</summary>
<value>
<see langword="true" /> if the output should be generated using
the UNICODE encoding; otherwise, <see langword="false" />. The
default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/UNICODE</c> flag.
</para>
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.Utf8">
<summary>
Specifies whether or not the disassembler should use the UTF-8
encoding when generating the output. The default is ANSI.
</summary>
<value>
<see langword="true" /> if the output should be generated using
the UTF-8 encoding; otherwise, <see langword="false" />. The
default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/UTF8</c> flag.
</para>
</remarks>
<summary>
Specifies whether or not the disassembler should use the UTF-8
encoding when generating the output. The default is ANSI.
</summary>
<value>
<see langword="true" /> if the output should be generated using
the UTF-8 encoding; otherwise, <see langword="false" />. The
default is <see langword="false" />.
</value>
<remarks>
<para>
Corresponds to the <c>/UTF8</c> flag.
</para>
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.Item">
<summary>
@@ -409,13 +408,13 @@
</value>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.Arguments">
<summary>
The command-line arguments for the external program.
</summary>
<remarks>
Overridden to ensure the &lt;arg&gt; elements would not be exposed
to build authors.
</remarks>
<summary>
The command-line arguments for the external program.
</summary>
<remarks>
Overridden to ensure the &lt;arg&gt; elements would not be exposed
to build authors.
</remarks>
</member>
<member name="P:NAnt.MSNet.Tasks.IldasmTask.ProgramArguments">
<summary>
@@ -427,25 +426,25 @@
</value>
</member>
<member name="T:NAnt.MSNet.Tasks.ServiceControllerTask">
<summary>
Allows a Windows service to be controlled.
</summary>
<example>
<para>Starts the World Wide Web Publishing Service on the local computer.</para>
<code>
<![CDATA[
<servicecontroller action="Start" service="w3svc" />
]]>
</code>
</example>
<example>
<para>Stops the Alerter service on computer 'MOTHER'.</para>
<code>
<![CDATA[
<servicecontroller action="Stop" service="Alerter" machine="MOTHER" />
]]>
</code>
</example>
<summary>
Allows a Windows service to be controlled.
</summary>
<example>
<para>Starts the World Wide Web Publishing Service on the local computer.</para>
<code>
<![CDATA[
<servicecontroller action="Start" service="w3svc" />
]]>
</code>
</example>
<example>
<para>Stops the Alerter service on computer 'MOTHER'.</para>
<code>
<![CDATA[
<servicecontroller action="Stop" service="Alerter" machine="MOTHER" />
]]>
</code>
</example>
</member>
<member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.#ctor">
<summary>
@@ -454,9 +453,9 @@
</summary>
</member>
<member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.ExecuteTask">
<summary>
Peforms actions on the service in order to reach the desired status.
</summary>
<summary>
Peforms actions on the service in order to reach the desired status.
</summary>
</member>
<member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.DetermineDesiredStatus">
<summary>
@@ -504,77 +503,77 @@
<param name="serviceController"><see cref="T:System.ServiceProcess.ServiceController"/> instance for controlling the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.</param>
</member>
<member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._serviceName">
<summary>
Holds the name of the service that should be controlled.
</summary>
<summary>
Holds the name of the service that should be controlled.
</summary>
</member>
<member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._machineName">
<summary>
Holds the name of the computer on which the service resides.
</summary>
<summary>
Holds the name of the computer on which the service resides.
</summary>
</member>
<member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._action">
<summary>
Holds the action that should be performed on the service.
</summary>
<summary>
Holds the action that should be performed on the service.
</summary>
</member>
<member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._timeout">
<summary>
Holds the time, in milliseconds, the task will wait for a service
to reach the desired status.
</summary>
<summary>
Holds the time, in milliseconds, the task will wait for a service
to reach the desired status.
</summary>
</member>
<member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName">
<summary>
The name of the service that should be controlled.
</summary>
<summary>
The name of the service that should be controlled.
</summary>
</member>
<member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName">
<summary>
The name of the computer on which the service resides. The default
is the local computer.
</summary>
<summary>
The name of the computer on which the service resides. The default
is the local computer.
</summary>
</member>
<member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.Action">
<summary>
The action that should be performed on the service.
</summary>
<summary>
The action that should be performed on the service.
</summary>
</member>
<member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.Timeout">
<summary>
The time, in milliseconds, the task will wait for the service to
reach the desired status. The default is 5000 milliseconds.
</summary>
<summary>
The time, in milliseconds, the task will wait for the service to
reach the desired status. The default is 5000 milliseconds.
</summary>
</member>
<member name="T:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType">
<summary>
Defines the actions that can be performed on a service.
</summary>
<summary>
Defines the actions that can be performed on a service.
</summary>
</member>
<member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Start">
<summary>
Starts a service.
</summary>
<summary>
Starts a service.
</summary>
</member>
<member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Stop">
<summary>
Stops a service.
</summary>
<summary>
Stops a service.
</summary>
</member>
<member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Restart">
<summary>
Restarts a service.
</summary>
<summary>
Restarts a service.
</summary>
</member>
<member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Pause">
<summary>
Pauses a running service.
</summary>
<summary>
Pauses a running service.
</summary>
</member>
<member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Continue">
<summary>
Continues a paused service.
</summary>
<summary>
Continues a paused service.
</summary>
</member>
</members>
</doc>

View File

@@ -5,31 +5,31 @@
</assembly>
<members>
<member name="T:NAnt.NUnit.Types.FormatterData">
<summary>
Carries data specified through the formatter element.
</summary>
<summary>
Carries data specified through the formatter element.
</summary>
</member>
<member name="P:NAnt.NUnit.Types.FormatterData.Type">
<summary>
Gets or sets the type of the formatter.
</summary>
<value>The type of the formatter.</value>
<summary>
Gets or sets the type of the formatter.
</summary>
<value>The type of the formatter.</value>
</member>
<member name="P:NAnt.NUnit.Types.FormatterData.UseFile">
<summary>
Gets or sets a value indicating whether output should be persisted
to a file.
</summary>
<value>
<see langword="true" /> if output should be written to a file; otherwise,
<see langword="false" />. The default is <see langword="false" />.
</value>
<summary>
Gets or sets a value indicating whether output should be persisted
to a file.
</summary>
<value>
<see langword="true" /> if output should be written to a file; otherwise,
<see langword="false" />. The default is <see langword="false" />.
</value>
</member>
<member name="P:NAnt.NUnit.Types.FormatterData.Extension">
<summary>
Gets or sets the extension to append to the output filename.
</summary>
<value>The extension to append to the output filename.</value>
<summary>
Gets or sets the extension to append to the output filename.
</summary>
<value>The extension to append to the output filename.</value>
</member>
<member name="P:NAnt.NUnit.Types.FormatterData.OutputDirectory">
<summary>
@@ -92,11 +92,11 @@
</returns>
</member>
<member name="M:NAnt.NUnit.Types.FormatterDataCollection.CopyTo(NAnt.NUnit.Types.FormatterData[],System.Int32)">
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:NAnt.NUnit.Types.FormatterDataCollection.IndexOf(NAnt.NUnit.Types.FormatterData)">
<summary>
@@ -129,10 +129,10 @@
<param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterData"/> to remove from the collection.</param>
</member>
<member name="P:NAnt.NUnit.Types.FormatterDataCollection.Item(System.Int32)">
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
</member>
<member name="T:NAnt.NUnit.Types.FormatterDataEnumerator">
<summary>
@@ -147,64 +147,64 @@
<param name="arguments">The collection that should be enumerated.</param>
</member>
<member name="M:NAnt.NUnit.Types.FormatterDataEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
</member>
<member name="M:NAnt.NUnit.Types.FormatterDataEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
</member>
<member name="P:NAnt.NUnit.Types.FormatterDataEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
</member>
<member name="T:NAnt.NUnit.Types.FormatterType">
<summary>
The built-in formatter types.
</summary>
<summary>
The built-in formatter types.
</summary>
</member>
<member name="F:NAnt.NUnit.Types.FormatterType.Plain">
<summary>
A plaintext formatter.
</summary>
<summary>
A plaintext formatter.
</summary>
</member>
<member name="F:NAnt.NUnit.Types.FormatterType.Xml">
<summary>
An XML formatter.
</summary>
<summary>
An XML formatter.
</summary>
</member>
<member name="T:NAnt.NUnit.Types.FormatterElement">
<summary>
Represents the FormatterElement of the NUnit task.
</summary>
<summary>
Represents the FormatterElement of the NUnit task.
</summary>
</member>
<member name="P:NAnt.NUnit.Types.FormatterElement.Type">
<summary>
Type of formatter.
</summary>
<summary>
Type of formatter.
</summary>
</member>
<member name="P:NAnt.NUnit.Types.FormatterElement.Extension">
<summary>
Extension to append to the output filename.
</summary>
<summary>
Extension to append to the output filename.
</summary>
</member>
<member name="P:NAnt.NUnit.Types.FormatterElement.UseFile">
<summary>
Determines whether output should be persisted to a file. The default
is <see langword="false" />.
</summary>
<summary>
Determines whether output should be persisted to a file. The default
is <see langword="false" />.
</summary>
</member>
<member name="P:NAnt.NUnit.Types.FormatterElement.OutputDirectory">
<summary>
@@ -271,11 +271,11 @@
</returns>
</member>
<member name="M:NAnt.NUnit.Types.FormatterElementCollection.CopyTo(NAnt.NUnit.Types.FormatterElement[],System.Int32)">
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:NAnt.NUnit.Types.FormatterElementCollection.IndexOf(NAnt.NUnit.Types.FormatterElement)">
<summary>
@@ -308,10 +308,10 @@
<param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterElement"/> to remove from the collection.</param>
</member>
<member name="P:NAnt.NUnit.Types.FormatterElementCollection.Item(System.Int32)">
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
</member>
<member name="T:NAnt.NUnit.Types.FormatterElementEnumerator">
<summary>
@@ -326,28 +326,28 @@
<param name="arguments">The collection that should be enumerated.</param>
</member>
<member name="M:NAnt.NUnit.Types.FormatterElementEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
</member>
<member name="M:NAnt.NUnit.Types.FormatterElementEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
</member>
<member name="P:NAnt.NUnit.Types.FormatterElementEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
</member>
</members>
</doc>

View File

@@ -5,14 +5,14 @@
</assembly>
<members>
<member name="M:NAnt.NUnit1.Types.IResultFormatter.StartTestSuite(NAnt.NUnit1.Types.NUnitTestData)">
<summary>
The whole test suite started.
</summary>
<summary>
The whole test suite started.
</summary>
</member>
<member name="M:NAnt.NUnit1.Types.IResultFormatter.EndTestSuite(NAnt.NUnit1.Types.TestResultExtra)">
<summary>
The whole test suite ended.
</summary>
<summary>
The whole test suite ended.
</summary>
</member>
<member name="M:NAnt.NUnit1.Types.IResultFormatter.SetOutput(System.IO.TextWriter)">
<summary>
@@ -72,11 +72,11 @@
</returns>
</member>
<member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.CopyTo(NAnt.NUnit1.Types.IResultFormatter[],System.Int32)">
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.IndexOf(NAnt.NUnit1.Types.IResultFormatter)">
<summary>
@@ -109,10 +109,10 @@
<param name="item">The <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> to remove from the collection.</param>
</member>
<member name="P:NAnt.NUnit1.Types.IResultFormatterCollection.Item(System.Int32)">
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
</member>
<member name="T:NAnt.NUnit1.Types.IResultFormatterEnumerator">
<summary>
@@ -127,42 +127,42 @@
<param name="arguments">The collection that should be enumerated.</param>
</member>
<member name="M:NAnt.NUnit1.Types.IResultFormatterEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
</member>
<member name="M:NAnt.NUnit1.Types.IResultFormatterEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
</member>
<member name="P:NAnt.NUnit1.Types.IResultFormatterEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
</member>
<member name="T:NAnt.NUnit1.Types.LogFormatter">
<summary>
Prints information about running tests directly to the build log.
</summary>
<summary>
Prints information about running tests directly to the build log.
</summary>
</member>
<member name="M:NAnt.NUnit1.Types.LogFormatter.SetOutput(System.IO.TextWriter)">
<summary>Not used, all output goes to Log class.</summary>
<summary>Not used, all output goes to Log class.</summary>
</member>
<member name="M:NAnt.NUnit1.Types.LogFormatter.StartTestSuite(NAnt.NUnit1.Types.NUnitTestData)">
<summary>Called when the whole test suite has started.</summary>
<summary>Called when the whole test suite has started.</summary>
</member>
<member name="M:NAnt.NUnit1.Types.LogFormatter.EndTestSuite(NAnt.NUnit1.Types.TestResultExtra)">
<summary>Called when the whole test suite has ended.</summary>
<summary>Called when the whole test suite has ended.</summary>
</member>
<member name="M:NAnt.NUnit1.Types.LogFormatter.FormatError(System.String,System.String)">
<summary>Convert a stack trace line into something that can be clicked on in an IDE output window.</summary>
@@ -207,35 +207,35 @@
</example>
</member>
<member name="P:NAnt.NUnit1.Tasks.NUnitTask.HaltOnError">
<summary>
Stops running tests when a test causes an error. The default is
<see langword="false" />.
</summary>
<remarks>
Implies haltonfailure.
</remarks>
<summary>
Stops running tests when a test causes an error. The default is
<see langword="false" />.
</summary>
<remarks>
Implies haltonfailure.
</remarks>
</member>
<member name="P:NAnt.NUnit1.Tasks.NUnitTask.HaltOnFailure">
<summary>
Stops running tests if a test fails (errors are considered failures
as well). The default is <see langword="false" />.
</summary>
<summary>
Stops running tests if a test fails (errors are considered failures
as well). The default is <see langword="false" />.
</summary>
</member>
<member name="P:NAnt.NUnit1.Tasks.NUnitTask.Timeout">
<summary>
Cancel the individual tests if they do not finish in the specified
time (measured in milliseconds). Ignored if fork is disabled.
</summary>
<summary>
Cancel the individual tests if they do not finish in the specified
time (measured in milliseconds). Ignored if fork is disabled.
</summary>
</member>
<member name="P:NAnt.NUnit1.Tasks.NUnitTask.Tests">
<summary>
Tests to run.
</summary>
<summary>
Tests to run.
</summary>
</member>
<member name="P:NAnt.NUnit1.Tasks.NUnitTask.FormatterElements">
<summary>
Formatters to output results of unit tests.
</summary>
<summary>
Formatters to output results of unit tests.
</summary>
</member>
<member name="T:NAnt.NUnit1.Types.NUnitTest">
<summary>
@@ -243,25 +243,25 @@
</summary>
</member>
<member name="P:NAnt.NUnit1.Types.NUnitTest.OutFile">
<summary>
Base name of the test result. The full filename is determined by this
attribute and the extension of formatter.
</summary>
<summary>
Base name of the test result. The full filename is determined by this
attribute and the extension of formatter.
</summary>
</member>
<member name="P:NAnt.NUnit1.Types.NUnitTest.ToDir">
<summary>
Directory to write the reports to.
</summary>
<summary>
Directory to write the reports to.
</summary>
</member>
<member name="P:NAnt.NUnit1.Types.NUnitTest.Class">
<summary>
Class name of the test.
</summary>
<summary>
Class name of the test.
</summary>
</member>
<member name="P:NAnt.NUnit1.Types.NUnitTest.Assembly">
<summary>
Assembly to load the test from.
</summary>
<summary>
Assembly to load the test from.
</summary>
</member>
<member name="P:NAnt.NUnit1.Types.NUnitTest.Fork">
<summary>
@@ -269,20 +269,20 @@
</summary>
</member>
<member name="P:NAnt.NUnit1.Types.NUnitTest.HaltOnError">
<summary>
Stop the build process if an error occurs during the test run.
</summary>
<summary>
Stop the build process if an error occurs during the test run.
</summary>
</member>
<member name="P:NAnt.NUnit1.Types.NUnitTest.HaltOnFailure">
<summary>
Stop the build process if a test fails (errors are considered failures
as well).
</summary>
<summary>
Stop the build process if a test fails (errors are considered failures
as well).
</summary>
</member>
<member name="P:NAnt.NUnit1.Types.NUnitTest.AppConfigFile">
<summary>
The application configuration file to use for the NUnit test domain.
</summary>
<summary>
The application configuration file to use for the NUnit test domain.
</summary>
</member>
<member name="T:NAnt.NUnit1.Types.NUnitTestCollection">
<summary>
@@ -336,11 +336,11 @@
</returns>
</member>
<member name="M:NAnt.NUnit1.Types.NUnitTestCollection.CopyTo(NAnt.NUnit1.Types.NUnitTest[],System.Int32)">
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:NAnt.NUnit1.Types.NUnitTestCollection.IndexOf(NAnt.NUnit1.Types.NUnitTest)">
<summary>
@@ -373,10 +373,10 @@
<param name="item">The <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> to remove from the collection.</param>
</member>
<member name="P:NAnt.NUnit1.Types.NUnitTestCollection.Item(System.Int32)">
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
</member>
<member name="T:NAnt.NUnit1.Types.NUnitTestEnumerator">
<summary>
@@ -391,98 +391,98 @@
<param name="arguments">The collection that should be enumerated.</param>
</member>
<member name="M:NAnt.NUnit1.Types.NUnitTestEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
</member>
<member name="M:NAnt.NUnit1.Types.NUnitTestEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
</member>
<member name="P:NAnt.NUnit1.Types.NUnitTestEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
</member>
<member name="T:NAnt.NUnit1.Types.NUnitTestData">
<summary>
Carries data specified through the test element.
</summary>
<summary>
Carries data specified through the test element.
</summary>
</member>
<member name="M:NAnt.NUnit1.Tasks.NUnitTestRunner.NeedsRunning">
<summary>
Determines if the unit test needs running.
</summary>
<returns>
<see langword="true" /> if unit test needs running, otherwise,
<see langword="false" />.
</returns>
<remarks>
<para>
Determines if the test needs running by looking at the date stamp
of the test assembly and the test results log.
</para>
</remarks>
<summary>
Determines if the unit test needs running.
</summary>
<returns>
<see langword="true" /> if unit test needs running, otherwise,
<see langword="false" />.
</returns>
<remarks>
<para>
Determines if the test needs running by looking at the date stamp
of the test assembly and the test results log.
</para>
</remarks>
</member>
<member name="M:NAnt.NUnit1.Tasks.NUnitTestRunner.Run(System.String,System.Boolean)">
<summary>
Runs a Suite extracted from a TestCase subclass.
</summary>
<summary>
Runs a Suite extracted from a TestCase subclass.
</summary>
</member>
<member name="M:NAnt.NUnit1.Tasks.NUnitTestRunner.CreateFormatters(NAnt.NUnit1.Types.NUnitTestData,System.String,System.Boolean)">
<summary>
Creates the formatters to be used when running this test.
</summary>
<summary>
Creates the formatters to be used when running this test.
</summary>
</member>
<member name="M:NAnt.NUnit1.Tasks.NUnitTestRunner.GetOutput(NAnt.NUnit.Types.FormatterData,NAnt.NUnit1.Types.NUnitTestData)">
<summary>
Returns the output file or null if does not use a file.
</summary>
<summary>
Returns the output file or null if does not use a file.
</summary>
</member>
<member name="M:NAnt.NUnit1.Tasks.NUnitTestRunner.GetSuite(System.String)">
<summary>
Returns the test suite from a given class.
</summary>
<remarks>
The assemblyQualifiedName parameter needs to be in form:
"full.qualified.class.name,Assembly"
</remarks>
<summary>
Returns the test suite from a given class.
</summary>
<remarks>
The assemblyQualifiedName parameter needs to be in form:
"full.qualified.class.name,Assembly"
</remarks>
</member>
<member name="P:NAnt.NUnit1.Tasks.NUnitTestRunner.Formatters">
<summary>
Gets the collection of registered formatters.
</summary>
<value>Collection of registered formatters.</value>
<summary>
Gets the collection of registered formatters.
</summary>
<value>Collection of registered formatters.</value>
</member>
<member name="P:NAnt.NUnit1.Tasks.NUnitTestRunner.ResultCode">
<summary>
Gets the result of the test.
</summary>
<value>The result of the test.</value>
<summary>
Gets the result of the test.
</summary>
<value>The result of the test.</value>
</member>
<member name="T:NAnt.NUnit1.Types.PlainTextFormatter">
<summary>
Prints information about running tests in plain text.
</summary>
<summary>
Prints information about running tests in plain text.
</summary>
</member>
<member name="M:NAnt.NUnit1.Types.PlainTextFormatter.SetOutput(System.IO.TextWriter)">
<summary>Sets the Writer the formatter is supposed to write its results to.</summary>
<summary>Sets the Writer the formatter is supposed to write its results to.</summary>
</member>
<member name="M:NAnt.NUnit1.Types.PlainTextFormatter.StartTestSuite(NAnt.NUnit1.Types.NUnitTestData)">
<summary>Called when the whole test suite has started.</summary>
<summary>Called when the whole test suite has started.</summary>
</member>
<member name="M:NAnt.NUnit1.Types.PlainTextFormatter.EndTestSuite(NAnt.NUnit1.Types.TestResultExtra)">
<summary>Called when the whole test suite has ended.</summary>
<summary>Called when the whole test suite has ended.</summary>
</member>
<member name="M:NAnt.NUnit1.Types.PlainTextFormatter.FormatError(System.String,System.String)">
<summary>Convert a stack trace line into something that can be clicked on in an IDE output window.</summary>
@@ -502,15 +502,15 @@
</summary>
</member>
<member name="P:NAnt.NUnit1.Types.TestResultExtra.RunTime">
<summary>
Gets or sets the total run-time of a test.
</summary>
<value>The total run-time of a test.</value>
<summary>
Gets or sets the total run-time of a test.
</summary>
<value>The total run-time of a test.</value>
</member>
<member name="T:NAnt.NUnit1.Types.XmlResultFormatter">
<summary>
Prints detailed information about running tests in XML format.
</summary>
<summary>
Prints detailed information about running tests in XML format.
</summary>
</member>
<member name="M:NAnt.NUnit1.Types.XmlResultFormatter.#ctor">
<summary>
@@ -525,14 +525,14 @@
</summary>
</member>
<member name="M:NAnt.NUnit1.Types.XmlResultFormatter.StartTestSuite(NAnt.NUnit1.Types.NUnitTestData)">
<summary>
Called when the whole test suite has started.
</summary>
<summary>
Called when the whole test suite has started.
</summary>
</member>
<member name="M:NAnt.NUnit1.Types.XmlResultFormatter.EndTestSuite(NAnt.NUnit1.Types.TestResultExtra)">
<summary>
Called when the whole test suite has ended.
</summary>
<summary>
Called when the whole test suite has ended.
</summary>
</member>
</members>
</doc>

View File

@@ -34,36 +34,36 @@
</example>
</member>
<member name="P:NAnt.NUnit2.Types.Categories.Includes">
<summary>
Specifies a list of categories to include.
</summary>
<summary>
Specifies a list of categories to include.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.Categories.Excludes">
<summary>
Specifies a list of categories to exclude.
</summary>
<summary>
Specifies a list of categories to exclude.
</summary>
</member>
<member name="T:NAnt.NUnit2.Types.Category">
<summary>
Represents a certain group of test cases or fixtures.
</summary>
<summary>
Represents a certain group of test cases or fixtures.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.Category.CategoryName">
<summary>
A name of a category, or comma-separated list of names.
</summary>
<summary>
A name of a category, or comma-separated list of names.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.Category.IfDefined">
<summary>
If <see langword="true" /> then the category will be processed;
otherwise, skipped. The default is <see langword="true" />.
</summary>
<summary>
If <see langword="true" /> then the category will be processed;
otherwise, skipped. The default is <see langword="true" />.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.Category.UnlessDefined">
<summary>
If <see langword="true" /> then the category will be skipped;
otherwise, processed. The default is <see langword="false" />.
</summary>
<summary>
If <see langword="true" /> then the category will be skipped;
otherwise, processed. The default is <see langword="false" />.
</summary>
</member>
<member name="T:NAnt.NUnit2.Types.CategoryCollection">
<summary>
@@ -138,11 +138,11 @@
</returns>
</member>
<member name="M:NAnt.NUnit2.Types.CategoryCollection.CopyTo(NAnt.NUnit2.Types.Category[],System.Int32)">
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:NAnt.NUnit2.Types.CategoryCollection.IndexOf(NAnt.NUnit2.Types.Category)">
<summary>
@@ -175,10 +175,10 @@
<param name="item">The <see cref="T:NAnt.NUnit2.Types.Category"/> to remove from the collection.</param>
</member>
<member name="P:NAnt.NUnit2.Types.CategoryCollection.Item(System.Int32)">
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
</member>
<member name="P:NAnt.NUnit2.Types.CategoryCollection.Item(System.String)">
<summary>
@@ -199,158 +199,28 @@
<param name="arguments">The collection that should be enumerated.</param>
</member>
<member name="M:NAnt.NUnit2.Types.CategoryEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
</member>
<member name="M:NAnt.NUnit2.Types.CategoryEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.CategoryEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
</member>
<member name="T:NAnt.NUnit2.Types.NUnit2TestCollection">
<summary>
Contains a strongly typed collection of <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> objects.
</summary>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.#ctor">
<summary>
Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> class.
</summary>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.#ctor(NAnt.NUnit2.Types.NUnit2TestCollection)">
<summary>
Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> class
with the specified <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> instance.
</summary>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.#ctor(NAnt.NUnit2.Types.NUnit2Test[])">
<summary>
Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> class
with the specified array of <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> instances.
</summary>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Add(NAnt.NUnit2.Types.NUnit2Test)">
<summary>
Adds a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to the end of the collection.
</summary>
<param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to be added to the end of the collection.</param>
<returns>The position into which the new element was inserted.</returns>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.AddRange(NAnt.NUnit2.Types.NUnit2Test[])">
<summary>
Adds the elements of a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> array to the end of the collection.
</summary>
<param name="items">The array of <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> elements to be added to the end of the collection.</param>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.AddRange(NAnt.NUnit2.Types.NUnit2TestCollection)">
<summary>
Adds the elements of a <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> to the end of the collection.
</summary>
<param name="items">The <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> to be added to the end of the collection.</param>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Contains(NAnt.NUnit2.Types.NUnit2Test)">
<summary>
Determines whether a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> is in the collection.
</summary>
<param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to locate in the collection.</param>
<returns>
<see langword="true"/> if <paramref name="item"/> is found in the
collection; otherwise, <see langword="false"/>.
</returns>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.CopyTo(NAnt.NUnit2.Types.NUnit2Test[],System.Int32)">
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.IndexOf(NAnt.NUnit2.Types.NUnit2Test)">
<summary>
Retrieves the index of a specified <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> object in the collection.
</summary>
<param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> object for which the index is returned.</param>
<returns>
The index of the specified <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/>. If the <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> is not currently a member of the collection, it returns -1.
</returns>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Insert(System.Int32,NAnt.NUnit2.Types.NUnit2Test)">
<summary>
Inserts a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> into the collection at the specified index.
</summary>
<param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
<param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to insert.</param>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through the collection.
</summary>
<returns>
A <see cref="T:NAnt.NUnit2.Types.NUnit2TestEnumerator"/> for the entire collection.
</returns>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Remove(NAnt.NUnit2.Types.NUnit2Test)">
<summary>
Removes a member from the collection.
</summary>
<param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to remove from the collection.</param>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2TestCollection.Item(System.Int32)">
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
</member>
<member name="T:NAnt.NUnit2.Types.NUnit2TestEnumerator">
<summary>
Enumerates the <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> elements of a <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/>.
</summary>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestEnumerator.#ctor(NAnt.NUnit2.Types.NUnit2TestCollection)">
<summary>
Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestEnumerator"/> class
with the specified <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/>.
</summary>
<param name="arguments">The collection that should be enumerated.</param>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2TestEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
</member>
<member name="T:NAnt.NUnit2.Tasks.NUnit2Task">
<summary>
@@ -422,6 +292,10 @@
<categories>
<exclude name="NotWorking" />
</categories>
<references basedir="build">
<include name="Cegeka.Income.Services.dll" />
<include name="Cegeka.Util.dll" />
</references>
</test>
</nunit2>
]]>
@@ -429,24 +303,24 @@
</example>
</member>
<member name="M:NAnt.NUnit2.Tasks.NUnit2Task.ExecuteTask">
<summary>
Runs the tests and sets up the formatters.
</summary>
<summary>
Runs the tests and sets up the formatters.
</summary>
</member>
<member name="P:NAnt.NUnit2.Tasks.NUnit2Task.HaltOnFailure">
<summary>
Stop the test run if a test fails. The default is <see langword="false" />.
</summary>
<summary>
Stop the test run if a test fails. The default is <see langword="false" />.
</summary>
</member>
<member name="P:NAnt.NUnit2.Tasks.NUnit2Task.Tests">
<summary>
Tests to run.
</summary>
<summary>
Tests to run.
</summary>
</member>
<member name="P:NAnt.NUnit2.Tasks.NUnit2Task.FormatterElements">
<summary>
Formatters to output results of unit tests.
</summary>
<summary>
Formatters to output results of unit tests.
</summary>
</member>
<member name="T:NAnt.NUnit2.Types.NUnit2Test">
<summary>
@@ -454,30 +328,35 @@
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2Test.AssemblyFile">
<summary>
Name of the assembly to search for tests.
</summary>
<summary>
Name of the assembly to search for tests.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2Test.TestName">
<summary>
Name of a specific testfixture to run. If not specified then all
testfixtures are run.
</summary>
<summary>
Name of a specific testfixture to run. If not specified then all
testfixtures are run.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2Test.Assemblies">
<summary>
Assemblies to include in test.
</summary>
<summary>
Assemblies to include in test.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2Test.References">
<summary>
Assemblies to scan for missing assembly references.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2Test.Categories">
<summary>
Categories of test cases to include or exclude.
</summary>
<summary>
Categories of test cases to include or exclude.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2Test.HaltOnFailure">
<summary>
Build fails on failure. The default is <see langword="true" />.
</summary>
<summary>
Build fails on failure. The default is <see langword="true" />.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2Test.XsltFile">
<summary>
@@ -486,25 +365,155 @@
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2Test.AppConfigFile">
<summary>
The application configuration file to use for the NUnit test domain.
If not specified, NAnt will try to use a configuration name matching
the file name of the assembly with extension ".config".
</summary>
<summary>
The application configuration file to use for the NUnit test domain.
If not specified, NAnt will try to use a configuration name matching
the file name of the assembly with extension ".config".
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2Test.TestAssemblies">
<summary>
Gets all assemblies specified for these tests.
</summary>
<returns>
All assemblies specified for these tests.
</returns>
</member>
<member name="T:NAnt.NUnit2.Types.NUnit2TestCollection">
<summary>
Gets all assemblies specified for these tests.
Contains a strongly typed collection of <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> objects.
</summary>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.#ctor">
<summary>
Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> class.
</summary>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.#ctor(NAnt.NUnit2.Types.NUnit2TestCollection)">
<summary>
Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> class
with the specified <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> instance.
</summary>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.#ctor(NAnt.NUnit2.Types.NUnit2Test[])">
<summary>
Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> class
with the specified array of <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> instances.
</summary>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Add(NAnt.NUnit2.Types.NUnit2Test)">
<summary>
Adds a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to the end of the collection.
</summary>
<param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to be added to the end of the collection.</param>
<returns>The position into which the new element was inserted.</returns>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.AddRange(NAnt.NUnit2.Types.NUnit2Test[])">
<summary>
Adds the elements of a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> array to the end of the collection.
</summary>
<param name="items">The array of <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> elements to be added to the end of the collection.</param>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.AddRange(NAnt.NUnit2.Types.NUnit2TestCollection)">
<summary>
Adds the elements of a <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> to the end of the collection.
</summary>
<param name="items">The <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> to be added to the end of the collection.</param>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Contains(NAnt.NUnit2.Types.NUnit2Test)">
<summary>
Determines whether a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> is in the collection.
</summary>
<param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to locate in the collection.</param>
<returns>
All assemblies specified for these tests.
<see langword="true"/> if <paramref name="item"/> is found in the
collection; otherwise, <see langword="false"/>.
</returns>
</member>
<member name="T:NAnt.NUnit2.Tasks.NUnit2TestDomain">
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.CopyTo(NAnt.NUnit2.Types.NUnit2Test[],System.Int32)">
<summary>
Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
</summary>
<param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
<param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.IndexOf(NAnt.NUnit2.Types.NUnit2Test)">
<summary>
Custom TestDomain, similar to the one included with NUnit, in order
to workaround some limitations in it.
Retrieves the index of a specified <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> object in the collection.
</summary>
<param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> object for which the index is returned.</param>
<returns>
The index of the specified <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/>. If the <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> is not currently a member of the collection, it returns -1.
</returns>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Insert(System.Int32,NAnt.NUnit2.Types.NUnit2Test)">
<summary>
Inserts a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> into the collection at the specified index.
</summary>
<param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
<param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to insert.</param>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through the collection.
</summary>
<returns>
A <see cref="T:NAnt.NUnit2.Types.NUnit2TestEnumerator"/> for the entire collection.
</returns>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Remove(NAnt.NUnit2.Types.NUnit2Test)">
<summary>
Removes a member from the collection.
</summary>
<param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to remove from the collection.</param>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2TestCollection.Item(System.Int32)">
<summary>
Gets or sets the element at the specified index.
</summary>
<param name="index">The zero-based index of the element to get or set.</param>
</member>
<member name="T:NAnt.NUnit2.Types.NUnit2TestEnumerator">
<summary>
Enumerates the <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> elements of a <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/>.
</summary>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestEnumerator.#ctor(NAnt.NUnit2.Types.NUnit2TestCollection)">
<summary>
Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestEnumerator"/> class
with the specified <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/>.
</summary>
<param name="arguments">The collection that should be enumerated.</param>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestEnumerator.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see langword="true" /> if the enumerator was successfully advanced
to the next element; <see langword="false" /> if the enumerator has
passed the end of the collection.
</returns>
</member>
<member name="M:NAnt.NUnit2.Types.NUnit2TestEnumerator.Reset">
<summary>
Sets the enumerator to its initial position, which is before the
first element in the collection.
</summary>
</member>
<member name="P:NAnt.NUnit2.Types.NUnit2TestEnumerator.Current">
<summary>
Gets the current element in the collection.
</summary>
<returns>
The current element in the collection.
</returns>
</member>
<member name="T:NAnt.NUnit2.Tasks.NUnit2TestDomain">
<summary>
Custom TestDomain, similar to the one included with NUnit, in order
to workaround some limitations in it.
</summary>
</member>
<member name="M:NAnt.NUnit2.Tasks.NUnit2TestDomain.#ctor">
<summary>
@@ -512,24 +521,25 @@
class.
</summary>
</member>
<member name="M:NAnt.NUnit2.Tasks.NUnit2TestDomain.CreateRunner(System.IO.FileInfo,System.IO.FileInfo)">
<summary>
Runs a single testcase.
</summary>
<param name="assemblyFile">The test assembly.</param>
<param name="configFile">The application configuration file for the test domain.</param>
<returns>
The result of the test.
</returns>
<member name="M:NAnt.NUnit2.Tasks.NUnit2TestDomain.CreateRunner(System.IO.FileInfo,System.IO.FileInfo,System.Collections.Specialized.StringCollection)">
<summary>
Runs a single testcase.
</summary>
<param name="assemblyFile">The test assembly.</param>
<param name="configFile">The application configuration file for the test domain.</param>
<param name="referenceAssemblies">List of files to scan for missing assembly references.</param>
<returns>
The result of the test.
</returns>
</member>
<member name="T:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler">
<summary>
Helper class called when an assembly resolve event is raised.
</summary>
<summary>
Helper class called when an assembly resolve event is raised.
</summary>
</member>
<member name="M:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler.#ctor(System.String[])">
<member name="M:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler.#ctor(System.String[],System.String[])">
<summary>
Initializes an instanse of the <see cref="T:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler"/>
Initializes an instanse of the <see cref="T:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler"/>
class.
</summary>
</member>
@@ -554,15 +564,21 @@
<param name="args">An <see cref="T:System.AssemblyLoadEventArgs"/> that contains the event data.</param>
</member>
<member name="F:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler._probePaths">
<summary>
Holds the list of directories that will be scanned for missing
assembly references.
</summary>
<summary>
Holds the list of directories that will be scanned for missing
assembly references.
</summary>
</member>
<member name="F:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler._referenceAssemblies">
<summary>
Holds the list of assemblies that can be scanned for missing
assembly references.
</summary>
</member>
<member name="F:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler._assemblyCache">
<summary>
Holds the loaded assemblies.
</summary>
<summary>
Holds the loaded assemblies.
</summary>
</member>
</members>
</doc>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -11,17 +11,47 @@
</summary>
</member>
<member name="M:NAnt.Console.ConsoleStub.Main(System.String[])">
<summary>
Entry point for executable
</summary>
<param name="args">Command Line arguments</param>
<returns>The result of the real execution</returns>
<summary>
Entry point for executable
</summary>
<param name="args">Command Line arguments</param>
<returns>The result of the real execution</returns>
</member>
<member name="M:NAnt.Console.ConsoleStub.ConstructPrivateBinPath(NAnt.Console.ConsoleStub.Framework,System.String)">
<summary>
Constructs the privatebinpath.
</summary>
<remarks>
<para>
For the common version dir, we do not use the framework version
as defined in the NAnt configuration file but the CLR version
since the assemblies in that directory are not specific to a
certain family and the framwork version might differ between
families (eg. mono 1.0 == .NET 1.1).
</para>
</remarks>
<param name="runtimeFramework">The runtime framework.</param>
<param name="baseDir">The base directory of the domain.</param>
<returns>
The privatebinpath.
</returns>
</member>
<member name="M:NAnt.Console.ConsoleStub.GetRelativePath(System.String,System.String)">
<summary>
Given an absolute directory and an absolute file name, returns a
relative file name.
</summary>
<param name="basePath">An absolute directory.</param>
<param name="absolutePath">An absolute file name.</param>
<returns>
A relative file name for the given absolute file name.
</returns>
</member>
<member name="T:NAnt.Console.ConsoleStub.HelperArguments">
<summary>
Helper class for invoking the application entry point in NAnt.Core
and passing the command-line arguments.
</summary>
<summary>
Helper class for invoking the application entry point in NAnt.Core
and passing the command-line arguments.
</summary>
</member>
<member name="M:NAnt.Console.ConsoleStub.HelperArguments.#ctor(System.String[],System.String)">
<summary>
@@ -32,17 +62,17 @@
<param name="probePaths">Directories relative to the base directory of the AppDomain to probe for missing assembly references.</param>
</member>
<member name="M:NAnt.Console.ConsoleStub.HelperArguments.CallConsoleRunner">
<summary>
Invokes the application entry point in NAnt.Core.
</summary>
<summary>
Invokes the application entry point in NAnt.Core.
</summary>
</member>
<member name="P:NAnt.Console.ConsoleStub.HelperArguments.ExitCode">
<summary>
Gets the status that the build process returned when it exited.
</summary>
<value>
The code that the build process specified when it terminated.
</value>
<summary>
Gets the status that the build process returned when it exited.
</summary>
<value>
The code that the build process specified when it terminated.
</value>
</member>
</members>
</doc>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> DataTypeBase</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>DataTypeBase</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Provides the abstract base class for types. </p>
<h3>Parameters</h3>
<div class="table">
@@ -50,7 +51,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> ChainableReader</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>ChainableReader</h1>
<p> Functions as a chainable TextReader </p> Implements a abstraction over a TextReader that allows the class to represent either a TextReader or another ChainableReader to which it is chained. By passing a ChainableReader as a constructor paramater it is possiable to chain many ChainableReaders together. The last ChainableReader in the chain must be based on a TextReader. <h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.Core (0.85.2478.0)
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Functions as a chainable TextReader </p> Implements a abstraction over a TextReader that allows the class to represent either a TextReader or another ChainableReader to which it is chained. By passing a ChainableReader as a constructor paramater it is possiable to chain many ChainableReaders together. The last ChainableReader in the chain must be based on a TextReader. <h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div></body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> Filter</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>Filter</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Allows a file's content to be modified while performing an operation. </p>
<h3>Parameters</h3>
<div class="table">
@@ -50,7 +51,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> Target</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>Target</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>
</p>
<h3>Parameters</h3>
@@ -38,8 +39,8 @@
<tr>
<td valign="top" class="required">name</td>
<td style="text-align: center;">string</td>
<td> The name of the target. <p style="font-weight: bold;">
This attribute's properties will not be automatically expanded!
<td> The name of the target. <p style="font-weight: bold;">
This attribute's properties will not be automatically expanded!
</p></td>
<td style="text-align: center;">True</td>
</tr>
@@ -58,16 +59,16 @@
<tr>
<td valign="top">if</td>
<td style="text-align: center;">string</td>
<td> If <b>true</b> then the target will be executed; otherwise, skipped. The default is <b>true</b>. <p style="font-weight: bold;">
This attribute's properties will not be automatically expanded!
<td> If <b>true</b> then the target will be executed; otherwise, skipped. The default is <b>true</b>. <p style="font-weight: bold;">
This attribute's properties will not be automatically expanded!
</p></td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">unless</td>
<td style="text-align: center;">string</td>
<td> Opposite of <code>IfDefined</code>. If <b>false</b> then the target will be executed; otherwise, skipped. The default is <b>false</b>. <p style="font-weight: bold;">
This attribute's properties will not be automatically expanded!
<td> Opposite of <code>IfDefined</code>. If <b>false</b> then the target will be executed; otherwise, skipped. The default is <b>false</b>. <p style="font-weight: bold;">
This attribute's properties will not be automatically expanded!
</p></td>
<td style="text-align: center;">False</td>
</tr>
@@ -75,7 +76,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> Task</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>Task</h1>
<p> Provides the abstract base class for tasks. </p> A task is a piece of code that can be executed. <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">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>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.Core (0.85.2478.0)
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Provides the abstract base class for tasks. </p> A task is a piece of code that can be executed. <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">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>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div></body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> TaskContainer</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>TaskContainer</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Executes embedded tasks in the order in which they are defined. </p>
<h3>Parameters</h3>
<div class="table">
@@ -62,7 +63,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,12 +19,15 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> ExternalProgramBase</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>ExternalProgramBase</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Provides the abstract base class for tasks that execute external applications. </p>
<p> When a <a href="../../sdk/NAnt.Core.Attributes.ProgramLocationAttribute.html">ProgramLocationAttribute</a> is applied to the deriving class and <code>exename</code> does not return an absolute path, then the program to execute will first be searched for in the location specified by <code>LocationType</code>. </p>
<p> If the program does not exist in that location, then the list of tool paths of the current target framework will be scanned in the order in which they are defined in the NAnt configuration file. </p>
<h3>Parameters</h3>
<div class="table">
<table>
@@ -81,10 +84,19 @@
<td> The name of the executable that should be used to launch the external program. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">managed</td>
<td style="text-align: center;">
<a href="../enums/NAnt.Core.Types.ManagedExecution.html">ManagedExecution</a>
</td>
<td> Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">useruntimeengine</td>
<td style="text-align: center;">bool</td>
<td> Specifies whether the external program should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
<td>
<i>Deprecated.</i> Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
</table>
@@ -94,13 +106,13 @@
<!--NestedElementArray=T:NAnt.Core.Types.Argument-->
<h4>
<a id="arg">
</a>
&lt;arg&gt;
</a>
&lt;arg&gt;
</h4>
<div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><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">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4><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><h4><a id="path"></a>
&lt;/<a href="../types/path.html">path</a>&gt;
<div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><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><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">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4><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><h4><a id="path"></a>
&lt;/<a href="../types/path.html">path</a>&gt;
</h4><h3>Examples</h3><ul class="examples"><li><p> A single command-line argument containing a space character. </p><pre class="code">
&lt;arg value="-l -a" /&gt;
</pre></li><li><p> Two separate command-line arguments. </p><pre class="code">
@@ -110,12 +122,12 @@
</pre></li></ul></div>
<h4>
<a id="arg">
</a>
&lt;/arg&gt;
</a>
&lt;/arg&gt;
</h4>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,31 +19,32 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> InElement</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>InElement</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>
</p>
<h3>Nested Elements:</h3>
<!--Element-->
<h4>
<a id="items">
</a>
&lt;<a href="../types/fileset.html">items</a>&gt;
</a>
&lt;<a href="../types/fileset.html">items</a>&gt;
</h4>
<div class="nested-element">
<p />
</div>
<h4>
<a id="items">
</a>
&lt;/<a href="../types/fileset.html">items</a>&gt;
</a>
&lt;/<a href="../types/fileset.html">items</a>&gt;
</h4>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,12 +19,14 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;arg&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;arg&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents a command-line argument. </p>
<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>
<h3>Parameters</h3>
<div class="table">
<table>
@@ -82,14 +84,14 @@
<!--Element-->
<h4>
<a id="path">
</a>
&lt;<a href="../types/path.html">path</a>&gt;
</a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4>
<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>
<h4>
<a id="path">
</a>
&lt;/<a href="../types/path.html">path</a>&gt;
</a>
&lt;/<a href="../types/path.html">path</a>&gt;
</h4>
<h3>Examples</h3>
<ul class="examples">
@@ -114,7 +116,7 @@
</ul>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,47 +19,48 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;environment&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;environment&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> A set of environment variables. </p>
<h3>Nested Elements:</h3>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.Option-->
<h4>
<a id="option">
</a>
&lt;option&gt;
</a>
&lt;option&gt;
</h4>
<div class="nested-element">
<i>Deprecated.</i> Environment variable to pass to a program. <p> Represents an option. </p><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" class="required">name</td><td style="text-align: center;">string</td><td> Name of the option. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> Indicates if the option should be passed to the task. If <b>true</b> then the option will be passed; 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> Indicates if the option should not be passed to the task. If <b>false</b> then the option will be passed; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> Value of the option. The default is a null reference (<b>Nothing</b> in Visual Basic). </td><td style="text-align: center;">False</td></tr></table></div></div>
<h4>
<a id="option">
</a>
&lt;/option&gt;
</a>
&lt;/option&gt;
</h4>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.EnvironmentVariable-->
<h4>
<a id="variable">
</a>
&lt;variable&gt;
</a>
&lt;variable&gt;
</h4>
<div class="nested-element"> Environment variable to pass to a program. <p> Represents an environment variable. </p><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" class="required">name</td><td style="text-align: center;">string</td><td> The name of the environment variable. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based environment variable. NAnt will convert it to an absolute path. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The value for a file-based environment variable. NAnt will convert it to an absolute filename. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> Indicates if the environment variable should be passed to the external program. If <b>true</b> then the environment variable will be passed; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><td> The value for a PATH like environment variable. You can use <code>:</code> or <code>;</code> as path separators and NAnt will convert it to the platform's local conventions. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Indicates if the environment variable should not be passed to the external program. If <b>false</b> then the environment variable will be passed; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> The literal value for the environment variable. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4><div class="nested-element"> Sets a single environment variable and treats it like a PATH - ensures the right separator for the local platform is used. <p /></div><h4><a id="path"></a>
&lt;/<a href="../types/path.html">path</a>&gt;
<div class="nested-element"> Environment variable to pass to a program. <p> Represents an environment variable. </p><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" class="required">name</td><td style="text-align: center;">string</td><td> The name of the environment variable. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based environment variable. NAnt will convert it to an absolute path. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The value for a file-based environment variable. NAnt will convert it to an absolute filename. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> Indicates if the environment variable should be passed to the external program. If <b>true</b> then the environment variable will be passed; otherwise, skipped. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><td> The value for a PATH like environment variable. You can use <code>:</code> or <code>;</code> as path separators and NAnt will convert it to the platform's local conventions. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><td> Indicates if the environment variable should not be passed to the external program. If <b>false</b> then the environment variable will be passed; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> The literal value for the environment variable. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4><div class="nested-element"> Sets a single environment variable and treats it like a PATH - ensures the right separator for the local platform is used. <p /></div><h4><a id="path"></a>
&lt;/<a href="../types/path.html">path</a>&gt;
</h4></div>
<h4>
<a id="variable">
</a>
&lt;/variable&gt;
</a>
&lt;/variable&gt;
</h4>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;env&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;env&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents an environment variable. </p>
<h3>Parameters</h3>
<div class="table">
@@ -82,18 +83,18 @@
<!--Element-->
<h4>
<a id="path">
</a>
&lt;<a href="../types/path.html">path</a>&gt;
</a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4>
<div class="nested-element"> Sets a single environment variable and treats it like a PATH - ensures the right separator for the local platform is used. <p /></div>
<h4>
<a id="path">
</a>
&lt;/<a href="../types/path.html">path</a>&gt;
</a>
&lt;/<a href="../types/path.html">path</a>&gt;
</h4>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> FileSet.Exclude</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>FileSet.Exclude</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>
</p>
<h3>Parameters</h3>
@@ -57,7 +58,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> FileSet.ExcludesFile</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>FileSet.ExcludesFile</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>
</p>
<h3>Parameters</h3>
@@ -57,7 +58,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> FileSet.Include</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>FileSet.Include</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>
</p>
<h3>Parameters</h3>
@@ -69,7 +70,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> FileSet.IncludesFile</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>FileSet.IncludesFile</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>
</p>
<h3>Parameters</h3>
@@ -69,7 +70,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;formatter&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;formatter&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>
</p>
<h3>Parameters</h3>
@@ -63,7 +64,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;option&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;option&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents an option. </p>
<h3>Parameters</h3>
<div class="table">
@@ -62,7 +63,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;pathelement&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;pathelement&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents a nested path element. </p>
<h3>Parameters</h3>
<div class="table">
@@ -68,7 +69,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,15 +19,16 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> RawXml</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>RawXml</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents an element of which the XML is processed by its parent task or type. </p>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;token&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;token&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> ReplaceTokens filter token. </p>
<h3>Parameters</h3>
<div class="table">
@@ -62,7 +63,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;namespace&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;namespace&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents an XML namespace. </p>
<h3>Parameters</h3>
<div class="table">
@@ -62,7 +63,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;xsltextensionobject&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;xsltextensionobject&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents an XSLT extension object. The object should have a default parameterless constructor and the return value should be one of the four basic XPath data types of number, string, Boolean or node set. </p>
<h3>Parameters</h3>
<div class="table">
@@ -68,7 +69,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;xsltparameter&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;xsltparameter&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents an XSLT parameter. </p>
<h3>Parameters</h3>
<div class="table">
@@ -68,7 +69,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> CompilerBase</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>CompilerBase</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Provides the abstract base class for compiler tasks. </p>
<h3>Parameters</h3>
<div class="table">
@@ -58,6 +59,14 @@
<td> Define conditional compilation symbol(s). </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">delaysign</td>
<td style="text-align: center;">
<a href="../enums/NAnt.DotNet.Types.DelaySign.html">DelaySign</a>
</td>
<td> Specifies whether to delay sign the assembly using only the public portion of the strong name key. The default is <code>NotSet</code>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">keycontainer</td>
<td style="text-align: center;">string</td>
@@ -101,6 +110,12 @@
<td> Icon to associate with the application. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">win32res</td>
<td style="text-align: center;">file</td>
<td> Specifies a Win32 resource file (.res). </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">failonerror</td>
<td style="text-align: center;">bool</td>
@@ -148,6 +163,20 @@
<td> The name of the executable that should be used to launch the external program. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">managed</td>
<td style="text-align: center;">
<a href="../enums/NAnt.Core.Types.ManagedExecution.html">ManagedExecution</a>
</td>
<td> Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">supportsdelaysign</td>
<td style="text-align: center;">bool</td>
<td> Indicates whether the compiler for a given target framework supports the "delaysign" option. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">supportskeycontainer</td>
<td style="text-align: center;">bool</td>
@@ -181,7 +210,8 @@
<tr>
<td valign="top">useruntimeengine</td>
<td style="text-align: center;">bool</td>
<td> Specifies whether the external program should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
<td>
<i>Deprecated.</i> Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
</table>
@@ -190,53 +220,53 @@
<!--Element-->
<h4>
<a id="warnaserror">
</a>
&lt;<a href="../types/warnaserror.html">warnaserror</a>&gt;
</a>
&lt;<a href="../types/warnaserror.html">warnaserror</a>&gt;
</h4>
<div class="nested-element"> Controls which warnings should be reported as errors. <p /></div>
<h4>
<a id="warnaserror">
</a>
&lt;/<a href="../types/warnaserror.html">warnaserror</a>&gt;
</a>
&lt;/<a href="../types/warnaserror.html">warnaserror</a>&gt;
</h4>
<!--Collection-->
<h4>
<a id="nowarn">
</a>
&lt;nowarn&gt;
</a>
&lt;nowarn&gt;
</h4>
<div class="nested-element"> Specifies a list of warnings that you want the compiler to suppress. <h5>&lt;warning&gt;</h5><div class="nested-element"><p> Represents a compiler warning. </p><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" class="required">number</td><td style="text-align: center;">string</td><td> A warning number, or comma-separated list of warnings, that you want the compiler to suppress or report. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the element will be processed; 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> If <b>true</b> then the element will be skipped; otherwise, processed. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h5>&lt;/warning&gt;</h5></div>
<h4>&lt;/nowarn&gt;</h4>
<!--Element-->
<h4>
<a id="lib">
</a>
&lt;<a href="../types/fileset.html">lib</a>&gt;
</a>
&lt;<a href="../types/fileset.html">lib</a>&gt;
</h4>
<div class="nested-element">
<i>Deprecated.</i> Additional directories to search in for assembly references. <p /></div>
<h4>
<a id="lib">
</a>
&lt;/<a href="../types/fileset.html">lib</a>&gt;
</a>
&lt;/<a href="../types/fileset.html">lib</a>&gt;
</h4>
<!--Element-->
<h4>
<a id="references">
</a>
&lt;<a href="../types/assemblyfileset.html">references</a>&gt;
</a>
&lt;<a href="../types/assemblyfileset.html">references</a>&gt;
</h4>
<div class="nested-element"> Reference metadata from the specified assembly files. <p /></div>
<h4>
<a id="references">
</a>
&lt;/<a href="../types/assemblyfileset.html">references</a>&gt;
</a>
&lt;/<a href="../types/assemblyfileset.html">references</a>&gt;
</h4>
<!--Collection-->
<h4>
<a id="pkg-references">
</a>
&lt;pkg-references&gt;
</a>
&lt;pkg-references&gt;
</h4>
<div class="nested-element"> Specifies list of packages to reference. <h5>&lt;package&gt;</h5><div class="nested-element"><p> Represents a package. </p><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" class="required">name</td><td style="text-align: center;">string</td><td> Name of the package to reference. Multiple package can be specified with a single element as a semi-colon separated list of package names. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> Indicates if the package should be passed to the task. If <b>true</b> then the package will be passed; 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> Indicates if the package should not be passed to the task. If <b>false</b> then the package will be passed; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h5>&lt;/package&gt;</h5></div>
<h4>&lt;/pkg-references&gt;</h4>
@@ -244,50 +274,50 @@
<!--NestedElementArray=T:NAnt.DotNet.Types.ResourceFileSet-->
<h4>
<a id="resources">
</a>
&lt;<a href="../types/resourcefileset.html">resources</a>&gt;
</a>
&lt;<a href="../types/resourcefileset.html">resources</a>&gt;
</h4>
<div class="nested-element"> Resources to embed. </div>
<h4>
<a id="resources">
</a>
&lt;/<a href="../types/resourcefileset.html">resources</a>&gt;
</a>
&lt;/<a href="../types/resourcefileset.html">resources</a>&gt;
</h4>
<!--Element-->
<h4>
<a id="modules">
</a>
&lt;<a href="../types/assemblyfileset.html">modules</a>&gt;
</a>
&lt;<a href="../types/assemblyfileset.html">modules</a>&gt;
</h4>
<div class="nested-element"> Link the specified modules into this assembly. <p /></div>
<h4>
<a id="modules">
</a>
&lt;/<a href="../types/assemblyfileset.html">modules</a>&gt;
</a>
&lt;/<a href="../types/assemblyfileset.html">modules</a>&gt;
</h4>
<!--Element-->
<h4>
<a id="sources">
</a>
&lt;<a href="../types/fileset.html">sources</a>&gt;
</a>
&lt;<a href="../types/fileset.html">sources</a>&gt;
</h4>
<div class="nested-element"> The set of source files for compilation. <p /></div>
<h4>
<a id="sources">
</a>
&lt;/<a href="../types/fileset.html">sources</a>&gt;
</a>
&lt;/<a href="../types/fileset.html">sources</a>&gt;
</h4>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.Argument-->
<h4>
<a id="arg">
</a>
&lt;arg&gt;
</a>
&lt;arg&gt;
</h4>
<div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><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">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4><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><h4><a id="path"></a>
&lt;/<a href="../types/path.html">path</a>&gt;
<div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><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><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">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4><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><h4><a id="path"></a>
&lt;/<a href="../types/path.html">path</a>&gt;
</h4><h3>Examples</h3><ul class="examples"><li><p> A single command-line argument containing a space character. </p><pre class="code">
&lt;arg value="-l -a" /&gt;
</pre></li><li><p> Two separate command-line arguments. </p><pre class="code">
@@ -297,12 +327,12 @@
</pre></li></ul></div>
<h4>
<a id="arg">
</a>
&lt;/arg&gt;
</a>
&lt;/arg&gt;
</h4>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.DotNetTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.DotNetTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;attribute&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;attribute&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents an assembly-level attribute. </p>
<h3>Parameters</h3>
<div class="table">
@@ -68,7 +69,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.DotNetTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.DotNetTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> CompilerWarning</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>CompilerWarning</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents a compiler warning. </p>
<h3>Parameters</h3>
<div class="table">
@@ -56,7 +57,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.DotNetTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.DotNetTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> DataTypeCollectionBase</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>DataTypeCollectionBase</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Base class for collections that needs to be globally referencable. </p>
<h3>Parameters</h3>
<div class="table">
@@ -50,7 +51,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.DotNetTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.DotNetTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> EmbeddedResourceCollection</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>EmbeddedResourceCollection</h1>
<p> Contains a collection of <a href="../../sdk/NAnt.DotNet.Types.EmbeddedResource.html">EmbeddedResource</a> items. </p> Do not yet expose this to build authors. <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">id</td><td style="text-align: center;">string</td><td> The ID used to be referenced later. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">refid</td><td style="text-align: center;">string</td><td> The ID to use as the reference. </td><td style="text-align: center;">False</td></tr></table></div><h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.DotNetTasks (0.85.2478.0)
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Contains a collection of <a href="../../sdk/NAnt.DotNet.Types.EmbeddedResource.html">EmbeddedResource</a> items. </p> Do not yet expose this to build authors. <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">id</td><td style="text-align: center;">string</td><td> The ID used to be referenced later. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">refid</td><td style="text-align: center;">string</td><td> The ID to use as the reference. </td><td style="text-align: center;">False</td></tr></table></div><h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.DotNetTasks (0.91.3881.0)
</div></body>
</html>

View File

@@ -19,39 +19,44 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> LibDirectorySet</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>LibDirectorySet</h1>
<p> A specialized <a href="../types/fileset.html">&lt;fileset&gt;</a> used for setting the lib directories. </p> The primary reason for this class is to allow the <code>BaseDirectory</code> to always be the same value as the parent <a href="../types/assemblyfileset.html">&lt;assemblyfileset&gt;</a><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">defaultexcludes</td><td style="text-align: center;">bool</td><td> Indicates whether default excludes should be used or not. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">failonempty</td><td style="text-align: center;">bool</td><td> When set to <b>true</b>, causes the fileset element to throw a <a href="../../sdk/NAnt.Core.ValidationException.html">ValidationException</a> when no files match the includes and excludes criteria. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">id</td><td style="text-align: center;">string</td><td> The ID used to be referenced later. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">refid</td><td style="text-align: center;">string</td><td> The ID to use as the reference. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.Include--><h4><a id="includes"></a>
&lt;includes&gt;
</h4><div class="nested-element"><i>Deprecated.</i> The items to include in the fileset. <p></p><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" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to include. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file name will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file will be searched for on the path. The default is <b>false</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 pattern will be included; 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 pattern will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h4><a id="includes"></a>
&lt;/includes&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.Include--><h4><a id="include"></a>
&lt;include&gt;
</h4><div class="nested-element"> The items to include in the fileset. <p></p><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" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to include. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file name will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file will be searched for on the path. The default is <b>false</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 pattern will be included; 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 pattern will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h4><a id="include"></a>
&lt;/include&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.Exclude--><h4><a id="excludes"></a>
&lt;excludes&gt;
</h4><div class="nested-element"><i>Deprecated.</i> The items to exclude from the fileset. <p></p><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" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to exclude. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be excluded; 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 pattern will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h4><a id="excludes"></a>
&lt;/excludes&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.Exclude--><h4><a id="exclude"></a>
&lt;exclude&gt;
</h4><div class="nested-element"> The items to exclude from the fileset. <p></p><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" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to exclude. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be excluded; 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 pattern will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h4><a id="exclude"></a>
&lt;/exclude&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.IncludesFile--><h4><a id="includesList"></a>
&lt;includesList&gt;
</h4><div class="nested-element"><i>Deprecated.</i> The files from which a list of patterns or files to include should be obtained. <p></p><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">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be searched for on the path. The default is <b>false</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 patterns will be included; 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 patterns will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr></table></div></div><h4><a id="includesList"></a>
&lt;/includesList&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.IncludesFile--><h4><a id="includesfile"></a>
&lt;includesfile&gt;
</h4><div class="nested-element"> The files from which a list of patterns or files to include should be obtained. <p></p><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">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be searched for on the path. The default is <b>false</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 patterns will be included; 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 patterns will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr></table></div></div><h4><a id="includesfile"></a>
&lt;/includesfile&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.ExcludesFile--><h4><a id="excludesfile"></a>
&lt;excludesfile&gt;
</h4><div class="nested-element"> The files from which a list of patterns or files to exclude should be obtained. <p></p><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" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns will be excluded; 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 patterns will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h4><a id="excludesfile"></a>
&lt;/excludesfile&gt;
</h4><h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.DotNetTasks (0.85.2478.0)
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> A specialized <a href="../types/fileset.html">&lt;fileset&gt;</a> used for setting the lib directories. </p> The primary reason for this class is to allow the <code>BaseDirectory</code> to always be the same value as the parent <a href="../types/assemblyfileset.html">&lt;assemblyfileset&gt;</a><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">casesensitive</td><td style="text-align: center;">bool</td><td> Indicates whether include and exclude patterns must be treated in a case-sensitive way. The default is <b>true</b> on Unix; otherwise, <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">defaultexcludes</td><td style="text-align: center;">bool</td><td> Indicates whether default excludes should be used or not. The default is <b>true</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">failonempty</td><td style="text-align: center;">bool</td><td> When set to <b>true</b>, causes the fileset element to throw a <a href="../../sdk/NAnt.Core.ValidationException.html">ValidationException</a> when no files match the includes and excludes criteria. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">id</td><td style="text-align: center;">string</td><td> The ID used to be referenced later. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">refid</td><td style="text-align: center;">string</td><td> The ID to use as the reference. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.Include--><h4><a id="includes"></a>
&lt;includes&gt;
</h4><div class="nested-element"><i>Deprecated.</i> The items to include in the fileset. <p></p><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" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to include. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file name will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file will be searched for on the path. The default is <b>false</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 pattern will be included; 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 pattern will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h4><a id="includes"></a>
&lt;/includes&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.Include--><h4><a id="include"></a>
&lt;include&gt;
</h4><div class="nested-element"> The items to include in the fileset. <p></p><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" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to include. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file name will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the file will be searched for on the path. The default is <b>false</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 pattern will be included; 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 pattern will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h4><a id="include"></a>
&lt;/include&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.Exclude--><h4><a id="excludes"></a>
&lt;excludes&gt;
</h4><div class="nested-element"><i>Deprecated.</i> The items to exclude from the fileset. <p></p><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" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to exclude. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be excluded; 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 pattern will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h4><a id="excludes"></a>
&lt;/excludes&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.Exclude--><h4><a id="exclude"></a>
&lt;exclude&gt;
</h4><div class="nested-element"> The items to exclude from the fileset. <p></p><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" class="required">name</td><td style="text-align: center;">string</td><td> The pattern or file name to exclude. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the pattern will be excluded; 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 pattern will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h4><a id="exclude"></a>
&lt;/exclude&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.IncludesFile--><h4><a id="includesList"></a>
&lt;includesList&gt;
</h4><div class="nested-element"><i>Deprecated.</i> The files from which a list of patterns or files to include should be obtained. <p></p><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">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be searched for on the path. The default is <b>false</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 patterns will be included; 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 patterns will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr></table></div></div><h4><a id="includesList"></a>
&lt;/includesList&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.IncludesFile--><h4><a id="includesfile"></a>
&lt;includesfile&gt;
</h4><div class="nested-element"> The files from which a list of patterns or files to include should be obtained. <p></p><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">asis</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be added to the <a href="../types/fileset.html">&lt;fileset&gt;</a> without pattern matching or checking if the file exists. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">frompath</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns in the include file will be searched for on the path. The default is <b>false</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 patterns will be included; 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 patterns will be included; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr><tr><td valign="top" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr></table></div></div><h4><a id="includesfile"></a>
&lt;/includesfile&gt;
</h4><!--Array--><!--NestedElementArray=T:NAnt.Core.Types.FileSet.ExcludesFile--><h4><a id="excludesfile"></a>
&lt;excludesfile&gt;
</h4><div class="nested-element"> The files from which a list of patterns or files to exclude should be obtained. <p></p><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" class="required">name</td><td style="text-align: center;">file</td><td> The name of a file; each line of this file is taken to be a pattern. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the patterns will be excluded; 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 patterns will be excluded; otherwise, skipped. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div><h4><a id="excludesfile"></a>
&lt;/excludesfile&gt;
</h4><!--Element--><h4><a id="patternset"></a>
&lt;<a href="../types/patternset.html">patternset</a>&gt;
</h4><div class="nested-element"> Adds a nested set of patterns, or references a standalone patternset. <p /></div><h4><a id="patternset"></a>
&lt;/<a href="../types/patternset.html">patternset</a>&gt;
</h4><h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.DotNetTasks (0.91.3881.0)
</div><h3>See Also</h3><a href="../types/fileset.html">&lt;fileset&gt;</a></body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;import&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;import&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents a namespace to import. </p>
<h3>Parameters</h3>
<div class="table">
@@ -63,7 +64,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.DotNetTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.DotNetTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> Package</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>Package</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents a package. </p>
<h3>Parameters</h3>
<div class="table">
@@ -56,7 +57,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.DotNetTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.DotNetTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;formatter&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;formatter&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents the FormatterElement of the NUnit task. </p>
<h3>Parameters</h3>
<div class="table">
@@ -64,7 +65,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.NUnit (0.85.2478.0)
<b>Assembly:</b> NAnt.NUnit (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;test&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;test&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents a test element of an <a href="../tasks/nunit.html">&lt;nunit&gt;</a> task. </p>
<h3>Parameters</h3>
<div class="table">
@@ -86,7 +87,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.NUnit1Tasks (0.85.2478.0)
<b>Assembly:</b> NAnt.NUnit1Tasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> Category</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>Category</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents a certain group of test cases or fixtures. </p>
<h3>Parameters</h3>
<div class="table">
@@ -56,7 +57,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.NUnit2Tasks (0.85.2478.0)
<b>Assembly:</b> NAnt.NUnit2Tasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;test&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;test&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents a <code>test</code> element of an <a href="../tasks/nunit2.html">&lt;nunit2&gt;</a> task. </p>
<h3>Parameters</h3>
<div class="table">
@@ -70,30 +71,42 @@
<!--Element-->
<h4>
<a id="assemblies">
</a>
&lt;<a href="../types/assemblyfileset.html">assemblies</a>&gt;
</a>
&lt;<a href="../types/assemblyfileset.html">assemblies</a>&gt;
</h4>
<div class="nested-element"> Assemblies to include in test. <p /></div>
<h4>
<a id="assemblies">
</a>
&lt;/<a href="../types/assemblyfileset.html">assemblies</a>&gt;
</a>
&lt;/<a href="../types/assemblyfileset.html">assemblies</a>&gt;
</h4>
<!--Element-->
<h4>
<a id="references">
</a>
&lt;<a href="../types/assemblyfileset.html">references</a>&gt;
</h4>
<div class="nested-element"> Assemblies to scan for missing assembly references. <p /></div>
<h4>
<a id="references">
</a>
&lt;/<a href="../types/assemblyfileset.html">references</a>&gt;
</h4>
<!--Element-->
<h4>
<a id="categories">
</a>
&lt;<a href="../types/categories.html">categories</a>&gt;
</a>
&lt;<a href="../types/categories.html">categories</a>&gt;
</h4>
<div class="nested-element"> Categories of test cases to include or exclude. <p /></div>
<h4>
<a id="categories">
</a>
&lt;/<a href="../types/categories.html">categories</a>&gt;
</a>
&lt;/<a href="../types/categories.html">categories</a>&gt;
</h4>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.NUnit2Tasks (0.85.2478.0)
<b>Assembly:</b> NAnt.NUnit2Tasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> AbstractCvsTask</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>AbstractCvsTask</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> A base class for creating tasks for executing CVS client commands on a CVS repository. </p>
<h3>Parameters</h3>
<div class="table">
@@ -178,10 +179,19 @@
<th>Description</th>
<th style="text-align: center;">Required</th>
</tr>
<tr>
<td valign="top">managed</td>
<td style="text-align: center;">
<a href="../enums/NAnt.Core.Types.ManagedExecution.html">ManagedExecution</a>
</td>
<td> Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">useruntimeengine</td>
<td style="text-align: center;">bool</td>
<td> Specifies whether the external program should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
<td>
<i>Deprecated.</i> Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
</table>
@@ -190,26 +200,26 @@
<!--Element-->
<h4>
<a id="fileset">
</a>
&lt;<a href="../types/cvsfileset.html">fileset</a>&gt;
</a>
&lt;<a href="../types/cvsfileset.html">fileset</a>&gt;
</h4>
<div class="nested-element"> Used to specify the version control system (VCS) files that are going to be acted on. <p /></div>
<h4>
<a id="fileset">
</a>
&lt;/<a href="../types/cvsfileset.html">fileset</a>&gt;
</a>
&lt;/<a href="../types/cvsfileset.html">fileset</a>&gt;
</h4>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.Argument-->
<h4>
<a id="arg">
</a>
&lt;arg&gt;
</a>
&lt;arg&gt;
</h4>
<div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><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">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4><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><h4><a id="path"></a>
&lt;/<a href="../types/path.html">path</a>&gt;
<div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><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><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">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4><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><h4><a id="path"></a>
&lt;/<a href="../types/path.html">path</a>&gt;
</h4><h3>Examples</h3><ul class="examples"><li><p> A single command-line argument containing a space character. </p><pre class="code">
&lt;arg value="-l -a" /&gt;
</pre></li><li><p> Two separate command-line arguments. </p><pre class="code">
@@ -219,12 +229,12 @@
</pre></li></ul></div>
<h4>
<a id="arg">
</a>
&lt;/arg&gt;
</a>
&lt;/arg&gt;
</h4>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.SourceControlTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.SourceControlTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> AbstractSourceControlTask</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>AbstractSourceControlTask</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> A base class for creating tasks for executing CVS client commands on a CVS repository. </p>
<h3>Parameters</h3>
<div class="table">
@@ -106,10 +107,19 @@
<th>Description</th>
<th style="text-align: center;">Required</th>
</tr>
<tr>
<td valign="top">managed</td>
<td style="text-align: center;">
<a href="../enums/NAnt.Core.Types.ManagedExecution.html">ManagedExecution</a>
</td>
<td> Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR. </td>
<td style="text-align: center;">False</td>
</tr>
<tr>
<td valign="top">useruntimeengine</td>
<td style="text-align: center;">bool</td>
<td> Specifies whether the external program should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
<td>
<i>Deprecated.</i> Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is <b>false</b>. </td>
<td style="text-align: center;">False</td>
</tr>
</table>
@@ -118,26 +128,26 @@
<!--Element-->
<h4>
<a id="fileset">
</a>
&lt;<a href="../types/fileset.html">fileset</a>&gt;
</a>
&lt;<a href="../types/fileset.html">fileset</a>&gt;
</h4>
<div class="nested-element"> Used to specify the version control system (VCS) files that are going to be acted on. <p /></div>
<h4>
<a id="fileset">
</a>
&lt;/<a href="../types/fileset.html">fileset</a>&gt;
</a>
&lt;/<a href="../types/fileset.html">fileset</a>&gt;
</h4>
<!--Array-->
<!--NestedElementArray=T:NAnt.Core.Types.Argument-->
<h4>
<a id="arg">
</a>
&lt;arg&gt;
</a>
&lt;arg&gt;
</h4>
<div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><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">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4><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><h4><a id="path"></a>
&lt;/<a href="../types/path.html">path</a>&gt;
<div class="nested-element"> The command-line arguments for the external program. <p> Represents a command-line argument. </p><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><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">dir</td><td style="text-align: center;">directory</td><td> The value for a directory-based command-line argument; will be replaced with the absolute path of the directory. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">file</td><td style="text-align: center;">file</td><td> The name of a file as a single command-line argument; will be replaced with the absolute filename of the file. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">line</td><td style="text-align: center;">string</td><td> List of command-line arguments; will be passed to the executable as is. </td><td style="text-align: center;">False</td></tr><tr><td valign="top">path</td><td style="text-align: center;">&lt;path&gt;</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">unless</td><td style="text-align: center;">bool</td><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><td style="text-align: center;">False</td></tr><tr><td valign="top">value</td><td style="text-align: center;">string</td><td> A single command-line argument; can contain space characters. </td><td style="text-align: center;">False</td></tr></table></div><h3>Nested Elements:</h3><!--Element--><h4><a id="path"></a>
&lt;<a href="../types/path.html">path</a>&gt;
</h4><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><h4><a id="path"></a>
&lt;/<a href="../types/path.html">path</a>&gt;
</h4><h3>Examples</h3><ul class="examples"><li><p> A single command-line argument containing a space character. </p><pre class="code">
&lt;arg value="-l -a" /&gt;
</pre></li><li><p> Two separate command-line arguments. </p><pre class="code">
@@ -147,12 +157,12 @@
</pre></li></ul></div>
<h4>
<a id="arg">
</a>
&lt;/arg&gt;
</a>
&lt;/arg&gt;
</h4>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.SourceControlTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.SourceControlTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> WebMap</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>WebMap</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents a single mapping from URL project path to physical project path. </p>
<h3>Parameters</h3>
<div class="table">
@@ -68,7 +69,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.VSNetTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.VSNetTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> Library</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>Library</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents a library. </p>
<h3>Parameters</h3>
<div class="table">
@@ -56,7 +57,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.VisualCppTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.VisualCppTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Element Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> Symbol</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>Symbol</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Represents a symbol. </p>
<h3>Parameters</h3>
<div class="table">
@@ -56,7 +57,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.VisualCppTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.VisualCppTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> DuplicateHandling</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>DuplicateHandling</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Specifies how entries with the same name should be processed. </p>
<h3>Fields</h3>
<div class="table">
@@ -48,7 +49,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.CompressionTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.CompressionTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> Level</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>Level</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Defines the set of levels recognised by the NAnt logging system. </p>
<h3>Fields</h3>
<div class="table">
@@ -60,7 +61,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> AvailableTask.ResourceType</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>AvailableTask.ResourceType</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Defines the possible resource checks. </p>
<h3>Fields</h3>
<div class="table">
@@ -52,7 +53,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> LoopTask.LoopItem</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>LoopTask.LoopItem</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>
</p>
<h3>Fields</h3>
@@ -57,7 +58,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> LoopTask.LoopTrim</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>LoopTask.LoopTrim</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>
</p>
<h3>Fields</h3>
@@ -53,7 +54,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> AssemblyInfoTask.CodeLanguage</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>AssemblyInfoTask.CodeLanguage</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Defines the supported code languages for generating an AssemblyInfo file. </p>
<h3>Fields</h3>
<div class="table">
@@ -48,7 +49,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.DotNetTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.DotNetTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> RegsvcsTask.ActionType</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>RegsvcsTask.ActionType</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Defines the possible actions for a .NET Service. </p>
<h3>Fields</h3>
<div class="table">
@@ -48,7 +49,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.DotNetTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.DotNetTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> DebugOutput</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>DebugOutput</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Specifies the type of debugging information generated by the compiler. </p>
<p> For backward compatibility, the following string values can also be used in build files: </p>
<div class="table">
@@ -78,7 +79,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.DotNetTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.DotNetTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> ServiceControllerTask.ActionType</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>ServiceControllerTask.ActionType</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Defines the actions that can be performed on a service. </p>
<h3>Fields</h3>
<div class="table">
@@ -56,7 +57,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.MSNetTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.MSNetTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> FormatterType</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>FormatterType</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> The built-in formatter types. </p>
<h3>Fields</h3>
<div class="table">
@@ -44,7 +45,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.NUnit (0.85.2478.0)
<b>Assembly:</b> NAnt.NUnit (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> ClTask.PrecompiledHeaderMode</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>ClTask.PrecompiledHeaderMode</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Defines the supported modes for the use of precompiled header files. </p>
<h3>Fields</h3>
<div class="table">
@@ -48,7 +49,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.VisualCppTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.VisualCppTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<span>Enum Reference</span>
<img alt="-&gt;" src="../images/arrow.gif" /> CharacterSet</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>CharacterSet</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Defines the character sets that can be used by the C++ compiler. </p>
<h3>Fields</h3>
<div class="table">
@@ -48,7 +49,7 @@
</div>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.VisualCppTasks (0.85.2478.0)
<b>Assembly:</b> NAnt.VisualCppTasks (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,15 +19,16 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<a href="../filters/index.html">Filter Reference</a>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;expandproperties&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;expandproperties&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Parses NAnt properties and expressions </p>
<p> This filter parses any NAnt properties or expressions found in its input, inlining their values in its output. </p>
<p> Note: Due to limitations on buffering, expressions longer than 2048 characters are not guaranteed to be expanded. </p> Filters are intended to be used as a element of a <a href="../types/filterchain.html">&lt;filterchain&gt;</a>. <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">if</td><td style="text-align: center;">bool</td><td> If <b>true</b> then the filter will be used; 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 filter will be executed; otherwise, skipped. 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>Replace all properties with their corresponding values.</p><pre class="code">
&lt;expandproperties /&gt;
</pre></li></ul><h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.Core (0.85.2478.0)
</pre></li></ul><h3>Requirements</h3><div style="margin-left: 20px;"><b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div></body>
</html>

View File

@@ -16,14 +16,15 @@
</a>
<img alt="-&gt;" src="../images/arrow.gif" />
<a href="../index.html">Help</a>
<img alt="-&gt;" src="../images/arrow.gif" />
Filter Reference
<img alt="-&gt;" src="../images/arrow.gif" />
Filter Reference
</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>Filter Reference</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<div class="table">
<table>
<tr>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<a href="../filters/index.html">Filter Reference</a>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;replacestring&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;replacestring&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Replaces all occurrences of a given string in the original input with user-supplied replacement string. </p>
<p> This filter replaces all occurrences of a given string in the original input stream with a user-supplied replacement string. By default string comparisons are case sensitive but this can be changed by setting the optional <code>ignorecase</code> attribute to <b>true</b>. </p>
<p> To use this filter specify the string to be replaced with the <code>from</code> attribute and the string to replace it with using the <code>to</code> attribute. </p>
@@ -86,7 +87,7 @@
</ul>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<a href="../filters/index.html">Filter Reference</a>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;replacetokens&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;replacetokens&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Replaces tokens in the original input with user-supplied values. </p>
<p> This filter replaces all token surrounded by a beginning and ending token. The default beginning and ending tokens both default to '@'. The optional <code>begintoken</code> and <code>endtoken</code> attributes can be specified to change either token. By default string comparisons are case sensitive but this can be changed by setting the optional <code>ignorecase</code> attribute to <b>true</b>. </p>
<p> Tokens are specified by using the <a href="../elements/NAnt.Core.Types.Token.html">Token</a> element. It is possible to specify from 1 to n tokens and replacement values. Values can be any valid NAnt expression. </p>
@@ -74,14 +75,14 @@
<!--NestedElementArray=T:NAnt.Core.Types.Token-->
<h4>
<a id="token">
</a>
&lt;token&gt;
</a>
&lt;token&gt;
</h4>
<div class="nested-element"> Tokens and replacement values. <p> ReplaceTokens filter token. </p><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" class="required">key</td><td style="text-align: center;">string</td><td> Token to be replaced. </td><td style="text-align: center;">True</td></tr><tr><td valign="top" class="required">value</td><td style="text-align: center;">string</td><td> New value of token. </td><td style="text-align: center;">True</td></tr><tr><td valign="top">if</td><td style="text-align: center;">bool</td><td> Indicates if the token should be used to replace values. If <b>true</b> then the token will be used; otherwise, not. 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> Indicates if the token should not be used to replace values. If <b>false</b> then the token will be used; otherwise, not. The default is <b>false</b>. </td><td style="text-align: center;">False</td></tr></table></div></div>
<h4>
<a id="token">
</a>
&lt;/token&gt;
</a>
&lt;/token&gt;
</h4>
<h3>Examples</h3>
<ul class="examples">
@@ -104,7 +105,7 @@
</ul>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

View File

@@ -19,11 +19,12 @@
<img alt="-&gt;" src="../images/arrow.gif" />
<a href="../filters/index.html">Filter Reference</a>
<img alt="-&gt;" src="../images/arrow.gif" /> &lt;tabstospaces&gt;</td>
<td class="NavBar-Cell" align="right">
v0.85</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2</td>
</tr>
</table>
<h1>&lt;tabstospaces&gt;</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p> Converts tabs to spaces. </p>
<p> The <a href="../filters/tabstospaces.html">&lt;tabstospaces&gt;</a> filter replaces tabs in a text file with spaces. </p>
<p> Filters are intended to be used as a element of a <a href="../types/filterchain.html">&lt;filterchain&gt;</a>. </p>
@@ -67,7 +68,7 @@
</ul>
<h3>Requirements</h3>
<div style="margin-left: 20px;">
<b>Assembly:</b> NAnt.Core (0.85.2478.0)
<b>Assembly:</b> NAnt.Core (0.91.3881.0)
</div>
</body>
</html>

File diff suppressed because it is too large Load Diff

View File

@@ -1,81 +1,81 @@
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Build Files" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Build Files</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Build Files
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>Build Files</h1>
<p>NAnt's build files are written in XML. Each build file contains one <a href="projects.html">
project</a>&nbsp;and a number of <a href="targets.html">targets</a>.&nbsp;
Each target contains a number of <a href="tasks.html">tasks</a>.</p>
<p>Here is a simple build file that compiles a C# HelloWorld project.&nbsp;
</p>
<pre class="code">
&lt;?xml version="1.0"?&gt;
&lt;project name="Hello World" default="build" basedir="."&gt;
&lt;description&gt;The Hello World of build files.&lt;/description&gt;
&lt;property name="debug" value="true" overwrite="false" /&gt;
&lt;target name="clean" description="remove all generated files"&gt;
&lt;delete file="HelloWorld.exe" failonerror="false" /&gt;
&lt;delete file="HelloWorld.pdb" failonerror="false" /&gt;
&lt;/target&gt;
&lt;target name="build" description="compiles the source code"&gt;
&lt;csc target="exe" output="HelloWorld.exe" debug="${debug}"&gt;
&lt;sources&gt;
&lt;includes name="HelloWorld.cs" /&gt;
&lt;/sources&gt;
&lt;/csc&gt;
&lt;/target&gt;
&lt;/project&gt;
</pre>
<p>In this example there are two targets, "clean" and "build".&nbsp; By default the
"build" target will be called.
</p>
<h3>Examples</h3>
<p>You can find the files you need to try out these examples in the <code>examples</code>
folder that comes with the NAnt distribution.
</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div><pre>nant</pre>
</div>
</blockquote>
<p>Runs NAnt and builds the project in debug mode (the default).</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div><pre>nant clean</pre>
</div>
</blockquote>
<p>Runs NAnt and removes the compiled files if they exist.</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div><pre>nant -D:debug=false</pre>
</div>
</blockquote>
<p>Runs NAnt and builds the project in non-debug mode.&nbsp; Even though the build
file sets the debug property to true, the value that is set on the command line
will not be touched, as the "overwrite" attribute on the
<code><a href="../tasks/property.html">&lt;property&gt;</a></code>
task is set to "false".</p>
<p><strong>Important</strong>: Some tasks like the compiler tasks will only execute
if the date stamp of the generated file is older than the source files.&nbsp;
If you compile HelloWorld project in debug mode and then try to compile it
again in non-debug mode without first cleaning nothing will happen because NAnt
will think the project does not need rebuilding.</p>
</body>
</html>
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Build Files" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Build Files</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Build Files
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>Build Files</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>NAnt's build files are written in XML. Each build file contains one <a href="projects.html">
project</a>&nbsp;and a number of <a href="targets.html">targets</a>.&nbsp;
Each target contains a number of <a href="tasks.html">tasks</a>.</p>
<p>Here is a simple build file that compiles a C# HelloWorld project.&nbsp;
</p>
<pre class="code">
&lt;?xml version="1.0"?&gt;
&lt;project name="Hello World" default="build" basedir="."&gt;
&lt;description&gt;The Hello World of build files.&lt;/description&gt;
&lt;property name="debug" value="true" overwrite="false" /&gt;
&lt;target name="clean" description="remove all generated files"&gt;
&lt;delete file="HelloWorld.exe" failonerror="false" /&gt;
&lt;delete file="HelloWorld.pdb" failonerror="false" /&gt;
&lt;/target&gt;
&lt;target name="build" description="compiles the source code"&gt;
&lt;csc target="exe" output="HelloWorld.exe" debug="${debug}"&gt;
&lt;sources&gt;
&lt;includes name="HelloWorld.cs" /&gt;
&lt;/sources&gt;
&lt;/csc&gt;
&lt;/target&gt;
&lt;/project&gt;
</pre>
<p>In this example there are two targets, "clean" and "build".&nbsp; By default the
"build" target will be called.
</p>
<h3>Examples</h3>
<p>You can find the files you need to try out these examples in the <code>examples</code>
folder that comes with the NAnt distribution.
</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div><pre>nant</pre>
</div>
</blockquote>
<p>Runs NAnt and builds the project in debug mode (the default).</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div><pre>nant clean</pre>
</div>
</blockquote>
<p>Runs NAnt and removes the compiled files if they exist.</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div><pre>nant -D:debug=false</pre>
</div>
</blockquote>
<p>Runs NAnt and builds the project in non-debug mode.&nbsp; Even though the build
file sets the debug property to true, the value that is set on the command line
will not be touched, as the "overwrite" attribute on the
<code><a href="../tasks/property.html">&lt;property&gt;</a></code>
task is set to "false".</p>
<p><strong>Important</strong>: Some tasks like the compiler tasks will only execute
if the date stamp of the generated file is older than the source files.&nbsp;
If you compile HelloWorld project in debug mode and then try to compile it
again in non-debug mode without first cleaning nothing will happen because NAnt
will think the project does not need rebuilding.</p>
</body>
</html>

File diff suppressed because it is too large Load Diff

View File

@@ -1,311 +1,311 @@
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Functions" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Functions</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Functions
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>Functions</h1>
<p>NAnt provides a rich set of bulitin functions, that allow you to:</p>
<ul>
<li>
manipulate strings</li>
<li>
manipulate date/time values</li>
<li>
manipulate path names</li>
<li>
read the properties of files/directories</li>
<li>
access current build information and more</li>
<li>
and more</li>
</ul>
<p>For a full list of supported functions, click <a href="../functions/index.html">here</a>.</p>
<h3><a id="syntax" />Function Call Syntax</h3>
<p>
To call functions, use <code>prefix::function-name(argument1, ..., argumentN)</code>
syntax within expressions. NAnt will (implicitly) try to convert the arguments
you pass to functions to correct types and will report an error in case of
failure.
</p>
<p>
For example, assuming you would like to call <code>string::contains('0123456789',1)</code>
which expects two <code>string</code> parameters, but you want to pass the
second parameter which is an integer. NAnt would attempt to convert the second
parameter from <code>int</code> to <code>string</code>, which succeeds and
function is called as if it was written as <code>string::contains('0123456789','1')</code>.
</p>
<p>The following table shows the possible type conversions:</p>
<div class="table">
<table>
<tr>
<th>
From Type</th>
<th>
To Type</th>
<th>
Allowed</th>
<th>
Remarks</th>
</tr>
<tr>
<td><code>int</code></td>
<td><code>string</code></td>
<td>Yes</td>
<td>The conversion is always possible.</td>
</tr>
<tr>
<td><code>int</code></td>
<td><code>double</code></td>
<td>Yes</td>
<td>The conversion is always possible.</td>
</tr>
<tr>
<td><code>int</code></td>
<td><code>boolean</code></td>
<td>No</td>
<td>Can be done with the <code>if()</code> conditional operator or simply as <code>(value
&lt;&gt; 0)</code></td>
</tr>
<tr>
<td><code>int</code></td>
<td><code>datetime</code></td>
<td>No</td>
<td>You cannot convert from <code>int</code> to <code>datetime</code>.</td>
</tr>
<tr>
<td><code>int</code></td>
<td><code>timespan</code></td>
<td>No</td>
<td>You can use the <code>timespan::from-xxx</code> functions to construct a <code>timespan</code> from a given number of days, months, ....</td>
</tr>
<tr>
<th colspan="4">
</th>
</tr>
<tr>
<td><code>string</code></td>
<td><code>int</code></td>
<td>Yes</td>
<td>If the string doesn't represent an integer value, an error is reported.</td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>double</code></td>
<td>Yes</td>
<td>If the string doesn't represent a floating point value, an error is reported.</td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>boolean</code></td>
<td>Yes</td>
<td>If the string isn't either <code>true</code> or <code>false</code> (case
insensitive), an error is reported.</td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>datetime</code></td>
<td>Yes</td>
<td>If the string doesn't represent a valid date/time, an error is reported.
Date/time string format is <code>MM/DD/YYYY&nbsp;HH:MI:SS</code></td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>timespan</code></td>
<td>No</td>
<td>
You can use <code>timespan::parse</code> to construct a <code>timespan</code>
from a time indicated by a given string. If the string doesn't represent a valid
timespan, an error is reported.
</td>
</tr>
<tr>
<th colspan="4">
</th>
</tr>
<tr>
<td><code>double</code></td>
<td><code>int</code></td>
<td>Yes</td>
<td>If the string doesn't represent an integer value, an error is reported.</td>
</tr>
<tr>
<td><code>double</code></td>
<td><code>string</code></td>
<td>Yes</td>
<td>The converted string uses dot as a fractional part separator so the result
looks like <code>0.1234567</code></td>
</tr>
<tr>
<td><code>double</code></td>
<td><code>boolean</code></td>
<td>No</td>
<td>You cannot convert from <code>double</code> to <code>boolean</code>.</td>
</tr>
<tr>
<td><code>double</code></td>
<td><code>datetime</code></td>
<td>No</td>
<td>You cannot convert from <code>double</code> to <code>datetime</code>.</td>
</tr>
<tr>
<td><code>double</code></td>
<td><code>timespan</code></td>
<td>No</td>
<td>You can use the <code>timespan::from-xxx</code> functions to construct a <code>timespan</code> from a given number of days, months, ....</td>
</tr>
<tr>
<th colspan="4">
</th>
</tr>
<tr>
<td><code>boolean</code></td>
<td><code>int</code></td>
<td>No</td>
<td>You cannot convert from <code>boolean</code> to <code>int</code>. You may
want to use <code>if(boolvalue,1,0)</code> instead.</td>
</tr>
<tr>
<td><code>boolean</code></td>
<td><code>string</code></td>
<td>Yes</td>
<td>The result is <code>'True'</code> or <code>'False'</code> string.</td>
</tr>
<tr>
<td><code>boolean</code></td>
<td><code>double</code></td>
<td>No</td>
<td>You cannot convert from <code>boolean</code> to <code>double</code>.</td>
</tr>
<tr>
<td><code>boolean</code></td>
<td><code>datetime</code></td>
<td>No</td>
<td>You cannot convert from <code>boolean</code> to <code>datetime</code>.</td>
</tr>
<tr>
<td><code>boolean</code></td>
<td><code>timespan</code></td>
<td>No</td>
<td>You cannot convert from <code>boolean</code> to <code>timespan</code>.</td>
</tr>
<tr>
<th colspan="4">
</th>
</tr>
<tr>
<td><code>datetime</code></td>
<td><code>int</code></td>
<td>No</td>
<td>You cannot convert from <code>datetime</code> to <code>int</code>.</td>
</tr>
<tr>
<td><code>datetime</code></td>
<td><code>string</code></td>
<td>Yes</td>
<td>The result is a datetime string with the following format: <code>MM/DD/YYYY&nbsp;HH:MI:SS</code></td>
</tr>
<tr>
<td><code>datetime</code></td>
<td><code>double</code></td>
<td>No</td>
<td>You cannot convert from <code>datetime</code> to <code>double</code>.</td>
</tr>
<tr>
<td><code>datetime</code></td>
<td><code>boolean</code></td>
<td>No</td>
<td>You cannot convert from <code>datetime</code> to <code>boolean</code>.</td>
</tr>
<tr>
<td><code>datetime</code></td>
<td><code>timespan</code></td>
<td>No</td>
<td>You can use the value of <code>datetime::get-ticks</code> to construct a <code>timespan</code> using <code>timespan::from-ticks</code>.</td>
</tr>
<tr>
<th colspan="4">
</th>
</tr>
<tr>
<td><code>timespan</code></td>
<td><code>int</code></td>
<td>No</td>
<td>You cannot convert from <code>timespan</code> to <code>int</code>.</td>
</tr>
<tr>
<td><code>timespan</code></td>
<td><code>double</code></td>
<td>No</td>
<td>You can use <code>timespan::get-ticks</code> to convert from <code>timespan</code> to <code>double</code>.</td>
</tr>
<tr>
<td><code>timespan</code></td>
<td><code>boolean</code></td>
<td>No</td>
<td>You cannot convert from <code>timespan</code> to <code>boolean</code>.</td>
</tr>
<tr>
<td><code>timespan</code></td>
<td><code>string</code></td>
<td>No</td>
<td>You can use <code>timespan::to-string</code> to obtain the string representation of a <code>timespan</code>.</td>
</tr>
<tr>
<td><code>timespan</code></td>
<td><code>datetime</code></td>
<td>No</td>
<td>You cannot convert from <code>timespan</code> to <code>datetime</code>.</td>
</tr>
</table>
</div>
<h3><a id="custom" />Custom Functions</h3>
<p>
Just as you can extend NAnt with your own tasks it is also possible to
implement your own functions for use in build files.</p>
<p>Functions can be implemented in any .NET language and are loaded in the same
manner as tasks. ie either by locating your custom function assembly in the
NAnt bin directory or using the <code><a href="../tasks/loadtasks.html">&lt;loadtasks&gt;</a></code>
task. Example C# code for a Hello World function :
</p>
<p>Define a custom function using C#.</p>
<pre class="code">
[FunctionSet("hello", "Hello")]
public class HelloFunctions : FunctionSetBase {
public HelloFunctions(Project project, PropertyDictionary properties) : base(project, properties) {
}
[Function("hello-world")]
public static string HelloWorldfunc() {
return "Hello World!!";
}
}
</pre>
<p>and call that function from a build file.</p>
<pre class="code">
&lt;echo message="${hello::hello-world()}" /&gt;
</pre>
<p>A quick and easy way to develop new functions is to use the <code><a href="../tasks/script.html">
&lt;script&gt;</a></code> task. This allows you to create and test new functions
without the overhead of building an external assembly. The <code><a href="../tasks/script.html">
&lt;script&gt;</a></code> task documentation contains examples of custom function
definitions.</p>
</body>
</html>
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Functions" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Functions</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Functions
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>Functions</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>NAnt provides a rich set of bulitin functions, that allow you to:</p>
<ul>
<li>
manipulate strings</li>
<li>
manipulate date/time values</li>
<li>
manipulate path names</li>
<li>
read the properties of files/directories</li>
<li>
access current build information and more</li>
<li>
and more</li>
</ul>
<p>For a full list of supported functions, click <a href="../functions/index.html">here</a>.</p>
<h3><a id="syntax" />Function Call Syntax</h3>
<p>
To call functions, use <code>prefix::function-name(argument1, ..., argumentN)</code>
syntax within expressions. NAnt will (implicitly) try to convert the arguments
you pass to functions to correct types and will report an error in case of
failure.
</p>
<p>
For example, assuming you would like to call <code>string::contains('0123456789',1)</code>
which expects two <code>string</code> parameters, but you want to pass the
second parameter which is an integer. NAnt would attempt to convert the second
parameter from <code>int</code> to <code>string</code>, which succeeds and
function is called as if it was written as <code>string::contains('0123456789','1')</code>.
</p>
<p>The following table shows the possible type conversions:</p>
<div class="table">
<table>
<tr>
<th>
From Type</th>
<th>
To Type</th>
<th>
Allowed</th>
<th>
Remarks</th>
</tr>
<tr>
<td><code>int</code></td>
<td><code>string</code></td>
<td>Yes</td>
<td>The conversion is always possible.</td>
</tr>
<tr>
<td><code>int</code></td>
<td><code>double</code></td>
<td>Yes</td>
<td>The conversion is always possible.</td>
</tr>
<tr>
<td><code>int</code></td>
<td><code>boolean</code></td>
<td>No</td>
<td>Can be done with the <code>if()</code> conditional operator or simply as <code>(value
&lt;&gt; 0)</code></td>
</tr>
<tr>
<td><code>int</code></td>
<td><code>datetime</code></td>
<td>No</td>
<td>You cannot convert from <code>int</code> to <code>datetime</code>.</td>
</tr>
<tr>
<td><code>int</code></td>
<td><code>timespan</code></td>
<td>No</td>
<td>You can use the <code>timespan::from-xxx</code> functions to construct a <code>timespan</code> from a given number of days, months, ....</td>
</tr>
<tr>
<th colspan="4">
</th>
</tr>
<tr>
<td><code>string</code></td>
<td><code>int</code></td>
<td>Yes</td>
<td>If the string doesn't represent an integer value, an error is reported.</td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>double</code></td>
<td>Yes</td>
<td>If the string doesn't represent a floating point value, an error is reported.</td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>boolean</code></td>
<td>Yes</td>
<td>If the string isn't either <code>true</code> or <code>false</code> (case
insensitive), an error is reported.</td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>datetime</code></td>
<td>Yes</td>
<td>If the string doesn't represent a valid date/time, an error is reported.
Date/time string format is <code>MM/DD/YYYY&nbsp;HH:MI:SS</code></td>
</tr>
<tr>
<td><code>string</code></td>
<td><code>timespan</code></td>
<td>No</td>
<td>
You can use <code>timespan::parse</code> to construct a <code>timespan</code>
from a time indicated by a given string. If the string doesn't represent a valid
timespan, an error is reported.
</td>
</tr>
<tr>
<th colspan="4">
</th>
</tr>
<tr>
<td><code>double</code></td>
<td><code>int</code></td>
<td>Yes</td>
<td>If the string doesn't represent an integer value, an error is reported.</td>
</tr>
<tr>
<td><code>double</code></td>
<td><code>string</code></td>
<td>Yes</td>
<td>The converted string uses dot as a fractional part separator so the result
looks like <code>0.1234567</code></td>
</tr>
<tr>
<td><code>double</code></td>
<td><code>boolean</code></td>
<td>No</td>
<td>You cannot convert from <code>double</code> to <code>boolean</code>.</td>
</tr>
<tr>
<td><code>double</code></td>
<td><code>datetime</code></td>
<td>No</td>
<td>You cannot convert from <code>double</code> to <code>datetime</code>.</td>
</tr>
<tr>
<td><code>double</code></td>
<td><code>timespan</code></td>
<td>No</td>
<td>You can use the <code>timespan::from-xxx</code> functions to construct a <code>timespan</code> from a given number of days, months, ....</td>
</tr>
<tr>
<th colspan="4">
</th>
</tr>
<tr>
<td><code>boolean</code></td>
<td><code>int</code></td>
<td>No</td>
<td>You cannot convert from <code>boolean</code> to <code>int</code>. You may
want to use <code>if(boolvalue,1,0)</code> instead.</td>
</tr>
<tr>
<td><code>boolean</code></td>
<td><code>string</code></td>
<td>Yes</td>
<td>The result is <code>'True'</code> or <code>'False'</code> string.</td>
</tr>
<tr>
<td><code>boolean</code></td>
<td><code>double</code></td>
<td>No</td>
<td>You cannot convert from <code>boolean</code> to <code>double</code>.</td>
</tr>
<tr>
<td><code>boolean</code></td>
<td><code>datetime</code></td>
<td>No</td>
<td>You cannot convert from <code>boolean</code> to <code>datetime</code>.</td>
</tr>
<tr>
<td><code>boolean</code></td>
<td><code>timespan</code></td>
<td>No</td>
<td>You cannot convert from <code>boolean</code> to <code>timespan</code>.</td>
</tr>
<tr>
<th colspan="4">
</th>
</tr>
<tr>
<td><code>datetime</code></td>
<td><code>int</code></td>
<td>No</td>
<td>You cannot convert from <code>datetime</code> to <code>int</code>.</td>
</tr>
<tr>
<td><code>datetime</code></td>
<td><code>string</code></td>
<td>Yes</td>
<td>The result is a datetime string with the following format: <code>MM/DD/YYYY&nbsp;HH:MI:SS</code></td>
</tr>
<tr>
<td><code>datetime</code></td>
<td><code>double</code></td>
<td>No</td>
<td>You cannot convert from <code>datetime</code> to <code>double</code>.</td>
</tr>
<tr>
<td><code>datetime</code></td>
<td><code>boolean</code></td>
<td>No</td>
<td>You cannot convert from <code>datetime</code> to <code>boolean</code>.</td>
</tr>
<tr>
<td><code>datetime</code></td>
<td><code>timespan</code></td>
<td>No</td>
<td>You can use the value of <code>datetime::get-ticks</code> to construct a <code>timespan</code> using <code>timespan::from-ticks</code>.</td>
</tr>
<tr>
<th colspan="4">
</th>
</tr>
<tr>
<td><code>timespan</code></td>
<td><code>int</code></td>
<td>No</td>
<td>You cannot convert from <code>timespan</code> to <code>int</code>.</td>
</tr>
<tr>
<td><code>timespan</code></td>
<td><code>double</code></td>
<td>No</td>
<td>You can use <code>timespan::get-ticks</code> to convert from <code>timespan</code> to <code>double</code>.</td>
</tr>
<tr>
<td><code>timespan</code></td>
<td><code>boolean</code></td>
<td>No</td>
<td>You cannot convert from <code>timespan</code> to <code>boolean</code>.</td>
</tr>
<tr>
<td><code>timespan</code></td>
<td><code>string</code></td>
<td>No</td>
<td>You can use <code>timespan::to-string</code> to obtain the string representation of a <code>timespan</code>.</td>
</tr>
<tr>
<td><code>timespan</code></td>
<td><code>datetime</code></td>
<td>No</td>
<td>You cannot convert from <code>timespan</code> to <code>datetime</code>.</td>
</tr>
</table>
</div>
<h3><a id="custom" />Custom Functions</h3>
<p>
Just as you can extend NAnt with your own tasks it is also possible to
implement your own functions for use in build files.</p>
<p>Functions can be implemented in any .NET language and are loaded in the same
manner as tasks. ie either by locating your custom function assembly in the
NAnt bin directory or using the <code><a href="../tasks/loadtasks.html">&lt;loadtasks&gt;</a></code>
task. Example C# code for a Hello World function :
</p>
<p>Define a custom function using C#.</p>
<pre class="code">
[FunctionSet("hello", "Hello")]
public class HelloFunctions : FunctionSetBase {
public HelloFunctions(Project project, PropertyDictionary properties) : base(project, properties) {
}
[Function("hello-world")]
public static string HelloWorldfunc() {
return "Hello World!!";
}
}
</pre>
<p>and call that function from a build file.</p>
<pre class="code">
&lt;echo message="${hello::hello-world()}" /&gt;
</pre>
<p>A quick and easy way to develop new functions is to use the <code><a href="../tasks/script.html">
&lt;script&gt;</a></code> task. This allows you to create and test new functions
without the overhead of building an external assembly. The <code><a href="../tasks/script.html">
&lt;script&gt;</a></code> task documentation contains examples of custom function
definitions.</p>
</body>
</html>

View File

@@ -1,35 +1,35 @@
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Fundamentals" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Fundamentals</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> Fundamentals
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>Fundamentals</h1>
<p>The basic concepts needed to understand and use NAnt.</p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="running-nant.html">Running NAnt</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="buildfiles.html">Build Files</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="projects.html">Projects</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="targets.html">Targets</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="tasks.html">Tasks</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="properties.html">Properties</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="listeners.html">Loggers &amp; Listeners</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="expressions.html">Expressions</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="functions.html">Functions</a></p>
</body>
</html>
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Fundamentals" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Fundamentals</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> Fundamentals
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>Fundamentals</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>The basic concepts needed to understand and use NAnt.</p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="running-nant.html">Running NAnt</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="buildfiles.html">Build Files</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="projects.html">Projects</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="targets.html">Targets</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="tasks.html">Tasks</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="properties.html">Properties</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="listeners.html">Loggers &amp; Listeners</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="expressions.html">Expressions</a></p>
<p><img alt=">" src="../images/bullet.gif" /> <a href="functions.html">Functions</a></p>
</body>
</html>

View File

@@ -1,318 +1,318 @@
<!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">
<head>
<title>NAnt - Loggers &amp; Listeners</title>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Loggers &amp; Listeners" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<style type="text/css">
.xmlelement {
color: #660000;
}
.xmlattribute {
color: red;
}
.xmltext {
color: blue;
}
.xmlcomment {
color: green;
}
.xmlcdata {
color: #FF00CC;
}
</style>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="->" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="->" src="../images/arrow.gif"/> <a href="index.html">
Fundamentals</a> <img height="9" alt="->" src="../images/arrow.gif" width="13" />
Loggers &amp; Listeners
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>Loggers &amp; Listeners</h1>
<h2>Overview</h2>
<p>
NAnt has two related features to allow the build process to be monitored:
listeners and loggers.
</p>
<h3>Listeners</h3>
<p>
A listener is alerted of the following events:
</p>
<ul>
<li>
build started
</li>
<li>
build finished
</li>
<li>
target started
</li>
<li>
target finished
</li>
<li>
task started
</li>
<li>
task finished
</li>
<li>
message logged</li>
</ul>
<h3>Loggers</h3>
<p>
Loggers extend the capabilities of listeners and add the following features:
</p>
<ul>
<li>
Receives a handle to the standard output and error print streams and therefore
can log information to the console or the <code>-logfile</code>
specified file.
</li>
<li>
Logging level (<code>-quiet</code>, <code>-verbose</code>, <code>-debug</code>)
aware.
</li>
<li>
Emacs-mode aware. This still needs to be implemented.
</li>
</ul>
<h2>Built-in Listeners/Loggers</h2>
<div class="table">
<table>
<colgroup>
<col />
<col />
<col style="TEXT-ALIGN: center" />
</colgroup>
<tbody>
<tr>
<th>
Class</th>
<th>
Description</th>
<th>
Type</th>
</tr>
<tr>
<td><a href="#DefaultLogger">NAnt.Core.DefaultLogger</a></td>
<td>
The logger used implicitly unless overridden with the <code>-logger</code> command-line
switch.
</td>
<td>IBuildLogger</td>
</tr>
<tr>
<td><a href="#MailLogger">NAnt.Core.MailLogger</a></td>
<td>
Extends <a href="#DefaultLogger">DefaultLogger</a> such that output is still
generated the same, and when the build is finished an e-mail can be sent.
</td>
<td>IBuildLogger</td>
</tr>
<tr>
<td><a href="#XmlLogger">NAnt.Core.XmlLogger</a></td>
<td>
Generates output in XML format.
</td>
<td>IBuildLogger</td>
</tr>
</tbody>
</table>
</div>
<h3><a id="DefaultLogger" />DefaultLogger</h3>
<p>Simply run NAnt normally, or:</p>
<blockquote>
<p><code>NAnt.exe -logger:NAnt.Core.DefaultLogger</code></p>
</blockquote>
<h3><a id="MailLogger" />MailLogger</h3>
<p>
The MailLogger captures all output logged through DefaultLogger (standard NAnt
output) and will send success and failure messages to unique e-mail lists, with
control for turning off success or failure messages individually.
</p>
<p>Properties controlling the operation of MailLogger are:</p>
<div class="table">
<table>
<colgroup>
<col />
<col />
<col />
</colgroup>
<tbody>
<tr>
<th>
Property</th>
<th>
Description</th>
<th>
Required</th>
</tr>
<tr>
<td>MailLogger.mailhost</td>
<td>The SMTP server to use.</td>
<td>No, default is "localhost"</td>
</tr>
<tr>
<td>MailLogger.from</td>
<td>The address of the e-mail sender.</td>
<td>Yes, if mail needs to be sent.</td>
</tr>
<tr>
<td>MailLogger.failure.notify</td>
<td>Send build failure e-mails ?</td>
<td>No, default is "true".</td>
</tr>
<tr>
<td>MailLogger.success.notify</td>
<td>Send build success e-mails ?</td>
<td>No, default is "true".</td>
</tr>
<tr>
<td>MailLogger.failure.to</td>
<td>The address to send build failure messages to.</td>
<td>Yes, if failure mail is to be sent.</td>
</tr>
<tr>
<td>MailLogger.success.to</td>
<td>The address to send build success messages to.</td>
<td>Yes, if success mail is to be sent.</td>
</tr>
<tr>
<td>MailLogger.failure.subject</td>
<td>The subject of build failure messages.</td>
<td>No, default is "Build Failure".</td>
</tr>
<tr>
<td>MailLogger.success.subject</td>
<td>The subject of build success messages.</td>
<td>No, default is "Build Success".</td>
</tr>
<tr>
<td>MailLogger.failure.attachments</td>
<td>The ID of a fileset representing a set of files to attach when the build fails.</td>
<td>No.</td>
</tr>
<tr>
<td>MailLogger.success.attachments</td>
<td>The ID of a fileset representing a set of files to attach when the build is successful.</td>
<td>No.</td>
</tr>
<tr>
<td>MailLogger.body.encoding</td>
<td>The encoding type of the body of the e-mail message.</td>
<td>No, default is system's ANSI code page.</td>
</tr>
<tr>
<td>MailLogger.smtp.username<sup>1</sup></td>
<td>The name of the user to login to the SMTP server.</td>
<td>No.</td>
</tr>
<tr>
<td>MailLogger.smtp.password<sup>1</sup></td>
<td>The password of the specified user.</td>
<td>No.</td>
</tr>
<tr>
<td>MailLogger.smtp.enablessl<sup>1</sup></td>
<td>Specifies whether to use SSL to encrypt the connection.</td>
<td>No, default is "false".</td>
</tr>
<tr>
<td>MailLogger.smtp.port<sup>1</sup></td>
<td>The SMTP server port to connect to.</td>
<td>No, default is "25".</td>
</tr>
</tbody>
</table>
<p><sup>1</sup> Only available when NAnt is built targeting .NET Framework 1.1 (or equivalent) or higher.</p>
</div>
<p>Usage:</p>
<blockquote>
<p><code>NAnt.exe -logger:NAnt.Core.MailLogger</code></p>
</blockquote>
<p>Example:</p>
<pre class="code">
<span class="xmltext">&lt;</span><span class="xmlelement">project</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger Test"</span> <span class="xmlattribute">default</span><span class="xmltext">="build"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.mailhost"</span> <span class="xmlattribute">value</span><span class="xmltext">="smtp.wherever.be" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.from"</span> <span class="xmlattribute">value</span><span class="xmltext">="me@telenet.be" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.failure.notify"</span> <span class="xmlattribute">value</span><span class="xmltext">="true" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.success.notify"</span> <span class="xmlattribute">value</span><span class="xmltext">="true" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.failure.to"</span> <span class="xmlattribute">value</span><span class="xmltext">="support@home.be" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.success.to"</span> <span class="xmlattribute">value</span><span class="xmltext">="support@home.be" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.failure.subject"</span> <span class="xmlattribute">value</span><span class="xmltext">="Nightly build failure !" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.success.subject"</span> <span class="xmlattribute">value</span><span class="xmltext">="Nightly build successful" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.failure.attachments"</span> <span class="xmlattribute">value</span><span class="xmltext">="MailLogger.failure.files" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.success.attachments"</span> <span class="xmlattribute">value</span><span class="xmltext">="MailLogger.success.files" /&gt;</span>
<span class="xmlcomment">&lt;!-- set of files to attach when build fails --&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">fileset</span> <span class="xmlattribute">id</span><span class="xmltext">="MailLogger.failure.files"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">include</span> <span class="xmlattribute">name</span><span class="xmltext">="dump.log" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">include</span> <span class="xmlattribute">name</span><span class="xmltext">="trace.txt" /&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">fileset</span><span class="xmltext">&gt;</span>
<span class="xmlcomment">&lt;!-- set of files to attach when build is successful --&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">fileset</span> <span class="xmlattribute">id</span><span class="xmltext">="MailLogger.success.files"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">include</span> <span class="xmlattribute">name</span><span class="xmltext">="trace.txt" /&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">fileset</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">target</span> <span class="xmlattribute">name</span><span class="xmltext">="build"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">echo</span> <span class="xmlattribute">message</span><span class="xmltext">=&quot;Starting build&quot; /&gt;</span>
....
<span class="xmltext">&lt;</span><span class="xmlelement">echo</span> <span class="xmlattribute">message</span><span class="xmltext">=&quot;Finished build&quot; /&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">target</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">project</span><span class="xmltext">&gt;</span>
</pre>
<h3><a id="XmlLogger" />XmlLogger</h3>
<p>
Writes all build information out to an XML file named <code>log.xml</code>, or
the value of the <code>XmlLogger.file</code> property if present, when used as
a listener. When used as a logger, it writes all output to either the console
or to the value of <code>-logfile</code>.
</p>
<p>
Whether used as a listener or logger, the output is not generated until the
build is complete.
</p>
<p>Usage:</p>
<blockquote>
<p>
<code>NAnt.exe -listener:NAnt.Core.XmlLogger</code><br />
<code>NAnt.exe -logger:NAnt.Core.XmlLogger -logfile:buildlog.xml</code>
</p>
</blockquote>
<p>Example:</p>
<pre class="code">
<span class="xmltext">&lt;</span><span class="xmlelement">buildresults</span> <span class="xmlattribute">project</span><span class="xmltext">="test"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">message</span> <span class="xmlattribute">level</span><span class="xmltext">="Info"&gt;&lt;![</span><span class="xmlcdata">CDATA[Buildfile: file:///D:/nant-test/xmlpeek/default.build]]</span><span class="xmltext">&gt;&lt;/</span><span class="xmlelement">message</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">message</span> <span class="xmlattribute">level</span><span class="xmltext">="Info"&gt;&lt;![</span><span class="xmlcdata">CDATA[Target framework: Microsoft .NET Framework 1.1]]</span><span class="xmltext">&gt;&lt;/</span><span class="xmlelement">message</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">message</span> <span class="xmlattribute">level</span><span class="xmltext">="Info"&gt;&lt;![</span><span class="xmlcdata">CDATA[Target<span class="xmltext">(</span>s<span class="xmltext">)</span> specified: build]]</span><span class="xmltext">&gt;&lt;/</span><span class="xmlelement">message</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">target</span> <span class="xmlattribute">name</span><span class="xmltext">="build"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">task</span> <span class="xmlattribute">name</span><span class="xmltext">="xmlpeek"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">message</span> <span class="xmlattribute">level</span><span class="xmltext">="Info"&gt;&lt;![</span><span class="xmlcdata">CDATA[Peeking at <span class="xmltext">'D:\nant-test\xmlpeek\input.xml'</span> with XPath expression <span class="xmltext">'x:parameters/x:param'</span>.]]</span><span class="xmltext">&gt;&lt;/</span><span class="xmlelement">message</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">message</span> <span class="xmlattribute">level</span><span class="xmltext">="Info"&gt;&lt;![</span><span class="xmlcdata">CDATA[Found <span class="xmltext">'1'</span> nodes with the XPath expression <span class="xmltext">'x:parameters/x:param'</span>.]]</span><span class="xmltext">&gt;&lt;/</span><span class="xmlelement">message</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span><span style="color: black;">15.625</span><span class="xmltext">&lt;/</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">task</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span><span style="color: black;">15.625</span><span class="xmltext">&lt;/</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">target</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span><span style="color: black;">31.25</span><span class="xmltext">&lt;/</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">buildresults</span><span class="xmltext">&gt;</span>
</pre>
</body>
</html>
<!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">
<head>
<title>NAnt - Loggers &amp; Listeners</title>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Loggers &amp; Listeners" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<style type="text/css">
.xmlelement {
color: #660000;
}
.xmlattribute {
color: red;
}
.xmltext {
color: blue;
}
.xmlcomment {
color: green;
}
.xmlcdata {
color: #FF00CC;
}
</style>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="->" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="->" src="../images/arrow.gif"/> <a href="index.html">
Fundamentals</a> <img height="9" alt="->" src="../images/arrow.gif" width="13" />
Loggers &amp; Listeners
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>Loggers &amp; Listeners</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<h2>Overview</h2>
<p>
NAnt has two related features to allow the build process to be monitored:
listeners and loggers.
</p>
<h3>Listeners</h3>
<p>
A listener is alerted of the following events:
</p>
<ul>
<li>
build started
</li>
<li>
build finished
</li>
<li>
target started
</li>
<li>
target finished
</li>
<li>
task started
</li>
<li>
task finished
</li>
<li>
message logged</li>
</ul>
<h3>Loggers</h3>
<p>
Loggers extend the capabilities of listeners and add the following features:
</p>
<ul>
<li>
Receives a handle to the standard output and error print streams and therefore
can log information to the console or the <code>-logfile</code>
specified file.
</li>
<li>
Logging level (<code>-quiet</code>, <code>-verbose</code>, <code>-debug</code>)
aware.
</li>
<li>
Emacs-mode aware. This still needs to be implemented.
</li>
</ul>
<h2>Built-in Listeners/Loggers</h2>
<div class="table">
<table>
<colgroup>
<col />
<col />
<col style="TEXT-ALIGN: center" />
</colgroup>
<tbody>
<tr>
<th>
Class</th>
<th>
Description</th>
<th>
Type</th>
</tr>
<tr>
<td><a href="#DefaultLogger">NAnt.Core.DefaultLogger</a></td>
<td>
The logger used implicitly unless overridden with the <code>-logger</code> command-line
switch.
</td>
<td>IBuildLogger</td>
</tr>
<tr>
<td><a href="#MailLogger">NAnt.Core.MailLogger</a></td>
<td>
Extends <a href="#DefaultLogger">DefaultLogger</a> such that output is still
generated the same, and when the build is finished an e-mail can be sent.
</td>
<td>IBuildLogger</td>
</tr>
<tr>
<td><a href="#XmlLogger">NAnt.Core.XmlLogger</a></td>
<td>
Generates output in XML format.
</td>
<td>IBuildLogger</td>
</tr>
</tbody>
</table>
</div>
<h3><a id="DefaultLogger" />DefaultLogger</h3>
<p>Simply run NAnt normally, or:</p>
<blockquote>
<p><code>NAnt.exe -logger:NAnt.Core.DefaultLogger</code></p>
</blockquote>
<h3><a id="MailLogger" />MailLogger</h3>
<p>
The MailLogger captures all output logged through DefaultLogger (standard NAnt
output) and will send success and failure messages to unique e-mail lists, with
control for turning off success or failure messages individually.
</p>
<p>Properties controlling the operation of MailLogger are:</p>
<div class="table">
<table>
<colgroup>
<col />
<col />
<col />
</colgroup>
<tbody>
<tr>
<th>
Property</th>
<th>
Description</th>
<th>
Required</th>
</tr>
<tr>
<td>MailLogger.mailhost</td>
<td>The SMTP server to use.</td>
<td>No, default is "localhost"</td>
</tr>
<tr>
<td>MailLogger.from</td>
<td>The address of the e-mail sender.</td>
<td>Yes, if mail needs to be sent.</td>
</tr>
<tr>
<td>MailLogger.failure.notify</td>
<td>Send build failure e-mails ?</td>
<td>No, default is "true".</td>
</tr>
<tr>
<td>MailLogger.success.notify</td>
<td>Send build success e-mails ?</td>
<td>No, default is "true".</td>
</tr>
<tr>
<td>MailLogger.failure.to</td>
<td>The address to send build failure messages to.</td>
<td>Yes, if failure mail is to be sent.</td>
</tr>
<tr>
<td>MailLogger.success.to</td>
<td>The address to send build success messages to.</td>
<td>Yes, if success mail is to be sent.</td>
</tr>
<tr>
<td>MailLogger.failure.subject</td>
<td>The subject of build failure messages.</td>
<td>No, default is "Build Failure".</td>
</tr>
<tr>
<td>MailLogger.success.subject</td>
<td>The subject of build success messages.</td>
<td>No, default is "Build Success".</td>
</tr>
<tr>
<td>MailLogger.failure.attachments</td>
<td>The ID of a fileset representing a set of files to attach when the build fails.</td>
<td>No.</td>
</tr>
<tr>
<td>MailLogger.success.attachments</td>
<td>The ID of a fileset representing a set of files to attach when the build is successful.</td>
<td>No.</td>
</tr>
<tr>
<td>MailLogger.body.encoding</td>
<td>The encoding type of the body of the e-mail message.</td>
<td>No, default is system's ANSI code page.</td>
</tr>
<tr>
<td>MailLogger.smtp.username<sup>1</sup></td>
<td>The name of the user to login to the SMTP server.</td>
<td>No.</td>
</tr>
<tr>
<td>MailLogger.smtp.password<sup>1</sup></td>
<td>The password of the specified user.</td>
<td>No.</td>
</tr>
<tr>
<td>MailLogger.smtp.enablessl<sup>1</sup></td>
<td>Specifies whether to use SSL to encrypt the connection.</td>
<td>No, default is "false".</td>
</tr>
<tr>
<td>MailLogger.smtp.port<sup>1</sup></td>
<td>The SMTP server port to connect to.</td>
<td>No, default is "25".</td>
</tr>
</tbody>
</table>
<p><sup>1</sup> Only available when NAnt is built targeting .NET Framework 1.1 (or equivalent) or higher.</p>
</div>
<p>Usage:</p>
<blockquote>
<p><code>NAnt.exe -logger:NAnt.Core.MailLogger</code></p>
</blockquote>
<p>Example:</p>
<pre class="code">
<span class="xmltext">&lt;</span><span class="xmlelement">project</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger Test"</span> <span class="xmlattribute">default</span><span class="xmltext">="build"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.mailhost"</span> <span class="xmlattribute">value</span><span class="xmltext">="smtp.wherever.be" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.from"</span> <span class="xmlattribute">value</span><span class="xmltext">="me@telenet.be" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.failure.notify"</span> <span class="xmlattribute">value</span><span class="xmltext">="true" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.success.notify"</span> <span class="xmlattribute">value</span><span class="xmltext">="true" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.failure.to"</span> <span class="xmlattribute">value</span><span class="xmltext">="support@home.be" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.success.to"</span> <span class="xmlattribute">value</span><span class="xmltext">="support@home.be" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.failure.subject"</span> <span class="xmlattribute">value</span><span class="xmltext">="Nightly build failure !" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.success.subject"</span> <span class="xmlattribute">value</span><span class="xmltext">="Nightly build successful" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.failure.attachments"</span> <span class="xmlattribute">value</span><span class="xmltext">="MailLogger.failure.files" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">property</span> <span class="xmlattribute">name</span><span class="xmltext">="MailLogger.success.attachments"</span> <span class="xmlattribute">value</span><span class="xmltext">="MailLogger.success.files" /&gt;</span>
<span class="xmlcomment">&lt;!-- set of files to attach when build fails --&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">fileset</span> <span class="xmlattribute">id</span><span class="xmltext">="MailLogger.failure.files"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">include</span> <span class="xmlattribute">name</span><span class="xmltext">="dump.log" /&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">include</span> <span class="xmlattribute">name</span><span class="xmltext">="trace.txt" /&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">fileset</span><span class="xmltext">&gt;</span>
<span class="xmlcomment">&lt;!-- set of files to attach when build is successful --&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">fileset</span> <span class="xmlattribute">id</span><span class="xmltext">="MailLogger.success.files"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">include</span> <span class="xmlattribute">name</span><span class="xmltext">="trace.txt" /&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">fileset</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">target</span> <span class="xmlattribute">name</span><span class="xmltext">="build"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">echo</span> <span class="xmlattribute">message</span><span class="xmltext">=&quot;Starting build&quot; /&gt;</span>
....
<span class="xmltext">&lt;</span><span class="xmlelement">echo</span> <span class="xmlattribute">message</span><span class="xmltext">=&quot;Finished build&quot; /&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">target</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">project</span><span class="xmltext">&gt;</span>
</pre>
<h3><a id="XmlLogger" />XmlLogger</h3>
<p>
Writes all build information out to an XML file named <code>log.xml</code>, or
the value of the <code>XmlLogger.file</code> property if present, when used as
a listener. When used as a logger, it writes all output to either the console
or to the value of <code>-logfile</code>.
</p>
<p>
Whether used as a listener or logger, the output is not generated until the
build is complete.
</p>
<p>Usage:</p>
<blockquote>
<p>
<code>NAnt.exe -listener:NAnt.Core.XmlLogger</code><br />
<code>NAnt.exe -logger:NAnt.Core.XmlLogger -logfile:buildlog.xml</code>
</p>
</blockquote>
<p>Example:</p>
<pre class="code">
<span class="xmltext">&lt;</span><span class="xmlelement">buildresults</span> <span class="xmlattribute">project</span><span class="xmltext">="test"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">message</span> <span class="xmlattribute">level</span><span class="xmltext">="Info"&gt;&lt;![</span><span class="xmlcdata">CDATA[Buildfile: file:///D:/nant-test/xmlpeek/default.build]]</span><span class="xmltext">&gt;&lt;/</span><span class="xmlelement">message</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">message</span> <span class="xmlattribute">level</span><span class="xmltext">="Info"&gt;&lt;![</span><span class="xmlcdata">CDATA[Target framework: Microsoft .NET Framework 1.1]]</span><span class="xmltext">&gt;&lt;/</span><span class="xmlelement">message</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">message</span> <span class="xmlattribute">level</span><span class="xmltext">="Info"&gt;&lt;![</span><span class="xmlcdata">CDATA[Target<span class="xmltext">(</span>s<span class="xmltext">)</span> specified: build]]</span><span class="xmltext">&gt;&lt;/</span><span class="xmlelement">message</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">target</span> <span class="xmlattribute">name</span><span class="xmltext">="build"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">task</span> <span class="xmlattribute">name</span><span class="xmltext">="xmlpeek"&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">message</span> <span class="xmlattribute">level</span><span class="xmltext">="Info"&gt;&lt;![</span><span class="xmlcdata">CDATA[Peeking at <span class="xmltext">'D:\nant-test\xmlpeek\input.xml'</span> with XPath expression <span class="xmltext">'x:parameters/x:param'</span>.]]</span><span class="xmltext">&gt;&lt;/</span><span class="xmlelement">message</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">message</span> <span class="xmlattribute">level</span><span class="xmltext">="Info"&gt;&lt;![</span><span class="xmlcdata">CDATA[Found <span class="xmltext">'1'</span> nodes with the XPath expression <span class="xmltext">'x:parameters/x:param'</span>.]]</span><span class="xmltext">&gt;&lt;/</span><span class="xmlelement">message</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span><span style="color: black;">15.625</span><span class="xmltext">&lt;/</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">task</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span><span style="color: black;">15.625</span><span class="xmltext">&lt;/</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">target</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span><span style="color: black;">31.25</span><span class="xmltext">&lt;/</span><span class="xmlelement">duration</span><span class="xmltext">&gt;</span>
<span class="xmltext">&lt;/</span><span class="xmlelement">buildresults</span><span class="xmltext">&gt;</span>
</pre>
</body>
</html>

View File

@@ -1,71 +1,71 @@
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Projects" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Projects</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Projects
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>Projects</h1>
<p>A project has these attributes:</p>
<div class="table">
<table>
<colgroup>
<col />
<col />
<col style="text-align: center;" />
</colgroup>
<tbody>
<tr>
<th>
Attribute</th>
<th>
Description</th>
<th>
Required</th>
</tr>
<tr>
<td>name</td>
<td>The name of the project.</td>
<td>No</td>
</tr>
<tr>
<td>default</td>
<td>The default target to execute when no target is supplied on the command-line.</td>
<td>No</td>
</tr>
<tr>
<td>basedir</td>
<td>The base directory from which all path calculations are done.&nbsp; If not set, the parent directory of the buildfile will be used.</td>
<td>No</td>
</tr>
</tbody>
</table>
</div>
<p>Optionally, a description for the project can be provided as a top-level <code>&lt;description&gt;</code>
element.&nbsp; The text contained in the description element is used when the <code style="whitespace: nowrap;">-projecthelp</code> command line option is used.&nbsp; See the <a href="buildfiles.html">
example build file</a> for details.</p>
<p>Each project defines zero or more <a href="targets.html">targets</a>.&nbsp;
A target is a set of <a href="tasks.html">tasks</a> to be
executed.&nbsp; When starting NAnt, you can select which target(s) you want to
have executed.&nbsp; When no target is given, the project's default target is used.
When no target and no default target are specified, only the global tasks of the
project are executed.</p>
</body>
</html>
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Projects" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Projects</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Projects
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>Projects</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>A project has these attributes:</p>
<div class="table">
<table>
<colgroup>
<col />
<col />
<col style="text-align: center;" />
</colgroup>
<tbody>
<tr>
<th>
Attribute</th>
<th>
Description</th>
<th>
Required</th>
</tr>
<tr>
<td>name</td>
<td>The name of the project.</td>
<td>No</td>
</tr>
<tr>
<td>default</td>
<td>The default target to execute when no target is supplied on the command-line.</td>
<td>No</td>
</tr>
<tr>
<td>basedir</td>
<td>The base directory from which all path calculations are done.&nbsp; If not set, the parent directory of the buildfile will be used.</td>
<td>No</td>
</tr>
</tbody>
</table>
</div>
<p>Optionally, a description for the project can be provided as a top-level <code>&lt;description&gt;</code>
element.&nbsp; The text contained in the description element is used when the <code style="whitespace: nowrap;">-projecthelp</code> command line option is used.&nbsp; See the <a href="buildfiles.html">
example build file</a> for details.</p>
<p>Each project defines zero or more <a href="targets.html">targets</a>.&nbsp;
A target is a set of <a href="tasks.html">tasks</a> to be
executed.&nbsp; When starting NAnt, you can select which target(s) you want to
have executed.&nbsp; When no target is given, the project's default target is used.
When no target and no default target are specified, only the global tasks of the
project are executed.</p>
</body>
</html>

View File

@@ -1,319 +1,314 @@
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Properties" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Properties</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Properties
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>Properties</h1>
<h2><a id="contents" />Contents</h2>
<div>
1 <a href="#introduction">Introduction</a><br />
2 <a href="#naming-rules">Naming rules</a><br />
3 <a href="#built-in-properties">Built-in Properties</a><br />
<div style="margin-left: 20px;">
3.1 <a href="#framework-related-properties">Framework related Properties</a><br />
3.2 <a href="#platform-related-properties">Platform related Properties</a>
</div>
4 <a href="#readonly-properties">Read-only Properties</a><br />
5 <a href="#global-properties">Global Properties</a><br />
6 <a href="#examples">Examples</a><br />
</div>
<h2><a id="introduction" />1 Introduction</h2>
<p>A project can have a set of properties.&nbsp; These might be set in the
buildfile by the <a href="../tasks/property.html">&lt;property&gt;</a> task, or
might be set outside NAnt.&nbsp; A property has a name and a value. Properties
may be used in the value of task attributes. This is done by placing the
property name between "<code>${</code>" and "<code>}</code>" in the attribute
value. Properties may also be used in <a href="expressions.html">expressions</a>.
</p>
<h2><a id="naming-rules" />2 Naming rules</h2>
<p>A property name is a string of the following characters:</p>
<ul>
<li>
letters (<code>A-Z</code>, <code>a-z</code>),</li>
<li>
digits (<code>0-9</code>),</li>
<li>
underscore characters (<code>_</code>),</li>
<li>
dash characters (<code>-</code>),</li>
<li>
dot characters (<code>.</code>),</li>
</ul>
<p>In addition, a valid property name must start with a letter or an underscore and
must end with a letter, digit or an uderscore.</p>
<p>Examples of valid property names include:</p>
<ul>
<li>
<code>propertyname</code></li>
<li>
<code>property.name.with.dots</code></li>
<li>
<code>property-name-with-dashes</code></li>
<li>
<code>property.name-with.both-dots.and-dashes</code></li>
<li>
<code>__prop---3-erty__</code></li>
<li>
<code>__prop.1...erty__</code></li>
<li>
<code>property1</code></li>
<li>
<code>property1.0</code></li>
<li>
<code>property2.0.0</code></li>
<li>
<code>_property-2-1__</code></li>
<li>
<code>property-1-name_</code></li>
<li>
<code>property-1.0-name</code></li>
</ul>
<p>The following property names are not valid in NAnt:</p>
<ul>
<li>
<code>!@#!@$!@</code> (contains illegal characters)</li>
<li>
<code>.aaaaa</code> (starts with a dot)</li>
<li>
<code>-aaaaa</code> (starts with a dash)</li>
<li>
<code>1aaaaa</code> (starts with a digit)</li>
<li>
<code>aaaaa.aaa.a.a.a.a-</code> (ends with a dash)</li>
<li>
<code>aaaaa.aaa.a.a.a.a.</code> (ends with a dot)</li>
</ul>
<h2><a id="built-in-properties" />3 Built-in Properties</h2>
<p>NAnt has these built-in properties:</p>
<div class="table">
<table>
<tbody>
<tr>
<th>
Property</th>
<th>
Description</th>
</tr>
<tr>
<td>nant.version</td>
<td><i>Deprecated.</i> The version of NAnt.</td>
</tr>
<tr>
<td>nant.filename</td>
<td><i>Deprecated.</i> The full path to the NAnt assembly.</td>
</tr>
<tr>
<td>nant.location</td>
<td><i>Deprecated.</i> The base directory of the NAnt assembly.</td>
</tr>
<tr>
<td>nant.project.basedir</td>
<td><i>Deprecated.</i> The absolute path of the project's basedir.</td>
</tr>
<tr>
<td>nant.project.buildfile</td>
<td><i>Deprecated.</i> The absolute path of the buildfile.</td>
</tr>
<tr>
<td>nant.project.name</td>
<td><i>Deprecated.</i> The name of the project.</td>
</tr>
<tr>
<td>nant.project.default</td>
<td><i>Deprecated.</i> The name of the project's default target.</td>
</tr>
<tr>
<td>nant.onsuccess</td>
<td>The name of a target to be executed when the build succeeds.</td>
</tr>
<tr>
<td>nant.onfailure</td>
<td>The name of a target to be executed when the build fails.</td>
</tr>
<tr>
<td>nant.tasks.*</td>
<td><i>Deprecated.</i> Each task available to nant has a "true" value, e.g.,
nant.tasks.copy</td>
</tr>
</tbody>
</table>
</div>
<h3><a id="framework-related-properties" />3.1 Framework related Properties:</h3>
<div class="table">
<table>
<tbody>
<tr>
<th>
Property</th>
<th>
Description</th>
</tr>
<tr>
<td>nant.settings.currentframework</td>
<td>The current target framework, eg. 'net-1.0'.</td>
</tr>
<tr>
<td>nant.settings.currentframework.description</td>
<td><i>Deprecated.</i> Description of the current target framework.</td>
</tr>
<tr>
<td>nant.settings.currentframework.frameworkdirectory</td>
<td><i>Deprecated.</i> The framework directory of the current target framework.</td>
</tr>
<tr>
<td>nant.settings.currentframework.sdkdirectory</td>
<td><i>Deprecated.</i> The framework SDK directory of the current target framework.</td>
</tr>
<tr>
<td>nant.settings.currentframework.frameworkassemblydirectory</td>
<td><i>Deprecated.</i> The framework assembly directory of the current target
framework.</td>
</tr>
<tr>
<td>nant.settings.currentframework.runtimeengine</td>
<td><i>Deprecated.</i> The runtime engine of the current target framework if used
eg. mono.exe.</td>
</tr>
</tbody>
</table>
</div>
<h3><a id="platform-related-properties" />3.2 Platform related Properties:</h3>
<div class="table">
<table>
<tbody>
<tr>
<th>
Property</th>
<th>
Description</th>
</tr>
<tr>
<td>nant.platform.name</td>
<td><i>Deprecated.</i> The name of the platform on which NAnt is currently running
- either <code>win32</code> or <code>unix</code>.</td>
</tr>
<tr>
<td>nant.platform.win32</td>
<td><i>Deprecated.</i> Holds the value <code>true</code> if NAnt is running on the <code>
win32</code> platform; otherwise, <code>false</code>.</td>
</tr>
<tr>
<td>nant.platform.unix</td>
<td><i>Deprecated.</i> Holds the value <code>true</code> if NAnt is running on the <code>
unix</code> platform; otherwise, <code>false</code>.</td>
</tr>
</tbody>
</table>
</div>
<h2><a id="readonly-properties" />4 Read-only Properties</h2>
<p>
A property can be explicitly marked read-only by setting the
&quot;readonly&quot; attribute on the <a href="../tasks/property.html">&lt;property&gt;</a>
task to <b>true</b>.
</p>
<p>
The value of a read-only property cannot be modified after it has been set.
</p>
<p>
When attempting to override a read-only property using the <a href="../tasks/property.html">
&lt;property&gt;</a> task, the new value will be ignored and a warning
message will be output in the build log. Attempting to override read-only
properties using any other means (eg. other tasks) will result in a build
failure.
</p>
<p><b>Note:</b> properties set on the command-line are always read-only.</p>
<h2><a id="global-properties" />5 Global Properties</h2>
<p>Properties that should be accessible to all build files on a system can be
defined in the <code>&lt;properties&gt;</code> node of the NAnt configuration
file (<code>NAnt.exe.config</code>).</p>
<p>By changing the value of the property in the NAnt configuration file, the
updated value will be accessible to all build files on the system:</p>
<pre class="code">
&lt;?xml version="1.0"?&gt;
&lt;configuration&gt;
...
&lt;nant&gt;
...
&lt;properties&gt;
&lt;!-- properties defined here are accessible to all build files --&gt;
&lt;property name="company.name" value="Foo Ltd." readonly="true" /&gt;
&lt;/properties&gt;
&lt;/nant&gt;
&lt;/configuration&gt;
</pre>
<p>Individual build files can then use this property:</p>
<pre class="code">
&lt;?xml version="1.0"?&gt;
&lt;project name="test"&gt;
&lt;echo message="Company: ${company.name}" /&gt;
&lt;/project&gt;
</pre>
<p>The output of this build is:</p>
<pre>
[echo] Company: Foo Ltd.
</pre>
<h2><a id="example" /> 6 Examples</h2>
<p>The following build file demonstrates the use of property expansion:</p>
<pre class="code">
&lt;?xml version="1.0"?&gt;
&lt;project name="Property Test" default="test" basedir="."&gt;
&lt;property name="project.name" value="PropertyTest"/&gt;
&lt;property name="project.version" value="1.0.0"/&gt;
&lt;target name="test"&gt;
&lt;echo message="Building ${project.name}-${project.version}"/&gt;
&lt;/target&gt;
&lt;/project&gt;
</pre>
<p>The output of this build is:</p>
<pre>
[echo] Building PropertyTest-1.0.0
</pre>
<p>The following build file demonstrates the use of properties in <a href="expressions.html">
expressions</a>. It evaluates the length of the property <code>project.name</code>
and displays it.</p>
<pre class="code">
&lt;?xml version="1.0"?&gt;
&lt;project name="Expression Test" default="test" basedir="."&gt;
&lt;property name="project.name" value="Expression Test"/&gt;
&lt;target name="test"&gt;
&lt;echo message="Project name consists of ${string::get-length(project.name)} characters."/&gt;
&lt;/target&gt;
&lt;/project&gt;
</pre>
<p>The output of this build is:</p>
<pre>
[echo] Project name consists of 15 characters.
</pre>
<h3>See Also</h3>
<ul>
<li>
<a href="../tasks/property.html">&lt;property&gt;</a>
</li>
<li>
<a href="../tasks/sysinfo.html">&lt;sysinfo&gt;</a>
</li>
<li>
<a href="../tasks/tstamp.html">&lt;tstamp&gt;</a>
</li>
</ul>
</body>
</html>
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Properties" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Properties</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Properties
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>Properties</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<h2><a id="contents" />Contents</h2>
<div>
1 <a href="#introduction">Introduction</a><br />
2 <a href="#naming-rules">Naming rules</a><br />
3 <a href="#built-in-properties">Built-in Properties</a><br />
<div style="margin-left: 20px;">
3.1 <a href="#framework-related-properties">Framework related Properties</a><br />
3.2 <a href="#platform-related-properties">Platform related Properties</a>
</div>
4 <a href="#readonly-properties">Read-only Properties</a><br />
5 <a href="#global-properties">Global Properties</a><br />
6 <a href="#examples">Examples</a><br />
</div>
<h2><a id="introduction" />1 Introduction</h2>
<p>A project can have a set of properties.&nbsp; These might be set in the
buildfile by the <a href="../tasks/property.html">&lt;property&gt;</a> task, or
might be set outside NAnt.&nbsp; A property has a name and a value. Properties
may be used in the value of task attributes. This is done by placing the
property name between "<code>${</code>" and "<code>}</code>" in the attribute
value. Properties may also be used in <a href="expressions.html">expressions</a>.
</p>
<h2><a id="naming-rules" />2 Naming rules</h2>
<p>A property name is a string of the following characters:</p>
<ul>
<li>
letters (<code>A-Z</code>, <code>a-z</code>),</li>
<li>
digits (<code>0-9</code>),</li>
<li>
underscore characters (<code>_</code>),</li>
<li>
dash characters (<code>-</code>),</li>
<li>
dot characters (<code>.</code>),</li>
</ul>
<p>In addition, a valid property name must start with a letter or an underscore and
must end with a letter, digit or an uderscore.</p>
<p>Examples of valid property names include:</p>
<ul>
<li>
<code>propertyname</code></li>
<li>
<code>property.name.with.dots</code></li>
<li>
<code>property-name-with-dashes</code></li>
<li>
<code>property.name-with.both-dots.and-dashes</code></li>
<li>
<code>__prop---3-erty__</code></li>
<li>
<code>__prop.1...erty__</code></li>
<li>
<code>property1</code></li>
<li>
<code>property1.0</code></li>
<li>
<code>property2.0.0</code></li>
<li>
<code>_property-2-1__</code></li>
<li>
<code>property-1-name_</code></li>
<li>
<code>property-1.0-name</code></li>
</ul>
<p>The following property names are not valid in NAnt:</p>
<ul>
<li>
<code>!@#!@$!@</code> (contains illegal characters)</li>
<li>
<code>.aaaaa</code> (starts with a dot)</li>
<li>
<code>-aaaaa</code> (starts with a dash)</li>
<li>
<code>1aaaaa</code> (starts with a digit)</li>
<li>
<code>aaaaa.aaa.a.a.a.a-</code> (ends with a dash)</li>
<li>
<code>aaaaa.aaa.a.a.a.a.</code> (ends with a dot)</li>
</ul>
<h2><a id="built-in-properties" />3 Built-in Properties</h2>
<p>NAnt has these built-in properties:</p>
<div class="table">
<table>
<tbody>
<tr>
<th>
Property</th>
<th>
Description</th>
</tr>
<tr>
<td>nant.version</td>
<td><i>Deprecated.</i> The version of NAnt.</td>
</tr>
<tr>
<td>nant.filename</td>
<td><i>Deprecated.</i> The full path to the NAnt assembly.</td>
</tr>
<tr>
<td>nant.location</td>
<td><i>Deprecated.</i> The base directory of the NAnt assembly.</td>
</tr>
<tr>
<td>nant.project.basedir</td>
<td><i>Deprecated.</i> The absolute path of the project's basedir.</td>
</tr>
<tr>
<td>nant.project.buildfile</td>
<td><i>Deprecated.</i> The absolute path of the buildfile.</td>
</tr>
<tr>
<td>nant.project.name</td>
<td><i>Deprecated.</i> The name of the project.</td>
</tr>
<tr>
<td>nant.project.default</td>
<td><i>Deprecated.</i> The name of the project's default target.</td>
</tr>
<tr>
<td>nant.onsuccess</td>
<td>The name of a target to be executed when the build succeeds.</td>
</tr>
<tr>
<td>nant.onfailure</td>
<td>The name of a target to be executed when the build fails.</td>
</tr>
</tbody>
</table>
</div>
<h3><a id="framework-related-properties" />3.1 Framework related Properties:</h3>
<div class="table">
<table>
<tbody>
<tr>
<th>
Property</th>
<th>
Description</th>
</tr>
<tr>
<td>nant.settings.currentframework</td>
<td>The current target framework, eg. 'net-1.0'.</td>
</tr>
<tr>
<td>nant.settings.currentframework.description</td>
<td><i>Deprecated.</i> Description of the current target framework.</td>
</tr>
<tr>
<td>nant.settings.currentframework.frameworkdirectory</td>
<td><i>Deprecated.</i> The framework directory of the current target framework.</td>
</tr>
<tr>
<td>nant.settings.currentframework.sdkdirectory</td>
<td><i>Deprecated.</i> The framework SDK directory of the current target framework.</td>
</tr>
<tr>
<td>nant.settings.currentframework.frameworkassemblydirectory</td>
<td><i>Deprecated.</i> The framework assembly directory of the current target
framework.</td>
</tr>
<tr>
<td>nant.settings.currentframework.runtimeengine</td>
<td><i>Deprecated.</i> The runtime engine of the current target framework if used
eg. mono.exe.</td>
</tr>
</tbody>
</table>
</div>
<h3><a id="platform-related-properties" />3.2 Platform related Properties:</h3>
<div class="table">
<table>
<tbody>
<tr>
<th>
Property</th>
<th>
Description</th>
</tr>
<tr>
<td>nant.platform.name</td>
<td><i>Deprecated.</i> The name of the platform on which NAnt is currently running
- either <code>win32</code> or <code>unix</code>.</td>
</tr>
<tr>
<td>nant.platform.win32</td>
<td><i>Deprecated.</i> Holds the value <code>true</code> if NAnt is running on the <code>
win32</code> platform; otherwise, <code>false</code>.</td>
</tr>
<tr>
<td>nant.platform.unix</td>
<td><i>Deprecated.</i> Holds the value <code>true</code> if NAnt is running on the <code>
unix</code> platform; otherwise, <code>false</code>.</td>
</tr>
</tbody>
</table>
</div>
<h2><a id="readonly-properties" />4 Read-only Properties</h2>
<p>
A property can be explicitly marked read-only by setting the
&quot;readonly&quot; attribute on the <a href="../tasks/property.html">&lt;property&gt;</a>
task to <b>true</b>.
</p>
<p>
The value of a read-only property cannot be modified after it has been set.
</p>
<p>
When attempting to override a read-only property using the <a href="../tasks/property.html">
&lt;property&gt;</a> task, the new value will be ignored and a warning
message will be output in the build log. Attempting to override read-only
properties using any other means (eg. other tasks) will result in a build
failure.
</p>
<p><b>Note:</b> properties set on the command-line are always read-only.</p>
<h2><a id="global-properties" />5 Global Properties</h2>
<p>Properties that should be accessible to all build files on a system can be
defined in the <code>&lt;properties&gt;</code> node of the NAnt configuration
file (<code>NAnt.exe.config</code>).</p>
<p>By changing the value of the property in the NAnt configuration file, the
updated value will be accessible to all build files on the system:</p>
<pre class="code">
&lt;?xml version="1.0"?&gt;
&lt;configuration&gt;
...
&lt;nant&gt;
...
&lt;properties&gt;
&lt;!-- properties defined here are accessible to all build files --&gt;
&lt;property name="company.name" value="Foo Ltd." readonly="true" /&gt;
&lt;/properties&gt;
&lt;/nant&gt;
&lt;/configuration&gt;
</pre>
<p>Individual build files can then use this property:</p>
<pre class="code">
&lt;?xml version="1.0"?&gt;
&lt;project name="test"&gt;
&lt;echo message="Company: ${company.name}" /&gt;
&lt;/project&gt;
</pre>
<p>The output of this build is:</p>
<pre>
[echo] Company: Foo Ltd.
</pre>
<h2><a id="example" /> 6 Examples</h2>
<p>The following build file demonstrates the use of property expansion:</p>
<pre class="code">
&lt;?xml version="1.0"?&gt;
&lt;project name="Property Test" default="test" basedir="."&gt;
&lt;property name="project.name" value="PropertyTest"/&gt;
&lt;property name="project.version" value="1.0.0"/&gt;
&lt;target name="test"&gt;
&lt;echo message="Building ${project.name}-${project.version}"/&gt;
&lt;/target&gt;
&lt;/project&gt;
</pre>
<p>The output of this build is:</p>
<pre>
[echo] Building PropertyTest-1.0.0
</pre>
<p>The following build file demonstrates the use of properties in <a href="expressions.html">
expressions</a>. It evaluates the length of the property <code>project.name</code>
and displays it.</p>
<pre class="code">
&lt;?xml version="1.0"?&gt;
&lt;project name="Expression Test" default="test" basedir="."&gt;
&lt;property name="project.name" value="Expression Test"/&gt;
&lt;target name="test"&gt;
&lt;echo message="Project name consists of ${string::get-length(project.name)} characters."/&gt;
&lt;/target&gt;
&lt;/project&gt;
</pre>
<p>The output of this build is:</p>
<pre>
[echo] Project name consists of 15 characters.
</pre>
<h3>See Also</h3>
<ul>
<li>
<a href="../tasks/property.html">&lt;property&gt;</a>
</li>
<li>
<a href="../tasks/sysinfo.html">&lt;sysinfo&gt;</a>
</li>
<li>
<a href="../tasks/tstamp.html">&lt;tstamp&gt;</a>
</li>
</ul>
</body>
</html>

View File

@@ -1,92 +1,92 @@
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Running NAnt" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Running NAnt</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Running NAnt
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>Running NAnt</h1>
<p>
Running NAnt is simple once you have it <a href="../introduction/fog0000000013.html">
installed</a>,&nbsp;just type <code>NAnt</code>.&nbsp;&nbsp;Type <code style="whitespace: nowrap;">
NAnt -help</code> to get usage information.</p>
<h3>Specifying the Build File</h3>
<p>
When nothing is specified, NAnt looks for a file ending with <code>.build</code>,
e.g., <code>NAnt.build</code>, in the current directory.&nbsp; If found, it
uses that file as the build file.&nbsp; If more than one file is found you need
to specify the build file using the <code>-buildfile</code> option (see below).</p>
<p>
If you use the <code>-find</code> option, NAnt will search for a build file in
the parent directory, and so on, until the root of the file system has been
reached.&nbsp; To make NAnt use another build file, use the command-line option
-buildfile:<em>file</em>, where <em>file</em> is the build file you want to
use.</p>
<h3>Specifying Targets</h3>
<p>
You can specify one or more targets that should be executed. When omitted, the
target that is specified in the <code>default</code> attribute of the <code>&lt;project&gt;</code>
tag is used.</p>
<p>
The <code>-projecthelp</code> option prints out the description of the project,
if it exists, followed by a list of the project's targets. First those with a
description, then those without one.</p>
<h3>Setting Properties</h3>
<p>
To override properties specified in the build file use the <code style="whitespace: nowrap;">
-D:<i>property</i>=<i>value</i></code> option, where <i>property</i> is the
name of the property, and <i>value</i> is the value for that property.&nbsp;</p>
<h3>Examples</h3>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div>
<pre>NAnt</pre>
</div>
</blockquote>
<p>
Runs NAnt using the file ending in&nbsp;<code>*.build.xml</code> file in the
current directory, on the default target.</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div>
<pre>NAnt -buildfile:..\ProjectName.build</pre>
</div>
</blockquote>
<p>
Runs NAnt using the <code>ProjectName.build</code> file in the parent
directory, on the default target.</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div>
<pre>NAnt clean</pre>
</div>
</blockquote>
<p>
Runs NAnt using the default build file in the current directory, on a target
called <code>clean</code>.</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div>
<pre>NAnt -D:debug=false clean dist</pre>
</div>
</blockquote>
<p>
Runs NAnt using the default build file in the current directory, first on
the&nbsp;<code>clean</code> target and then on the <code>dist</code> target
while setting the <code>debug</code> property to <code>false</code>.&nbsp; This
could, for example, make a release distribution from scratch.</p>
</body>
</html>
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Running NAnt" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Running NAnt</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Running NAnt
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>Running NAnt</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>
Running NAnt is simple once you have it <a href="../introduction/fog0000000013.html">
installed</a>,&nbsp;just type <code>NAnt</code>.&nbsp;&nbsp;Type <code style="whitespace: nowrap;">
NAnt -help</code> to get usage information.</p>
<h3>Specifying the Build File</h3>
<p>
When nothing is specified, NAnt looks for a file ending with <code>.build</code>,
e.g., <code>NAnt.build</code>, in the current directory.&nbsp; If found, it
uses that file as the build file.&nbsp; If more than one file is found you need
to specify the build file using the <code>-buildfile</code> option (see below).</p>
<p>
If you use the <code>-find</code> option, NAnt will search for a build file in
the parent directory, and so on, until the root of the file system has been
reached.&nbsp; To make NAnt use another build file, use the command-line option
-buildfile:<em>file</em>, where <em>file</em> is the build file you want to
use.</p>
<h3>Specifying Targets</h3>
<p>
You can specify one or more targets that should be executed. When omitted, the
target that is specified in the <code>default</code> attribute of the <code>&lt;project&gt;</code>
tag is used.</p>
<p>
The <code>-projecthelp</code> option prints out the description of the project,
if it exists, followed by a list of the project's targets. First those with a
description, then those without one.</p>
<h3>Setting Properties</h3>
<p>
To override properties specified in the build file use the <code style="whitespace: nowrap;">
-D:<i>property</i>=<i>value</i></code> option, where <i>property</i> is the
name of the property, and <i>value</i> is the value for that property.&nbsp;</p>
<h3>Examples</h3>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div>
<pre>NAnt</pre>
</div>
</blockquote>
<p>
Runs NAnt using the file ending in&nbsp;<code>*.build.xml</code> file in the
current directory, on the default target.</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div>
<pre>NAnt -buildfile:..\ProjectName.build</pre>
</div>
</blockquote>
<p>
Runs NAnt using the <code>ProjectName.build</code> file in the parent
directory, on the default target.</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div>
<pre>NAnt clean</pre>
</div>
</blockquote>
<p>
Runs NAnt using the default build file in the current directory, on a target
called <code>clean</code>.</p>
<blockquote dir="ltr" style="MARGIN-RIGHT: 0px">
<div>
<pre>NAnt -D:debug=false clean dist</pre>
</div>
</blockquote>
<p>
Runs NAnt using the default build file in the current directory, first on
the&nbsp;<code>clean</code> target and then on the <code>dist</code> target
while setting the <code>debug</code> property to <code>false</code>.&nbsp; This
could, for example, make a release distribution from scratch.</p>
</body>
</html>

View File

@@ -1,136 +1,136 @@
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Targets" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Targets</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Targets
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>Targets</h1>
<p>A target has these attributes:</p>
<div class="table">
<table>
<colgroup>
<col />
<col />
<col style="text-align: center;" />
</colgroup>
<tbody>
<tr>
<th>
Attribute</th>
<th>
Description</th>
<th>
Required</th>
</tr>
<tr>
<td>name</td>
<td>The name of the target.</td>
<td>Yes</td>
</tr>
<tr>
<td>depends</td>
<td>A comma-separated list of names of targets on which this target depends.</td>
<td>No</td>
</tr>
<tr>
<td>if</td>
<td>An expression that should evaluate to <b>true</b> in order for this target to
execute.</td>
<td>No</td>
</tr>
<tr>
<td>unless</td>
<td>An expression that, when evaluated to <b>true</b>, will cause the target to be
skipped.</td>
<td>No</td>
</tr>
<tr>
<td>description</td>
<td>A short description of this target's function.</td>
<td>No</td>
</tr>
</tbody>
</table>
</div>
<p>
The optional <code>description</code> attribute can be used to provide a
one-line description of this target, which is printed by the <code style="whitespace: nowrap;">
-projecthelp</code> command-line option.</p>
<h3><a id="dependencies" />Dependencies</h3>
<p>
A target can depend on other targets.&nbsp; You might have a target for
compiling, for example, and a target for creating a distributable.&nbsp; You
can only build a distributable when you have compiled first, so the distribute
target <em>depends on</em> the compile target.&nbsp; NAnt resolves these
dependencies.</p>
<p>
NAnt tries to execute the targets in the <code>depends</code> attribute in the
order they appear from left to right.&nbsp; It is possible that a target can
get executed earlier when an earlier target depends on it:</p>
<pre class="code">
&lt;target name="A"/&gt;
&lt;target name="B" depends="A" /&gt;
&lt;target name="C" depends="B" /&gt;
&lt;target name="D" depends="C,B,A" /&gt;
</pre>
<p>
Suppose we want to execute target D.&nbsp; From its <code>depends</code> attribute,
you might think that first target C, then B and then A is executed.&nbsp;
Wrong!&nbsp; C depends on B, and B depends on A, so first A is executed, then
B, then C, and finally D.</p>
<p>
A target gets executed only once, even when more than one target depends on it
(see the previous example). However, when the <a href="../tasks/call.html">&lt;call&gt;</a>
task is used to execute a target, both the target and all its dependent targets
will be re-executed.</p>
<h3><a id="wild-targets" />Wild Targets</h3>
<p>
A target can be marked as <i>wild</i> by setting the <code>name</code> attribute
to "*". A build file can contain up to one wild target, and it is executed if
and only if the invoked target does not exist in the current build file.&nbsp; <i>Wild</i>
targets let you define how to handle invalid requests, or provide generic
behavior for unknown targets. For example:</p>
<pre class="code">
&lt;target name="A" /&gt;
&lt;target name="B" /&gt;
&lt;target name="*" /&gt;
</pre>
<p>
The last target is executed if the invoked target is neither A nor B.</p>
<h3><a id="conditional-execution" />Conditional Execution</h3>
<p>
A target also has the ability to perform its execution if or unless a property
has been set.&nbsp; This allows, for example, better control on the building
process depending on the state of the system (OS, command-line property
defines, etc.).&nbsp; To make a target <i>sense</i> this property, you should
add the <code>if</code> or <code>unless</code> attribute with an expression
that the target should react to. For example:</p>
<pre class="code">
&lt;target name="build-module-A" if="${module-A-present}" /&gt;
&lt;target name="build-own-fake-module-A" unless="${file::exists('fake-module-a.dll')}" /&gt;
</pre>
<p>
If no <code>if</code> and no <code>unless</code> attribute is present, the
target will always be executed.</p>
<p><b>Note:</b> the dependencies of a target are always executed before testing the
target's condition.</p>
</body>
</html>
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Targets" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>NAnt - Targets</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a> <img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a> <img alt="-&gt;" src="../images/arrow.gif" /> <a href="index.html">
Fundamentals</a> <img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Targets
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>Targets</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>A target has these attributes:</p>
<div class="table">
<table>
<colgroup>
<col />
<col />
<col style="text-align: center;" />
</colgroup>
<tbody>
<tr>
<th>
Attribute</th>
<th>
Description</th>
<th>
Required</th>
</tr>
<tr>
<td>name</td>
<td>The name of the target.</td>
<td>Yes</td>
</tr>
<tr>
<td>depends</td>
<td>A comma-separated list of names of targets on which this target depends.</td>
<td>No</td>
</tr>
<tr>
<td>if</td>
<td>An expression that should evaluate to <b>true</b> in order for this target to
execute.</td>
<td>No</td>
</tr>
<tr>
<td>unless</td>
<td>An expression that, when evaluated to <b>true</b>, will cause the target to be
skipped.</td>
<td>No</td>
</tr>
<tr>
<td>description</td>
<td>A short description of this target's function.</td>
<td>No</td>
</tr>
</tbody>
</table>
</div>
<p>
The optional <code>description</code> attribute can be used to provide a
one-line description of this target, which is printed by the <code style="whitespace: nowrap;">
-projecthelp</code> command-line option.</p>
<h3><a id="dependencies" />Dependencies</h3>
<p>
A target can depend on other targets.&nbsp; You might have a target for
compiling, for example, and a target for creating a distributable.&nbsp; You
can only build a distributable when you have compiled first, so the distribute
target <em>depends on</em> the compile target.&nbsp; NAnt resolves these
dependencies.</p>
<p>
NAnt tries to execute the targets in the <code>depends</code> attribute in the
order they appear from left to right.&nbsp; It is possible that a target can
get executed earlier when an earlier target depends on it:</p>
<pre class="code">
&lt;target name="A"/&gt;
&lt;target name="B" depends="A" /&gt;
&lt;target name="C" depends="B" /&gt;
&lt;target name="D" depends="C,B,A" /&gt;
</pre>
<p>
Suppose we want to execute target D.&nbsp; From its <code>depends</code> attribute,
you might think that first target C, then B and then A is executed.&nbsp;
Wrong!&nbsp; C depends on B, and B depends on A, so first A is executed, then
B, then C, and finally D.</p>
<p>
A target gets executed only once, even when more than one target depends on it
(see the previous example). However, when the <a href="../tasks/call.html">&lt;call&gt;</a>
task is used to execute a target, both the target and all its dependent targets
will be re-executed.</p>
<h3><a id="wild-targets" />Wild Targets</h3>
<p>
A target can be marked as <i>wild</i> by setting the <code>name</code> attribute
to "*". A build file can contain up to one wild target, and it is executed if
and only if the invoked target does not exist in the current build file.&nbsp; <i>Wild</i>
targets let you define how to handle invalid requests, or provide generic
behavior for unknown targets. For example:</p>
<pre class="code">
&lt;target name="A" /&gt;
&lt;target name="B" /&gt;
&lt;target name="*" /&gt;
</pre>
<p>
The last target is executed if the invoked target is neither A nor B.</p>
<h3><a id="conditional-execution" />Conditional Execution</h3>
<p>
A target also has the ability to perform its execution if or unless a property
has been set.&nbsp; This allows, for example, better control on the building
process depending on the state of the system (OS, command-line property
defines, etc.).&nbsp; To make a target <i>sense</i> this property, you should
add the <code>if</code> or <code>unless</code> attribute with an expression
that the target should react to. For example:</p>
<pre class="code">
&lt;target name="build-module-A" if="${module-A-present}" /&gt;
&lt;target name="build-own-fake-module-A" unless="${file::exists('fake-module-a.dll')}" /&gt;
</pre>
<p>
If no <code>if</code> and no <code>unless</code> attribute is present, the
target will always be executed.</p>
<p><b>Note:</b> the dependencies of a target are always executed before testing the
target's condition.</p>
</body>
</html>

View File

@@ -1,274 +1,277 @@
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Tasks" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>Tasks</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a>
<img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a>
<img alt="-&gt;" src="../images/arrow.gif" />
<a href="index.html">Fundamentals</a>
<img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Tasks
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>Tasks</h1>
<h2><a id="contents" />Contents</h2>
<div>
1 <a href="#introduction">Introduction</a><br />
2 <a href="#taskloader">Loading custom extensions</a><br />
<div style="margin-left: 20px;">
2.1 <a href="#taskloader-automatic">Automatic discovery</a><br/>
<div style="margin-left: 20px;">
2.1.1 <a href="#automatic-os">Operating system</a><br/>
2.1.2 <a href="#automatic-runtime">Runtime framework</a><br/>
2.1.3 <a href="#automatic-project">Project</a><br/>
</div>
2.2 <a href="#taskloader-forced">Forced scan</a><br/>
</div>
</div>
<h2><a id="introduction" />1 Introduction</h2>
<p>A task is a piece of code that can be executed.</p>
<p>A task can have multiple attributes (or arguments, if you prefer).&nbsp; The
value of an attribute may contain references to a <a href="properties.html">property</a>.&nbsp;
These references will be resolved before the task is executed.</p>
<p>Tasks have a common structure:</p>
<blockquote><pre>&lt;<i>name</i> <i>attribute1</i>="<i>value1</i>" <i>attribute2</i>="<i>value2</i>" ... /&gt;</pre>
</blockquote>
<p>where <i>name</i> is the name of the task, <i>attribute#</i> is the attribute
name, and <i>value#</i> is the value for this attribute.</p>
<p><img height="9" alt=">" src="../images/bullet.gif" width="5" />&nbsp;For
more information see the <a href="../tasks/index.html">Task Reference</a>.</p>
<h2><a id="taskloader" />2 Loading custom extensions</h2>
<p>
Extensions can be devided in the following categories:
</p>
<ul>
<li>Tasks</li>
<li>Filters</li>
<li>Functions</li>
<li>Global Types</li>
</ul>
<p>
NAnt currently provides two mechanisms to make third-party extensions available for use in build scripts:
</p>
<ul>
<li>
Automatic discovery
</li>
<li>
Forced scan
</li>
</ul>
<p>
Both mechanisms use .NET reflection to scan one or more assemblies for the presence of extensions. When found,
these extensions are registered in the NAnt type system, and from then on these are available for all build
scripts (in the current NAnt instance).
</p>
<h3><a id="taskloader-automatic" />2.1 Automatic discovery</h3>
<p>
To facilitate registration of extensions that are used in multiple (or even all) build
scripts, NAnt supports automatic discovery of extensions.
</p>
<p>
In this context, automatic discovery means scanning a predefined set of directories and files for extensions.
</p>
<p>
The actual set of directories and files that is scanned is determined by:
</p>
<ul>
<li>Operating system</li>
<li>Runtime framework</li>
<li>Project</li>
</ul>
<h4><a id="automatic-os" />2.1.1 Operating system</h4>
<p>
When starting NAnt, all assemblies matching the following patterns will be scanned for extensions:
</p>
<div style="margin-left: 20px;">
<p>
<b>Windows</b>
</p>
<div style="margin-left: 20px;">
<table style="width: 800px;" cellspacing="1" cellpadding="4">
<colgroup>
<col style="text-align: center;" />
<col style="text-align: center;" />
<col style="text-align: left;" />
</colgroup>
<tr>
<th>Pattern</th>
<th>Action</th>
<th>Description</th>
</tr>
<tr>
<td colspan="3"><hr /></td>
</tr>
<tr>
<td>*Tasks.dll</td>
<td>include</td>
<td>NAnt Core assemblies</td>
</tr>
<tr>
<td>*Tests.dll</td>
<td>include</td>
<td>NAnt test assemblies</td>
</tr>
<tr>
<td>tasks/*.dll</td>
<td>include</td>
<td>Framework-neutral assemblies</td>
</tr>
<tr>
<td>NAnt.MSNetTasks.dll</td>
<td>exclude</td>
<td>Microsoft.NET specific assembly</td>
</tr>
<tr>
<td>NAnt.MSNet.Tests.dll</td>
<td>exclude</td>
<td>Microsoft.NET specific test assembly</td>
</tr>
</table>
</div>
</div>
<div style="margin-left: 20px;">
<p>
<b>Unix</b>
</p>
<div style="margin-left: 20px;">
<table style="width: 800px;" cellspacing="1" cellpadding="4">
<colgroup>
<col style="text-align: center;" />
<col style="text-align: center;" />
<col style="text-align: left;" />
</colgroup>
<tr>
<th>Pattern</th>
<th>Action</th>
<th style="text-align: left;">Description</th>
</tr>
<tr>
<td colspan="3"><hr /></td>
</tr>
<tr>
<td>*Tasks.dll</td>
<td>include</td>
<td>NAnt Core assemblies</td>
</tr>
<tr>
<td>*Tests.dll</td>
<td>include</td>
<td>NAnt test assemblies</td>
</tr>
<tr>
<td>tasks/*.dll</td>
<td>include</td>
<td>Framework-neutral assemblies</td>
</tr>
<tr>
<td>NAnt.MSNetTasks.dll</td>
<td>exclude</td>
<td>Microsoft.NET specific assembly</td>
</tr>
<tr>
<td>NAnt.MSNet.Tests.dll</td>
<td>exclude</td>
<td>Microsoft.NET specific test assembly</td>
</tr>
<tr>
<td>NAnt.VSNetTasks.dll</td>
<td>exclude</td>
<td>Assembly containing <a href="../tasks/solution.html"><code>&lt;solution&gt;</code></a> task</td>
</tr>
<tr>
<td>NAnt.Win32Tasks.dll</td>
<td>exclude</td>
<td>Win32 specific assembly</td>
</tr>
<tr>
<td>NAnt.Win32.Tests.dll</td>
<td>exclude</td>
<td>Win32 specific test assembly</td>
</tr>
</table>
</div>
</div>
<p>
<b>NOTE</b>: all patterns are matched relative to the NAnt base directory, which is the directory in which NAnt.exe is located.
</p>
<h4><a id="automatic-runtime" />2.1.2 Runtime framework</h4>
<p>
Depending on the runtime framework on which NAnt is running, some additional directories are scanned.
</p>
<p>
In general, the following include patterns are applied:
</p>
<div style="margin-left: 20px;">
tasks/&lt;framework family&gt;/*.dll<br/>
tasks/&lt;framework family&gt;/&lt;framework version&gt;/**/*.dll<br/>
</div>
<p>
<b>Example:</b>
</p>
<p>
When running NAnt on Microsoft .NET Framework 1.0, assemblies matching the following pattern would be scanned:
</p>
<div style="margin-left: 20px;">
tasks/net/*.dll<br />
tasks/net/1.0/**/*.dll
</div>
<p>
<b>NOTE:</b> the exact set of patterns that are used for a given runtime framework is defined in the NAnt configuration file (NAnt.exe.config).
</p>
<h4><a id="automatic-project">2.1.3 Project</a></h4>
<p>
Whenever a build project is started, NAnt will scan the following directories for assemblies that match the *.dll pattern:
</p>
<ul>
<li>
&lt;Project Base Directory&gt;\tasks\
</li>
<li>
&lt;Project Base Directory&gt;\tasks\&lt;framework family&gt;\
</li>
<li>
&lt;Project Base Directory&gt;\tasks\&lt;framework family&gt;\&lt;framework version&gt;\
</li>
</ul>
<p>
<b>Example:</b>
</p>
<p>
For a project file located in &quot;c:\projects\log4net&quot; with NAnt running on the Microsoft .NET 2.0 runtime, NAnt would end-up scanning the following project-level directories:
</p>
<ul>
<li>
c:\projects\log4net\tasks\
</li>
<li>
c:\projects\log4net\tasks\net\
</li>
<li>
c:\projects\log4net\tasks\net\2.0\
</li>
</ul>
<h3><a id="taskloader-forced" />2.2 Forced scan</h3>
<p>
To explicitly instruct NAnt to scan a certain assembly (or set of assemblies) for extensions, build authors can use the <a href="../tasks/loadtasks.html"><code>&lt;loadtasks&gt;</code></a> tasks.
</p>
</body>
</html>
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Tasks" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>Tasks</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" href="http://nant.sourceforge.net"><b>NAnt</b></a>
<img src="../images/arrow.gif" alt="-&gt;" width="13" height="9" />
<a href="../index.html">Help</a>
<img alt="-&gt;" src="../images/arrow.gif" />
<a href="index.html">Fundamentals</a>
<img height="9" alt="-&gt;" src="../images/arrow.gif" width="13" />
Tasks
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>Tasks</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<h2><a id="contents" />Contents</h2>
<div>
1 <a href="#introduction">Introduction</a><br />
2 <a href="#taskloader">Loading custom extensions</a><br />
<div style="margin-left: 20px;">
2.1 <a href="#taskloader-automatic">Automatic discovery</a><br/>
<div style="margin-left: 20px;">
2.1.1 <a href="#automatic-os">Operating system</a><br/>
2.1.2 <a href="#automatic-runtime">Runtime framework</a><br/>
2.1.3 <a href="#automatic-project">Project</a><br/>
</div>
2.2 <a href="#taskloader-forced">Forced scan</a><br/>
</div>
</div>
<h2><a id="introduction" />1 Introduction</h2>
<p>A task is a piece of code that can be executed.</p>
<p>A task can have multiple attributes (or arguments, if you prefer).&nbsp; The
value of an attribute may contain references to a <a href="properties.html">property</a>.&nbsp;
These references will be resolved before the task is executed.</p>
<p>Tasks have a common structure:</p>
<blockquote><pre>&lt;<i>name</i> <i>attribute1</i>="<i>value1</i>" <i>attribute2</i>="<i>value2</i>" ... /&gt;</pre>
</blockquote>
<p>where <i>name</i> is the name of the task, <i>attribute#</i> is the attribute
name, and <i>value#</i> is the value for this attribute.</p>
<p><img height="9" alt=">" src="../images/bullet.gif" width="5" />&nbsp;For
more information see the <a href="../tasks/index.html">Task Reference</a>.</p>
<h2><a id="taskloader" />2 Loading custom extensions</h2>
<p>
Extensions can be devided in the following categories:
</p>
<ul>
<li>Tasks</li>
<li>Filters</li>
<li>Functions</li>
<li>Global Types</li>
</ul>
<p>
NAnt currently provides two mechanisms to make third-party extensions available for use in build scripts:
</p>
<ul>
<li>
Automatic discovery
</li>
<li>
Forced scan
</li>
</ul>
<p>
Both mechanisms use .NET reflection to scan one or more assemblies for the presence of extensions. When found,
these extensions are registered in the NAnt type system, and from then on these are available for all build
scripts (in the current NAnt instance).
</p>
<h3><a id="taskloader-automatic" />2.1 Automatic discovery</h3>
<p>
To facilitate registration of extensions that are used in multiple (or even all) build
scripts, NAnt supports automatic discovery of extensions.
</p>
<p>
In this context, automatic discovery means scanning a predefined set of directories and files for extensions.
</p>
<p>
The actual set of directories and files that is scanned is determined by:
</p>
<ul>
<li>Operating system</li>
<li>Runtime framework</li>
<li>Project</li>
</ul>
<h4><a id="automatic-os" />2.1.1 Operating system</h4>
<p>
When starting NAnt, all assemblies matching the following patterns will be scanned for extensions:
</p>
<div style="margin-left: 20px;">
<p>
<b>Windows</b>
</p>
<div style="margin-left: 20px;">
<table style="width: 800px;" cellspacing="1" cellpadding="4">
<colgroup>
<col style="text-align: center;" />
<col style="text-align: center;" />
<col style="text-align: left;" />
</colgroup>
<tr>
<th>Pattern</th>
<th>Action</th>
<th>Description</th>
</tr>
<tr>
<td colspan="3"><hr /></td>
</tr>
<tr>
<td>*Tasks.dll</td>
<td>include</td>
<td>NAnt Core assemblies</td>
</tr>
<tr>
<td>*Tests.dll</td>
<td>include</td>
<td>NAnt test assemblies</td>
</tr>
<tr>
<td>extensions/common/neutral/**/*.dll</td>
<td>include</td>
<td>Framework and version-neutral assemblies</td>
</tr>
<tr>
<td>NAnt.MSNetTasks.dll</td>
<td>exclude</td>
<td>Microsoft.NET specific assembly</td>
</tr>
<tr>
<td>NAnt.MSNet.Tests.dll</td>
<td>exclude</td>
<td>Microsoft.NET specific test assembly</td>
</tr>
</table>
</div>
</div>
<div style="margin-left: 20px;">
<p>
<b>Unix</b>
</p>
<div style="margin-left: 20px;">
<table style="width: 800px;" cellspacing="1" cellpadding="4">
<colgroup>
<col style="text-align: center;" />
<col style="text-align: center;" />
<col style="text-align: left;" />
</colgroup>
<tr>
<th>Pattern</th>
<th>Action</th>
<th style="text-align: left;">Description</th>
</tr>
<tr>
<td colspan="3"><hr /></td>
</tr>
<tr>
<td>*Tasks.dll</td>
<td>include</td>
<td>NAnt Core assemblies</td>
</tr>
<tr>
<td>*Tests.dll</td>
<td>include</td>
<td>NAnt test assemblies</td>
</tr>
<tr>
<td>extensions/common/neutral/**/*.dll</td>
<td>include</td>
<td>Framework and version-neutral assemblies</td>
</tr>
<tr>
<td>NAnt.MSNetTasks.dll</td>
<td>exclude</td>
<td>Microsoft.NET specific assembly</td>
</tr>
<tr>
<td>NAnt.MSNet.Tests.dll</td>
<td>exclude</td>
<td>Microsoft.NET specific test assembly</td>
</tr>
<tr>
<td>NAnt.Win32Tasks.dll</td>
<td>exclude</td>
<td>Win32 specific assembly</td>
</tr>
<tr>
<td>NAnt.Win32.Tests.dll</td>
<td>exclude</td>
<td>Win32 specific test assembly</td>
</tr>
</table>
</div>
</div>
<p>
<b>NOTE</b>: all patterns are matched relative to the NAnt base directory, which is the directory in which NAnt.exe is located.
</p>
<h4><a id="automatic-runtime" />2.1.2 Runtime framework</h4>
<p>
Depending on the runtime framework on which NAnt is running, some additional directories are scanned.
</p>
<p>
In general, the following include patterns are applied:
</p>
<div style="margin-left: 20px;">
extensions/common/&lt;CLR version&gt;/**/*.dll<br/>
extensions/&lt;framework family&gt;/neutral/**/*.dll<br/>
extensions/&lt;framework family&gt;/&lt;framework version&gt;/**/*.dll<br/>
</div>
<p>
<b>Example:</b>
</p>
<p>
When running NAnt on Microsoft .NET Framework 1.0, assemblies matching the following pattern would be scanned:
</p>
<div style="margin-left: 20px;">
extensions/common/1.0/**/*.dll<br />
extensions/net/neutral/**/*.dll<br />
extensions/net/1.0/**/*.dll
</div>
<p>
<b>NOTE:</b> the exact set of patterns that are used for a given runtime framework is defined in the NAnt configuration file (NAnt.exe.config).
</p>
<h4><a id="automatic-project">2.1.3 Project</a></h4>
<p>
Whenever a build project is started, NAnt will scan the following directories for assemblies that match the *.dll pattern:
</p>
<ul>
<li>
&lt;Project Base Directory&gt;/extensions/common/neutral/
</li>
<li>
&lt;Project Base Directory&gt;/extensions/common/&lt;CLR version&gt;/
</li>
<li>
&lt;Project Base Directory&gt;/extensions/&lt;framework family&gt;/neutral/
</li>
<li>
&lt;Project Base Directory&gt;/tasks/&lt;framework family&gt;/&lt;framework version&gt;/
</li>
</ul>
<p>
<b>Example:</b>
</p>
<p>
For a project file located in &quot;c:\projects\log4net&quot; with NAnt running on the Microsoft .NET 2.0 runtime, NAnt would end-up scanning the following project-level directories:
</p>
<ul>
<li>
c:\projects\log4net\extensions\common\neutral\
</li>
<li>
c:\projects\log4net\extensions\common\2.0\
</li>
<li>
c:\projects\log4net\extensions\net\neutral\
</li>
<li>
c:\projects\log4net\extensions\net\2.0\
</li>
</ul>
<h3><a id="taskloader-forced" />2.2 Forced scan</h3>
<p>
To explicitly instruct NAnt to scan a certain assembly (or set of assemblies) for extensions, build authors can use the <a href="../tasks/loadtasks.html"><code>&lt;loadtasks&gt;</code></a> tasks.
</p>
</body>
</html>

View File

@@ -1,61 +1,61 @@
<!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">
<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>NAnt Help</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 src="images/arrow.gif" alt="-&gt;" width="13" height="9" />
Help
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<table width="100%">
<tr>
<td>
<h1><span class="N">N</span><span class="Ant">Ant</span>
Help</h1>
</td>
<td style="text-align: right">
<a href="http://nant.sourceforge.net/"><img style="border-width: 0px;" alt="NAnt logo (link to home page)" src="images/logo.gif"
width="270" height="118" /></a>
</td>
</tr>
</table>
<p><img alt=" >" src="images/bullet.gif" /> <b><a href="introduction/index.html">Introduction</a></b><br />
Requirements, installation, quick start, history of NAnt and other
miscellaneous topics.</p>
<p><img alt=" >" src="images/bullet.gif" /> <b><a href="fundamentals/index.html">Fundamentals</a></b><br />
The basic concepts needed to understand and use NAnt.</p>
<p>
<img alt=" >" src="images/bullet.gif" /> <b><a href="tasks/index.html">Task Reference</a></b>
<br />
List of Tasks.
</p>
<p>
<img alt=" >" src="images/bullet.gif" /> <b><a href="types/index.html">Type Reference</a></b>
<br />
List of global (referencable) Types.
</p>
<p><img alt=" >" src="images/bullet.gif" /> <b><a href="functions/index.html">Function
Reference</a></b><br />
List of Functions that can be used in <a href="fundamentals/expressions.html">Expressions</a>.
</p>
<p><img alt=" >" src="images/bullet.gif" /> <b><a href="filters/index.html">Filter
Reference</a></b><br />
List of Filters that can be used in <a href="types/filterchain.html">FilterChains</a>.
</p>
<hr />
<p>Portions of this document have been directly copied from the <a href="http://jakarta.apache.org/ant/manual/">
Apache Ant user manual</a>.</p>
</body>
</html>
<!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">
<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>NAnt Help</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 src="images/arrow.gif" alt="-&gt;" width="13" height="9" />
Help
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<table width="100%">
<tr>
<td>
<h1><span class="N">N</span><span class="Ant">Ant</span>
Help</h1>
</td>
<td style="text-align: right">
<a href="http://nant.sourceforge.net/"><img style="border-width: 0px;" alt="NAnt logo (link to home page)" src="images/logo.gif"
width="270" height="118" /></a>
</td>
</tr>
</table>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p><img alt=" >" src="images/bullet.gif" /> <b><a href="introduction/index.html">Introduction</a></b><br />
Requirements, installation, quick start, history of NAnt and other
miscellaneous topics.</p>
<p><img alt=" >" src="images/bullet.gif" /> <b><a href="fundamentals/index.html">Fundamentals</a></b><br />
The basic concepts needed to understand and use NAnt.</p>
<p>
<img alt=" >" src="images/bullet.gif" /> <b><a href="tasks/index.html">Task Reference</a></b>
<br />
List of Tasks.
</p>
<p>
<img alt=" >" src="images/bullet.gif" /> <b><a href="types/index.html">Type Reference</a></b>
<br />
List of global (referencable) Types.
</p>
<p><img alt=" >" src="images/bullet.gif" /> <b><a href="functions/index.html">Function
Reference</a></b><br />
List of Functions that can be used in <a href="fundamentals/expressions.html">Expressions</a>.
</p>
<p><img alt=" >" src="images/bullet.gif" /> <b><a href="filters/index.html">Filter
Reference</a></b><br />
List of Filters that can be used in <a href="types/filterchain.html">FilterChains</a>.
</p>
<hr />
<p>Portions of this document have been directly copied from the <a href="http://jakarta.apache.org/ant/manual/">
Apache Ant user manual</a>.</p>
</body>
</html>

View File

@@ -1,42 +1,42 @@
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="System Requirements" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>System Requirements</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" 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="index.html">Introduction</a> <img height="9" alt="->" src="../images/arrow.gif" width="13" />
System Requirements
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>System Requirements</h1>
<p>To use NAnt you need one of the following CLR's:</p>
<ul>
<li>Microsoft .NET Framework 1.0</li>
<li>Microsoft .NET Framework 1.1</li>
<li>Microsoft .NET Framework 2.0</li>
<li>Mono 1.x</li>
</ul>
<p><b>Note:</b> Additional requirements may apply to individual tasks.</p>
<h3>Library Dependencies</h3>
<p>NAnt uses a number of open source third&nbsp;party libaries.&nbsp; Recent versions are included included with the NAnt distribution and no extra work is required to install them.&nbsp; More information on these libraries are available at:</p>
<p><img height="9" alt=">" src="../images/bullet.gif" width="5" />&nbsp;<a href="http://nunit.sf.net">NUnit</a> - Required for unit testing</p>
<p><img height="9" alt=">" src="../images/bullet.gif" width="5" />&nbsp;<a href="http://ndoc.sf.net">NDoc</a> - Required for documentation generation</p>
<p><img height="9" alt=">" src="../images/bullet.gif" width="5" />&nbsp;<a href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">SharpZipLib</a> - Required for the zip and unzip tasks</p>
</body>
</html>
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="System Requirements" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>System Requirements</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" 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="index.html">Introduction</a> <img height="9" alt="->" src="../images/arrow.gif" width="13" />
System Requirements
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>System Requirements</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>To use NAnt you need one of the following CLR's:</p>
<ul>
<li>Microsoft .NET Framework 1.0</li>
<li>Microsoft .NET Framework 1.1</li>
<li>Microsoft .NET Framework 2.0</li>
<li>Mono 1.x</li>
</ul>
<p><b>Note:</b> Additional requirements may apply to individual tasks.</p>
<h3>Library Dependencies</h3>
<p>NAnt uses a number of open source third&nbsp;party libaries.&nbsp; Recent versions are included included with the NAnt distribution and no extra work is required to install them.&nbsp; More information on these libraries are available at:</p>
<p><img height="9" alt=">" src="../images/bullet.gif" width="5" />&nbsp;<a href="http://nunit.sf.net">NUnit</a> - Required for unit testing</p>
<p><img height="9" alt=">" src="../images/bullet.gif" width="5" />&nbsp;<a href="http://ndoc.sf.net">NDoc</a> - Required for documentation generation</p>
<p><img height="9" alt=">" src="../images/bullet.gif" width="5" />&nbsp;<a href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">SharpZipLib</a> - Required for the zip and unzip tasks</p>
</body>
</html>

View File

@@ -1,39 +1,39 @@
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Getting Started" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>Getting Started</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" 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="index.html">Introduction</a> <img height="9" alt="->" src="../images/arrow.gif" width="13" />
Getting Started
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>Getting Started</h1>
<p>This topic will show you NAnt building itself.&nbsp; Before you begin make sure your system meets the <a href="fog0000000006.html">system requirements</a>.</p>
<ol>
<li>Download the <a title="NAnt files page on SourceForge" href="http://sourceforge.net/project/showfiles.php?group_id=31650">latest release</a>.</li>
<li>Unzip the distribution into a new folder.</li>
<li>Open a command prompt and change the directory to the folder where NAnt was installed.</li>
<li>Type <span style="white-space: nowrap;"><code>bin\nant</code></span> to build NAnt.</li>
<li>Look at the <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/nant/nant/NAnt.build?rev=HEAD&amp;content-type=text/vnd.viewcvs-markup">NAnt.build</a> file to see how it works.</li>
</ol>
<p>If you did everything correctly you should see something like this:</p>
<p><img height="313" alt="Console output" src="getting-started.gif" width="589" /></p>
</body>
</html>
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="Getting Started" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>Getting Started</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" 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="index.html">Introduction</a> <img height="9" alt="->" src="../images/arrow.gif" width="13" />
Getting Started
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>Getting Started</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>This topic will show you NAnt building itself.&nbsp; Before you begin make sure your system meets the <a href="fog0000000006.html">system requirements</a>.</p>
<ol>
<li>Download the <a title="NAnt files page on SourceForge" href="http://sourceforge.net/project/showfiles.php?group_id=31650">latest source release</a>.</li>
<li>Unzip the distribution into a new folder.</li>
<li>Open a command prompt and change the directory to the folder where NAnt was installed.</li>
<li>Type <span style="white-space: nowrap;"><code>bin\nant</code></span> to build NAnt.</li>
<li>Look at the <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/nant/nant/NAnt.build?rev=HEAD&amp;content-type=text/vnd.viewcvs-markup">NAnt.build</a> file to see how it works.</li>
</ol>
<p>If you did everything correctly you should see something like this:</p>
<p><img height="313" alt="Console output" src="getting-started.gif" width="589" /></p>
</body>
</html>

View File

@@ -1,32 +1,32 @@
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="History" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>History</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" 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="index.html">Introduction</a> <img height="9" alt="->" src="../images/arrow.gif" width="13" />
History
</td>
<td class="NavBar-Cell" align="right">
v0.85
</td>
</tr>
</table>
<h1>History</h1>
<p>The idea for NAnt came from <a title="Hazware home page" href="http://www.hazware.com/xbHome.htm">Hazware's XBuild</a> project which in turn was inspired from&nbsp;<a href="http://jakarta.apache.org/ant/">Apache Ant</a>.&nbsp; After emailing the author for a beta 2 release of the tool and getting no response Gerry Shaw ported the code to .NET beta 2.&nbsp; Due to the number of changes from .NET beta 1 to beta 2 the result was a total rewrite.</p>
<p>NAnt was registered at Source Forge on July 18, 2001 with the first public release made that day.</p>
<p>The name NAnt comes from the fact that this tool is <em>Not</em> Ant.</p>
</body>
</html>
<!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">
<head>
<meta http-equiv="Content-Language" content="en-ca" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="description" content="History" />
<link rel="stylesheet" type="text/css" href="../style.css" />
<title>History</title>
</head>
<body>
<table width="100%" border="0" cellspacing="0" cellpadding="2" class="NavBar">
<tr>
<td class="NavBar-Cell">
<a title="NAnt home page" 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="index.html">Introduction</a> <img height="9" alt="->" src="../images/arrow.gif" width="13" />
History
</td>
<td class="NavBar-Cell" align="right">
v0.91-alpha2
</td>
</tr>
</table>
<h1>History</h1>
<p class="topicstatus">[This is preliminary documentation and subject to change.]</p>
<p>The idea for NAnt came from <a title="Hazware home page" href="http://www.hazware.com/xbHome.htm">Hazware's XBuild</a> project which in turn was inspired from&nbsp;<a href="http://jakarta.apache.org/ant/">Apache Ant</a>.&nbsp; After emailing the author for a beta 2 release of the tool and getting no response Gerry Shaw ported the code to .NET beta 2.&nbsp; Due to the number of changes from .NET beta 1 to beta 2 the result was a total rewrite.</p>
<p>NAnt was registered at Source Forge on July 18, 2001 with the first public release made that day.</p>
<p>The name NAnt comes from the fact that this tool is <em>Not</em> Ant.</p>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More