X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=docs%2Fgoals.pod;h=e2b1af161d161205b95cc59329ba1077fd16da54;hb=5d9a5933e6271800eeb063a87c81be63e70eb20c;hp=eca8876bd2077593404c63f8d0a1da8dcfb403c1;hpb=00dfdab0481c531b8608a157dc4c4991f319d7f7;p=goals.git diff --git a/docs/goals.pod b/docs/goals.pod index eca8876..e2b1af1 100644 --- a/docs/goals.pod +++ b/docs/goals.pod @@ -2,13 +2,13 @@ =head1 NAME -goals - an experimental tool that generalizes "make" +goals - an experimental tool that generalizes “make” =head1 SUMMARY goals ['TARGET'] ['VAR=VALUE'] [-C|--directory DIRECTORY] [-d] [-f|--file Goalfile] - [-I|--include DIRECTORY] [--no-prelude] + [-I|--include DIRECTORY] [-j|--jobs JOBS] [--no-prelude] goals --help @@ -16,7 +16,19 @@ goals - an experimental tool that generalizes "make" =head1 DESCRIPTION +Goals is a command line tool similar in concept to L — a way +to express dependencies between tasks that need to be done. Goals +generalizes make so it can express dependencies between not just files +but anything such as URLs, remote files, remote builds and more. It +is also very extensible using only shell scripting, and it fixes many +problems that make suffers from. +This manual page documents the command line tool and options. + +There is an introduction and tutorial on writing goal files: +L. + +There is also a reference manual: L. =head1 OPTIONS @@ -64,6 +76,15 @@ Note that if a relative path is given here, it is relative to the directory specified with the I<-C> option, or to the current directory if I<-C> was not used. +=item B<-j> JOBS + +=item B<--jobs> JOBS + +Set the maximum number of commands that can run at the same time. +Unlike make, goals defaults to running in parallel, setting the +default to the number of cores on the machine. To disable parallel +jobs, you must use S>. + =item B<--no-prelude> Do not load F from C<%stdlib>. The default is that the