summaryrefslogtreecommitdiff
path: root/man/ninka.1
blob: a0a9b13cb60bec194613d739c762874310f7bf1a (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
79
80
81
82
83
.TH NINKA 1 "JUNE 2011" ninka
.SH NAME
ninka \- source file license identification tool
.SH SYNOPSYS
.SY ninka
.OP \-vfCcSsGgTtLd
.OP \-\-
.RI [ file ]
.YS 

.SH DESCRIPTION

Analyses source files to determine the license they fall under. Takes a source
file as input and outputs the file's license.

.SH OPTIONS

.IP \-v
verbose

.IP \-f
force all processing

.IP \-C
force creation of comments
.IP \-c
stop after creation of comments

.IP \-S
force creation of sentences
.IP \-s
stop after creation of sentences

.IP \-G
force creation of goodsent
.IP \-g
stop after creation of goodsent

.IP \-T
force creation of senttok
.IP \-t
stop after creation of senttok

.IP \-L
force creation of matching

.IP \-d
delete intermediate files

.IP \-\-
Stop processing options

.SH EXAMPLES

.TP
\fBninka\fR \fIfoo.c\fR
Determine the licenses in file foo.c

.TP
.BI ninka\ \-d \ foo.c
Determine the license in file foo.c and delete intermediary files

.TP
find * | xargs \-n1 \-I@ \fBninka\fR '@'
Determine the licenses of files in a directory.


.SH AUTHOR

\fBninka\fR was written by Daniel M. German <dmg@uvic.ca> and Yuki Manabe
<y-manabe@ist.osaka-u.ac.jp>. ninka itself is licensed under the AGPLv3+. This
manpage was written by Ryan Kavanagh <ryanakca@kubuntu.org> for the Debian
project and is also licensed under the AGPLv3+.

.SH SEE ALSO

Daniel M. German, Yuki Manabe and Katsuro Inoue. A sentence-matching method
for automatic license identification of source code files. In 25nd IEEE/ACM
International Conference on Automated Software Engineering (ASE 2010).

You can email Daniel M. German <dmg@uvic.ca> for a copy or download it from
.UR http://turingmachine.org/~dmg/papers/dmg2010ninka.pdf
.UE