leiningen/doc/lein.1
2017-01-09 13:47:30 -08:00

84 lines
2 KiB
Groff

.\"to render: groff -Tascii -man doc/lein.1 > lein.man"
.TH LEININGEN 1 "2011 June 30"
.SH NAME
lein \- Automate Clojure projects
.SH SYNOPSIS
.B lein
[\fITASK\fR [\fIARGS\fR]
.SH DESCRIPTION
Leiningen is for automating Clojure projects without setting your hair
on fire.
Working on Clojure projects with tools designed for Java can be an
exercise in frustration. With Leiningen, you just write Clojure.
.SH TASKS
.B lein help
will show the complete list of tasks, while
.B lein help TASK
shows usage for a specific one.
.B lein help tutorial
has a detailed walk-through of the various tasks, but the most
commonly-used are:
.TP
\fBlein new NAME\fR
generate a new project skeleton
.TP
\fBlein test [TESTS]\fR
run the tests in the TESTS namespaces, or all tests
.TP
\fBlein repl\fR
launch an interactive REPL session in a networked REPL server
.TP
\fBlein uberjar\fR
package up the project and its dependencies as a standalone .jar file
.TP
\fBlein install\fR
install a project into your local repository
.TP
\fBlein deploy [REPOSITORY]\fR
deploy a library to a remote repository
.SH CONFIGURATION
Leiningen reads its configuration from the
.B project.clj
file in your project root. Either use
.B lein new
to create a fresh project from which to work, or see the exhaustive
list of configuration options with
.B lein help sample.
You can customize your project map further with profiles; see
.B lein help profiles
.SH BUGS
Check https://github.com/technomancy/leiningen/issues to see if your
problem is a known issue. If not, please open a new issue on that site
or join the mailing list at
https://www.freelists.org/list/leiningen. Please include the output of
.B lein version
as well as your
.B project.clj
file and as much of the relevant code from your project as possible.
.SH COPYING
Copyright
.if t \(co
.if n (C)
2009-2013 Phil Hagelberg and contributors.
Distributed under the Eclipse Public License, the same as Clojure
uses. See the file /usr/share/doc/leiningen/copyright.
.SH AUTHOR
This manpage is written by Phil Hagelberg <technomancy@gmail.com>