docs/goals.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 goals - an experimental tool that generalizes “make”
   6
   7 =head1 SUMMARY
   8
   9  goals ['TARGET'] ['VAR=VALUE']
  10        [-C|--directory DIRECTORY] [-d] [-f|--file Goalfile]
  11        [-I|--include DIRECTORY] [--no-prelude]
  12
  13  goals --help
  14
  15  goals -v|--version
  16
  17 =head1 DESCRIPTION
  18
  19 Goals is a command line tool similar in concept to L<make(1)> — a way
  20 to express dependencies between tasks that need to be done.  Goals
  21 generalizes make so it can express dependencies between not just files
  22 but anything such as URLs, remote files, remote builds and more.  It
  23 is also very extensible using only shell scripting, and it fixes many
  24 problems that make suffers from.
  25
  26 This manual page documents the command line tool and options.
  27
  28 There is an introduction and tutorial on writing goal files:
  29 L<Goalfile(5)>.
  30
  31 There is also a reference manual: L<goals-reference(5)>.
  32
  33 =head1 OPTIONS
  34
  35 =over 4
  36
  37 =item B<-h>
  38
  39 =item B<--help>
  40
  41 Display short help summary and exit.
  42
  43 =item B<-C> DIRECTORY
  44
  45 =item B<--directory> DIRECTORY
  46
  47 When goals starts up, and before reading the initial F<Goalfile> or
  48 doing any other processing, goals changes directory.
  49
  50 =item B<-d>
  51
  52 Enable very verbose debugging.
  53
  54 =item B<-f> GOALFILE
  55
  56 =item B<--file> GOALFILE
  57
  58 Set the name of the initial goal file to read.  The default name is
  59 F<Goalfile>.
  60
  61 Note that if a relative path is given here, it is relative to the
  62 directory specified with the I<-C> option, or to the current directory
  63 if I<-C> was not used.
  64
  65 =item B<-I> DIRECTORY
  66
  67 =item B<--include> DIRECTORY
  68
  69 Specify an include directory, used when including goal files using the
  70 C<include> directive.  You can use this option multiple times.  Later
  71 directories have priority over earlier ones.  There is also an
  72 implicit C<%stdlib> directory which is used for prelude files (see
  73 L<goals-reference(5)>).
  74
  75 Note that if a relative path is given here, it is relative to the
  76 directory specified with the I<-C> option, or to the current directory
  77 if I<-C> was not used.
  78
  79 =item B<--no-prelude>
  80
  81 Do not load F<prelude.gl> from C<%stdlib>.  The default is that the
  82 prelude is always loaded automatically before any initial goal file
  83 (but you can redefine prelude definitions in your goal file if you
  84 want).
  85
  86 =back
  87
  88 =head1 SEE ALSO
  89
  90 L<Goalfile(5)>, L<goals-reference(5)>, L<make(1)>.
  91
  92 =head1 AUTHORS
  93
  94 Richard W.M. Jones <rjones@redhat.com>
  95
  96 =head1 COPYRIGHT
  97
  98 Copyright (C) 2020 Richard W.M. Jones
  99
 100 Copyright (C) 2020 Red Hat Inc.
 101
 102 This program is free software; you can redistribute it and/or modify
 103 it under the terms of the GNU General Public License as published by
 104 the Free Software Foundation; either version 2 of the License, or
 105 (at your option) any later version.
 106
 107 This program is distributed in the hope that it will be useful,
 108 but WITHOUT ANY WARRANTY; without even the implied warranty of
 109 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 110 GNU General Public License for more details.
 111
 112 You should have received a copy of the GNU General Public License along
 113 with this program; if not, write to the Free Software Foundation, Inc.,
 114 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.