.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH BUILDPROGRAM "1" "December 2018" "GNU Astronomy Utilities 0.8" "User Commands"
.SH NAME
BuildProgram \- compile, link with Gnuastro library and its dependencies, and run a C program
.SH SYNOPSIS
.B astbuildprog
[\fI\,OPTION\/\fR...] \fI\,C-source \/\fR[\fI\,ARGUMENTS TO RUN\/\fR]
.SH DESCRIPTION
BuildProgram is part of GNU Astronomy Utilities 0.8.
BuildProgram will compile and run a C program, while automatically linking with
libraries that Gnuastro depends on. Hence you do not have to worry about
explicitly linking with CFITSIO for example if you want to work on a FITS file,
or with GSL if you want to use GNU Scientific Library's functions. The standard
compiler options of `\-I', `\-L', and `\-l' are also available for further
customization of the build.
.PP
For more information, please run any of the following commands. In particular
the second contains a very comprehensive explanation of BuildProgram's
invocation: expected input(s), output(s), and a full description of all the
options.
.TP
All options and their values:
$ astbuildprog \fB\-P\fR
.TP
Inputs/Outputs and options:
$ info astbuildprog
.TP
Full section in manual/book:
$ info BuildProgram
.TP
Full Gnuastro manual/book:
$ info gnuastro
.PP
If you couldn't find your answer in the manual, you can get direct help from
experienced Gnuastro users and developers. For more information, please run:
.IP
\f(CW$ info help-gnuastro\fR
.PP
BuildProgram options:
.IP
Input:
.TP
\fB\-a\fR, \fB\-\-la\fR=\fI\,STR\/\fR
Libtool `.la' to use instead of default.
.TP
\fB\-I\fR, \fB\-\-includedir\fR=\fI\,STR\/\fR
Directories to search for `#include's.
.TP
\fB\-l\fR, \fB\-\-linklib\fR=\fI\,STR\/\fR
Link libraries, e.g., for libgsl: `\-lgsl'.
.TP
\fB\-L\fR, \fB\-\-linkdir\fR=\fI\,STR\/\fR
Directory to search for libraries to link.
.TP
\fB\-t\fR, \fB\-\-tag\fR=\fI\,STR\/\fR
Libtool `\-\-tag': programming language.
.IP
Output:
.TP
\fB\-b\fR, \fB\-\-onlybuild\fR
Don't run the built program.
.TP
\fB\-d\fR, \fB\-\-deletecompiled\fR
Delete compiled program after running.
.TP
\fB\-D\fR, \fB\-\-dontdelete\fR
Don't delete output if it exists.
.TP
\fB\-g\fR, \fB\-\-debug\fR
Debugging information in compiled binary.
.TP
\fB\-K\fR, \fB\-\-keepinputdir\fR
Keep input directory for automatic output.
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,STR\/\fR
Output file name.
.TP
\fB\-O\fR, \fB\-\-optimize\fR=\fI\,INT\/\fR
Optimization level: 0, 1, 2, 3.
.TP
\fB\-W\fR, \fB\-\-warning\fR=\fI\,STR\/\fR
Compilation warnings on command\-line.
.IP
Operating modes:
.TP
\-?, \fB\-\-help\fR
give this help list
.TP
\fB\-\-cite\fR
BibTeX citation for this program.
.TP
\fB\-\-config\fR=\fI\,STR\/\fR
Read configuration file STR immediately.
.TP
\fB\-\-lastconfig\fR
Do not parse any more configuration files.
.TP
\fB\-\-onlyversion\fR=\fI\,STR\/\fR
Only run if the program version is STR.
.TP
\fB\-P\fR, \fB\-\-printparams\fR
Print parameter values to be used and abort.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Only report errors, remain quiet about steps.
.TP
\fB\-S\fR, \fB\-\-setdirconf\fR
Set default values for this directory and abort.
.TP
\fB\-\-usage\fR
give a short usage message
.TP
\fB\-U\fR, \fB\-\-setusrconf\fR
Set default values for this user and abort.
.TP
\fB\-V\fR, \fB\-\-version\fR
print program version
.PP
Mandatory or optional arguments to long options are also mandatory or optional
for any corresponding short options.
.PP
GNU Astronomy Utilities home page: http://www.gnu.org/software/gnuastro/
.SH "REPORTING BUGS"
Report bugs to bug\-gnuastro@gnu.org.
.SH COPYRIGHT
Copyright \(co 2015\-2018, Free Software Foundation, Inc.
License GPLv3+: GNU General public license version 3 or later.
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.PP
Written/developed by Mohammad Akhlaghi
.SH "SEE ALSO"
The full documentation for
.B BuildProgram
is maintained as a Texinfo manual.  If the
.B info
and
.B BuildProgram
programs are properly installed at your site, the command
.IP
.B info BuildProgram
.PP
should give you access to the complete manual.