aboutsummaryrefslogtreecommitdiff
path: root/docs/man1/license.1
blob: 67cef43934fae202b986acfe303f1625807744b0 (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
.Dd December 09, 2018
.Dt LICENSE 1 URM


.Sh NAME
.Nm license
.Nd Generate software licenses from a rather large list of templates.


.Sh SYNOPSIS
.Nm
.Op Fl email Ar address
.Op Fl license
.Op Fl name Ar name
.Op Fl out
.Op Fl show


.Sh DESCRIPTION
.Nm
is a software license generator. It uses
.Xr git-config 1
to parse out your email and "real name" when relevant for the license template reasons.


.Bl -tag -width " " -offset indent -compact


.It Fl email Ar address
The email of the person licensing the software. This should be your email, or a corporation's email. If in doubt, ask a lawyer what to put here.

The default value for this is derived from
.Xr git-config 1
by using the command:

.Li $ git config user.email

.It Fl license
If set,
.Nm
will show its software license details and then exit.

.It Fl name Ar name
The name of the person licensing the software. This should be your name, or a corporation's name. If in doubt, ask a lawyer what to put here.

The default value for this is derived from
.Xr git-config 1
by using the command:

.Li $ git config user.name

.It Fl out
If this is set,
.Nm
will write the resulting license to the disk instead of standard out.

.It Fl show
If set,
.Nm
will show its list of license templates instead of generating one.

.El


.Sh EXAMPLES

.Li license

.Li license -license

.Li license -show

.Li license mit


.Sh DIAGNOSTICS

.Ex -std license