stdlib: Implement dirname(), basename() and extension() functions.

[goals.git] / docs / goals.pod

diff --git a/docs/goals.pod b/docs/goals.pod
index c94cadb..cf67a45 100644 (file)
--- a/docs/goals.pod
+++ b/docs/goals.pod
@@ -8,7 +8,8 @@ goals - an experimental tool that generalizes “make”
 
  goals ['TARGET'] ['VAR=VALUE']
        [-C|--directory DIRECTORY] [-d] [-f|--file Goalfile]
 
  goals ['TARGET'] ['VAR=VALUE']
        [-C|--directory DIRECTORY] [-d] [-f|--file Goalfile]

-       [-I|--include DIRECTORY] [--no-prelude]
+       [-I|--include DIRECTORY] [-j|--jobs JOBS] [--no-prelude]
+       [-s|--silent|--quiet]

 
  goals --help
 
 
  goals --help
 


@@ -25,10 +26,8 @@ problems that make suffers from.
 
 This manual page documents the command line tool and options.
 
 
 This manual page documents the command line tool and options.
 

-There is an introduction and tutorial on writing goal files:
-L<Goalfile(5)>.
-
-There is also a reference manual: L<goals-reference(5)>.
+There is an introduction to and tutorial on writing goal files, as
+well as a reference manual in L<Goalfile(5)>.

 
 =head1 OPTIONS
 
 
 =head1 OPTIONS
 


@@ -69,13 +68,21 @@ if I<-C> was not used.
 Specify an include directory, used when including goal files using the
 C<include> directive.  You can use this option multiple times.  Later
 directories have priority over earlier ones.  There is also an
 Specify an include directory, used when including goal files using the
 C<include> directive.  You can use this option multiple times.  Later
 directories have priority over earlier ones.  There is also an

-implicit C<%stdlib> directory which is used for prelude files (see
-L<goals-reference(5)>).
+implicit C<%stdlib> directory which is used for prelude files.

 
 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.
 
 
 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<I<-j 1>>.
+

 =item B<--no-prelude>
 
 Do not load F<prelude.gl> from C<%stdlib>.  The default is that the
 =item B<--no-prelude>
 
 Do not load F<prelude.gl> from C<%stdlib>.  The default is that the


@@ -83,11 +90,20 @@ prelude is always loaded automatically before any initial goal file
 (but you can redefine prelude definitions in your goal file if you
 want).
 
 (but you can redefine prelude definitions in your goal file if you
 want).
 

+=item B<-s>
+
+=item B<--silent>
+
+=item B<--quiet>
+
+Don't print the shell commands that are run.  This is the same as
+turning all S<C<{ CODE }>> sections into S<C<@{ CODE }>> sections.
+

 =back
 
 =head1 SEE ALSO
 
 =back
 
 =head1 SEE ALSO
 

-L<Goalfile(5)>, L<goals-reference(5)>, L<make(1)>.
+L<Goalfile(5)>, L<make(1)>.

 
 =head1 AUTHORS
 
 
 =head1 AUTHORS