Max Mahn

aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/mktree.162
1 files changed, 62 insertions, 0 deletions
diff --git a/doc/mktree.1 b/doc/mktree.1
new file mode 100644
index 0000000..eac51f9
--- /dev/null
+++ b/doc/mktree.1
@@ -0,0 +1,62 @@
+.TH MKTREE 1 2026-03-21 mktree-0.0
+
+.SH NAME
+
+mktree - a simple project setup utility
+
+
+.SH SYNOPSYS
+
+.B mktree
+.RI [ options "] <" template "> <" name "> [" args "]..."
+
+.B mktree -f
+.RI < "template path" "> [" options "] <" name "> [" args "]..."
+
+
+.SH DESCRIPTION
+
+.B mktree
+is an extensible tool for quickly setting up new projects using templates.
+Setup hooks can be specified in the .setup.sh file in the template directory
+for more advanced project configuration.
+
+
+.SH OPTIONS
+
+##insert awk -v OUTPUT=man -f args.awk res/args
+
+
+.SH EXIT STATUS
+
+By default, mktree will have an exit code of 0.
+It will return non-zero on error.
+
+
+.SH ENVIRONMENT
+
+.TP
+XDG_CONFIG_HOME
+Path to the user-local configuration directory, see “FILES”. Defaults to
+.IR ~/.config .
+
+.SH FILES
+
+.TP
+.I TEMPLATE_ROOT/.setup.sh
+A shell script that is run in the new project directory after the template
+skeleton is copied. It does not have to be maked as executable.
+
+.TP
+.I $XDG_CONFIG_HOME/mktree/skel
+User-local project templates.
+
+.TP
+.I /etc/mktree/skel
+System-global project templates.
+
+.SH SEE ALSO
+
+cp(1)
+
+