From 4b1c0b146c5d5ae4ec77abe7ff1c5f8095ccf5c3 Mon Sep 17 00:00:00 2001 From: emre Date: Sat, 4 Jul 2026 08:04:17 +0300 Subject: [PATCH] added manpage (because no clingon to make it automatically) --- doc/lspack.1 | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++ doc/todo.org | 6 ++++++ lspack.asd | 2 +- 3 files changed, 62 insertions(+), 1 deletion(-) create mode 100644 doc/lspack.1 create mode 100644 doc/todo.org diff --git a/doc/lspack.1 b/doc/lspack.1 new file mode 100644 index 0000000..274f964 --- /dev/null +++ b/doc/lspack.1 @@ -0,0 +1,55 @@ +.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. diff --git a/doc/todo.org b/doc/todo.org new file mode 100644 index 0000000..6017d1d --- /dev/null +++ b/doc/todo.org @@ -0,0 +1,6 @@ +* v0.0.4 + +- [ ] Load user config from $XDG_CONFIG_HOME/lspack/config.lisp +- [ ] Load licenses at compile time +- [ ] Install exe, licenses, manpage +- [ ] Compile with ECL diff --git a/lspack.asd b/lspack.asd index e0ea0ca..5b2b260 100644 --- a/lspack.asd +++ b/lspack.asd @@ -2,7 +2,7 @@ :author "Emre Akan" :description "Quickstart Common Lisp projects" :license "GPL-3.0" - :version "0.0.3" + :version "0.0.4" :depends-on ("uiop") :pathname "src/" :serial t