diff options
| author | Christine Dodrill <me@christine.website> | 2019-04-01 10:05:03 -0700 |
|---|---|---|
| committer | Christine Dodrill <me@christine.website> | 2019-04-01 10:05:28 -0700 |
| commit | f06f021f402270951f849dde7bee3f3340b8a1d5 (patch) | |
| tree | baee337aab524f162b349d254d21c2d8f2716d44 /docs/man1/license.1 | |
| parent | ba91a17859267201b1d1f0e71da465b1464d940f (diff) | |
| download | x-f06f021f402270951f849dde7bee3f3340b8a1d5.tar.xz x-f06f021f402270951f849dde7bee3f3340b8a1d5.zip | |
reorg
Diffstat (limited to 'docs/man1/license.1')
| -rw-r--r-- | docs/man1/license.1 | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/docs/man1/license.1 b/docs/man1/license.1 new file mode 100644 index 0000000..67cef43 --- /dev/null +++ b/docs/man1/license.1 @@ -0,0 +1,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 |
