Max Mahn

aboutsummaryrefslogtreecommitdiff
path: root/doc/mktree.1
blob: eac51f90d592e9f888c96e7d375b0bec34c94775 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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)