56 lines
1.5 KiB
Groff
56 lines
1.5 KiB
Groff
.TH LSPACK 1
|
|
.SH NAME
|
|
lspack \- Initializes Common Lisp projects
|
|
.SH SYNOPSIS
|
|
.B lspack
|
|
.IR project\-name
|
|
[\fB\-a\fR \fIauthor\fR]
|
|
[\fB\-l\fR \fIlicense\fR]
|
|
[\fB\-r\fR \fIroot\-directory\fR]
|
|
.SH DESCRIPTION
|
|
.B lspack
|
|
creates common project files like an asd system definition file and license.
|
|
.SH OPTIONS
|
|
.TP
|
|
.BR \-a ", " \-\-author\ \fIauthor\fR
|
|
Author of the project.
|
|
.TP
|
|
.BR \-l ", " \-\-license\ \fIlicense\fR
|
|
License of the project. Valid options are: \fBmit\fR, \fBgpl3+\fR, \fBapache2\fR,
|
|
\fBunlicense\fR, \fBbsd2\fR and \fBbsd3\fR.
|
|
.TP
|
|
.BR \-r ", " \-\-root\ \fIroot-directory\fR
|
|
Root directory of the project. If not supplied, it is the same as project name.
|
|
.SH EXAMPLES
|
|
The following example creates the project root directory "my-project/"
|
|
as well as files like "my-project.asd" and "LICENSE". A package named
|
|
:my-project will also will be in "package.lisp" which might be in
|
|
project root or "src/" depending on your configuration.
|
|
.PP
|
|
.nf
|
|
.RS
|
|
lspack my-project -a "Jane Doe" -l mit
|
|
.RE
|
|
.fi
|
|
.PP
|
|
If you already created the project directory and are inside it, you might
|
|
supply the root directory to be the current directory.
|
|
.PP
|
|
.nf
|
|
.RS
|
|
lspack my-project -r .
|
|
.RE
|
|
.fi
|
|
.PP
|
|
\" .SH FILES
|
|
\" .TP
|
|
\" .BR $XDG_CONFIG_HOME/lspack/config.lisp
|
|
\" Configuration file. Defaults can be defined for values like author to
|
|
\" omit them from command line arguments.
|
|
\" .TP
|
|
\" .BR $XDG_DATA_HOME/lspack/
|
|
\" Contains license templates which can be loaded at run time if they
|
|
\" weren't loaded at compile time.
|
|
.SH AUTHOR
|
|
Written by Emre Akan.
|