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
  20
  21 =head1 OPTIONS
  22
  23 =over 4
  24
  25 =item B<-h>
  26
  27 =item B<--help>
  28
  29 Display short help summary and exit.
  30
  31 =item B<-C> DIRECTORY
  32
  33 =item B<--directory> DIRECTORY
  34
  35 When goals starts up, and before reading the initial F<Goalfile> or
  36 doing any other processing, goals changes directory.
  37
  38 =item B<-d>
  39
  40 Enable very verbose debugging.
  41
  42 =item B<-f> GOALFILE
  43
  44 =item B<--file> GOALFILE
  45
  46 Set the name of the initial goal file to read.  The default name is
  47 F<Goalfile>.
  48
  49 Note that if a relative path is given here, it is relative to the
  50 directory specified with the I<-C> option, or to the current directory
  51 if I<-C> was not used.
  52
  53 =item B<-I> DIRECTORY
  54
  55 =item B<--include> DIRECTORY
  56
  57 Specify an include directory, used when including goal files using the
  58 C<include> directive.  You can use this option multiple times.  Later
  59 directories have priority over earlier ones.  There is also an
  60 implicit C<%stdlib> directory which is used for prelude files (see
  61 L<goals-reference(5)>).
  62
  63 Note that if a relative path is given here, it is relative to the
  64 directory specified with the I<-C> option, or to the current directory
  65 if I<-C> was not used.
  66
  67 =item B<--no-prelude>
  68
  69 Do not load F<prelude.gl> from C<%stdlib>.  The default is that the
  70 prelude is always loaded automatically before any initial goal file
  71 (but you can redefine prelude definitions in your goal file if you
  72 want).
  73
  74 =back
  75
  76 =head1 SEE ALSO
  77
  78 L<Goalfile(5)>, L<goals-reference(5)>, L<make(1)>.
  79
  80 =head1 AUTHORS
  81
  82 Richard W.M. Jones <rjones@redhat.com>
  83
  84 =head1 COPYRIGHT
  85
  86 Copyright (C) 2020 Richard W.M. Jones
  87
  88 Copyright (C) 2020 Red Hat Inc.
  89
  90 This program is free software; you can redistribute it and/or modify
  91 it under the terms of the GNU General Public License as published by
  92 the Free Software Foundation; either version 2 of the License, or
  93 (at your option) any later version.
  94
  95 This program is distributed in the hope that it will be useful,
  96 but WITHOUT ANY WARRANTY; without even the implied warranty of
  97 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  98 GNU General Public License for more details.
  99
 100 You should have received a copy of the GNU General Public License along
 101 with this program; if not, write to the Free Software Foundation, Inc.,
 102 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.