#summary Running jGrouseDoc

||Navigation>>||  [Manual Start]  || [WritingDocumentation  Next - Writing Doc Comments] ||[InstallAndSetup Previous - Installation and Configuration] ||
-----

= Running jGrouseDoc =

To run jGrouseDoc from command line, simply start ANT from the your project directory (the one containing build.xml and jgrousedoc.properties):

For Unix:
{{{
/usr/local/projects/mysuperproject>/path/to/ant/bin/ant
}}}

For Windows:
{{{
c:\projects\MySuperProject>\path\to\ant\bin\ant
}}}

where /path/to/ant is the directory with ANT installation.

Of course, it would be much more convenient to add ANT_HOME/bin to your PATH and avoid extra typing every time you want to run it.

Alternatively, you can run ANT from anywhere as long as you specify the location of build.xml:

{{{
c:\projects>ant -f c:\projects\MySuperProject\build.xml
}}}

Also you can pass certain parameters to override values in the configuration file either via environment variables or from command line:

{{{
c:\projects>ant -DinputDir=MyOtherProject/src -f c:\projects\MySuperProject\build.xml
}}}

Note - regardless what is the current directory from which ANT is started, all the relative paths are calculated from the directory containing the build.xml file.


For more information about running ANT see [http://ant.apache.org/manual/index.html ANT Manual]

----
||Navigation>>||  [Manual Start]  || [WritingDocumentation  Next - Writing Doc Comments] ||[InstallAndSetup Previous - Installation and Configuration] ||