ats-pkg-2.3.0.0: man/atspkg.1

.\" Automatically generated by Pandoc 2.1.1
.\"
.TH "atspkg (1)" "" "" "" ""
.hy
.SH NAME
.PP
atspkg \- a build tool for ATS
.SH DESCRIPTION
.PP
\f[B]atspkg\f[] is a build tool for the ATS2 language, written in
Haskell.
.SH SYNOPSIS
.PP
atspkg build
.PP
atspkg install
.PP
atspkg clean
.PP
atspkg test
.SH SUBCOMMANDS
.PP
\f[B]build\f[] \- Build all binary targets listed in atspkg.dhall
.PP
\f[B]test\f[] \- Run all tests listed in atspkg.dhall
.PP
\f[B]clean\f[] \- Clean current project directory
.PP
\f[B]nuke\f[] \- Remove all local files installed by \f[B]atspkg\f[]
.PP
\f[B]remote\f[] \- Download a tarball from the given URL and try to
build its binary targets
.PP
\f[B]install\f[] \- Install binary targets to $HOME/.local/bin and
relevant manpages to $HOME/.local/share/man/man1
.PP
\f[B]upgrade\f[] \- Download the latest binary release of
\f[B]atspkg\f[], if available
.PP
\f[B]valgrind\f[] \- Run \f[B]valgrind\f[] on the generated binary
.PP
\f[B]run\f[] \- Run the generated binary
.SS OPTIONS
.TP
.B \f[B]\-h\f[] \f[B]\-\-help\f[]
Display help
.RS
.RE
.TP
.B \f[B]\-V\f[] \f[B]\-\-version\f[]
Display version information
.RS
.RE
.TP
.B \f[B]\-c\f[] \f[B]\-\-no\-cache\f[]
Ignore cached configuration file
.RS
.RE
.TP
.B \f[B]\-r\f[], \f[B]\-\-rebuild\f[]
Rebuild all binary targets.
.RS
.RE
.SH CONFIGURATION
.PP
\f[B]atspkg\f[] is configured with Dhall, in an atspkg.dhall file.
\f[B]atspkg\f[] can be configured to produce binary targets (possibly
linked against Haskell libraries), as well as plain C targets.
.SS TEMPLATES
.PP
There are several template avaiable for \f[B]pi\f[] as well (see
https://crates.io/crates/project_init for more details).
A couple examples:
.IP
.nf
\f[C]
pi\ new\ ats\ project
\f[]
.fi
.IP
.nf
\f[C]
pi\ git\ vmchale/haskell\-ats\ ambitious\-project
\f[]
.fi
.SH BUGS
.PP
Please report any bugs you may come across to
https://github.com/vmchale/atspkg/issues (for issues in atspkg proper)
or https://hub.darcs.net/vmchale/ats/issues (for issues in supporting
libraries).
.SH COPYRIGHT
.PP
Copyright 2018.
Vanessa McHale.
All Rights Reserved.
.SH AUTHORS
Vanessa McHale<vamchale@gmail.com>.