leiningen/doc/lein.1

85 lines
2 KiB
Groff
Raw Normal View History

2011-10-06 15:02:55 +00:00
.\"to render: groff -Tascii -man doc/lein.1 > lein.man"
2011-07-01 17:48:29 +00:00
.TH LEININGEN 1 "2011 June 30"
.SH NAME
lein \- Automate Clojure projects
2011-07-01 17:48:29 +00:00
.SH SYNOPSIS
.B lein
2013-11-20 05:03:11 +00:00
[\fITASK\fR [\fIARGS\fR]
2011-07-01 17:48:29 +00:00
.SH DESCRIPTION
Leiningen is for automating Clojure projects without setting your hair
on fire.
2011-07-01 17:48:29 +00:00
Working on Clojure projects with tools designed for Java can be an
exercise in frustration. With Leiningen, you just write Clojure.
2011-07-01 17:48:29 +00:00
.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
2013-11-20 05:03:11 +00:00
launch an interactive REPL session in a networked REPL server
2011-07-01 17:48:29 +00:00
.TP
2013-11-20 05:03:11 +00:00
\fBlein uberjar\fR
package up the project and its dependencies as a standalone .jar file
2011-07-01 17:48:29 +00:00
.TP
2013-11-20 05:03:11 +00:00
\fBlein install\fR
2012-01-13 00:10:32 +00:00
install a project into your local repository
2013-11-20 05:03:11 +00:00
.TP
\fBlein deploy [REPOSITORY]\fR
deploy a library to a remote repository
2011-07-01 17:48:29 +00:00
.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.
2013-11-20 05:03:11 +00:00
You can customize your project map further with profiles; see
.B lein help profiles
2011-07-01 17:48:29 +00:00
.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
2013-11-20 05:03:11 +00:00
http://librelist.com/leiningen/. Please include the output of
2011-07-01 17:48:29 +00:00
.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)
2013-11-20 05:03:11 +00:00
2009-2013 Phil Hagelberg and contributors.
2011-07-01 17:48:29 +00:00
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>