|
a/tool/run/plugins/basic/help.html |
|
b/tool/run/plugins/basic/help.html |
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
| 2 |
<html>
|
2 |
<html><head></head>
|
| 3 |
<head>
|
3 |
|
| 4 |
</head>
|
|
|
| 5 |
|
|
|
| 6 |
|
|
|
| 7 |
<body>
|
4 |
<body>
|
| 8 |
|
5 |
|
| 9 |
|
6 |
|
| 10 |
|
7 |
|
| 11 |
|
8 |
|
| 12 |
TripleCheck Studio is a tool to peform software licensing compliance and <a href="http://en.wikipedia.org/wiki/Provenance#Computers_and_law">provenance</a>.
|
9 |
TripleCheck is a set of software tools dedicated to open source software licensing, compliance and <a href="http://en.wikipedia.org/wiki/Provenance#Computers_and_law">provenance</a>.
|
| 13 |
<br>
|
10 |
<br>
|
| 14 |
|
11 |
|
| 15 |
<br>
|
12 |
<br>
|
| 16 |
|
13 |
|
| 17 |
In other words, it is a tool that helps people to discover the licenses
|
14 |
In other words, this tool that helps people to discover the licenses
|
| 18 |
applicable to files and libraries on their projects. The information
|
15 |
applicable to files and libraries on their projects. The information
|
| 19 |
about files is archived using an open data format called SPDX.<br>
|
16 |
about files is archived using an open data format called SPDX.<br>
|
| 20 |
|
17 |
|
| 21 |
|
18 |
|
| 22 |
|
19 |
|
| 23 |
<h3>What is SPDX?</h3>
|
20 |
<h3>What is SPDX?</h3>
|
| 24 |
|
21 |
|
| 25 |
|
22 |
|
| 26 |
|
23 |
|
| 27 |
SPDX means "Standard Package Data Exchange", a plain text file (in
|
24 |
SPDX means "Standard Package Data Exchange", a plain text file (in
|
| 28 |
alternative, XML can be used) with information about the license terms
|
25 |
alternative, XML can be used) with information about the license terms
|
| 29 |
applicable for a given software product. This format is an initiative
|
26 |
applicable for a given software product. This format is an initiative
|
| 30 |
of the Linux Foundation and other companies/people around the world.
|
27 |
of the Linux Foundation and other companies/people around the world.
|
| 31 |
The goal is to standardize the way how people share information about
|
28 |
The goal is to standardize the way how people share information about
|
| 32 |
software licenses. You find more info about SPDX on <a href="http://en.wikipedia.org/wiki/Software_Package_Data_Exchange">wikipedia</a> or visiting the website at <a href="http://spdx.org/">http://spdx.org<br>
|
29 |
software licenses. You find more info about SPDX on <a href="http://en.wikipedia.org/wiki/Software_Package_Data_Exchange">wikipedia</a> or visiting the website at <a href="http://spdx.org/">http://spdx.org<br>
|
| 33 |
|
30 |
|
| 34 |
|
31 |
|
| 35 |
|
32 |
|
| 36 |
</a><br>
|
33 |
</a><br>
|
| 37 |
|
34 |
|
| 38 |
|
35 |
|
| 39 |
|
36 |
|
| 40 |
<h3>What can I do with this tool?</h3>
|
37 |
<h3>What can I do with this tool?</h3>
|
| 41 |
|
38 |
|
| 42 |
|
39 |
|
| 43 |
|
40 |
|
| 44 |
<ol>
|
41 |
<ol>
|
| 45 |
|
42 |
|
| 46 |
|
43 |
|
| 47 |
|
44 |
|
| 48 |
<li>Create new SPDX files from a folder containing your source code</li>
|
45 |
<li>Create new SPDX files from a folder containing your source code</li>
|
| 49 |
|
46 |
|
| 50 |
|
47 |
|
| 51 |
|
48 |
|
| 52 |
<li>Add dependencies (COTS, libraries) with different licenses as part of you code</li>
|
49 |
<li>Add dependencies (COTS, libraries) with different licenses as part of you code</li>
|
| 53 |
|
50 |
|
| 54 |
|
51 |
|
| 55 |
|
52 |
|
| 56 |
<li>Find information using the search bar to find similar files or exact matches</li>
|
53 |
<li>Find information using the search bar to find similar files or exact matches</li>
|
| 57 |
|
54 |
|
| 58 |
|
55 |
|
| 59 |
|
56 |
|
| 60 |
</ol>
|
57 |
</ol>
|
| 61 |
|
58 |
|
| 62 |
|
59 |
|
| 63 |
|
60 |
|
| 64 |
Whenever you have an idea for improvement, you're more than
|
61 |
Whenever you have an idea for improvement, you're more than
|
| 65 |
welcome to write us a message and will get in contact. Our page with up
|
62 |
welcome to write us a message and will get in contact. Our page with up
|
| 66 |
to date contact information can be found on our site through <a href="http://www.triplecheck.de/">this link</a>. See you soon! :-)<br>
|
63 |
to date contact information can be found on our site through <a href="http://www.triplecheck.de/">this link</a>. See you soon! :-)<br>
|
| 67 |
|
64 |
|
| 68 |
|
65 |
|
| 69 |
|
66 |
|
| 70 |
<br>
|
67 |
<br>
|
| 71 |
|
68 |
|
| 72 |
|
69 |
|
| 73 |
|
70 |
|
| 74 |
<h3>Getting started</h3>
|
71 |
<h3>Getting started</h3>
|
| 75 |
|
72 |
|
| 76 |
|
73 |
|
| 77 |
|
74 |
|
| 78 |
When you download this software, the tool should already come available
|
75 |
When you download this software, the tool should already come available
|
| 79 |
with a small library of SPDX documents. We try out best to provide a
|
76 |
with a small library of SPDX documents. We try out best to provide a
|
| 80 |
useful library in the download package but you will be expected to
|
77 |
useful library in the download package but you will be expected to
|
| 81 |
built up your own library based on the components that you are using.
|
78 |
built up your own library based on the components that you are using.
|
| 82 |
Extra points if you share your libraries with us for inclusion in
|
79 |
Extra points if you share your libraries with us for inclusion in
|
| 83 |
future versions of the library. <br>
|
80 |
future versions of the library. <br>
|
| 84 |
|
81 |
|
| 85 |
|
82 |
|
| 86 |
|
83 |
|
| 87 |
<br>
|
84 |
<br>
|
| 88 |
|
85 |
|
| 89 |
|
86 |
|
| 90 |
|
87 |
|
| 91 |
Take your time to browse the items listed on the tree view at the right
|
88 |
Take your time to browse the items listed on the tree view at the right
|
| 92 |
side of the tool. Check what information is reported, what is listed
|
89 |
side of the tool. Check what information is reported, what is listed
|
| 93 |
and what kind of features are available.<br>
|
90 |
and what kind of features are available.<br>
|
| 94 |
|
91 |
|
| 95 |
|
92 |
|
| 96 |
|
93 |
|
| 97 |
<br>
|
94 |
<br>
|
| 98 |
|
95 |
|
| 99 |
|
96 |
|
| 100 |
|
97 |
|
| 101 |
Then, look on the "Tools" item at the bottom of the tree view. From
|
98 |
Then, look on the "Tools" item at the bottom of the tree view. From
|
| 102 |
there you should find the "Create New SPDX" item that allows to create
|
99 |
there you should find the "Create New SPDX" item that allows to create
|
| 103 |
a brand new analysis of your software.<br>
|
100 |
a brand new analysis of your software.<br>
|
| 104 |
|
101 |
|
| 105 |
|
102 |
|
| 106 |
|
103 |
|
| 107 |
<br>
|
104 |
<br>
|
| 108 |
|
105 |
|
| 109 |
|
106 |
|
| 110 |
|
107 |
|
| 111 |
<h3>Using the search box</h3>
|
108 |
<h3>Using the search box</h3>
|
| 112 |
|
109 |
|
| 113 |
|
110 |
|
| 114 |
|
111 |
|
| 115 |
The search box is under continuous improvement, should already be fit
|
112 |
The search box is under continuous improvement, should already be fit
|
| 116 |
to provide most of the information that you need to extract from a
|
113 |
to provide most of the information that you need to extract from a
|
| 117 |
software compliance analysis:<br>
|
114 |
software compliance analysis:<br>
|
| 118 |
|
115 |
|
| 119 |
|
116 |
|
| 120 |
|
117 |
|
| 121 |
<ul>
|
118 |
<ul>
|
| 122 |
|
119 |
|
| 123 |
|
120 |
|
| 124 |
|
121 |
|
| 125 |
<li>Finds files based on exact matches using MD5, SHA1, SHA256 of the file name</li>
|
122 |
<li>Finds files based on exact matches using MD5, SHA1, SHA256 of the file name</li>
|
| 126 |
|
123 |
|
| 127 |
|
124 |
|
| 128 |
|
125 |
|
| 129 |
<li>Finds files based on a percentage of "similarity" using the SSDEEP algorithm</li>
|
126 |
<li>Finds files based on a percentage of "similarity" using the SSDEEP algorithm</li>
|
| 130 |
|
127 |
|
| 131 |
|
128 |
|
| 132 |
|
129 |
|
| 133 |
<li>(more soon to be added)</li>
|
130 |
<li>(more soon to be added)</li>
|
| 134 |
|
131 |
|
| 135 |
|
132 |
|
| 136 |
|
133 |
|
| 137 |
</ul>
|
134 |
</ul>
|
| 138 |
|
135 |
|
| 139 |
|
136 |
|
| 140 |
|
137 |
|
| 141 |
To find files based on specific algorithm, you can type something like this on the search box:<br>
|
138 |
To find files based on specific algorithm, you can type something like this on the search box:<br>
|
| 142 |
|
139 |
|
| 143 |
|
140 |
|
| 144 |
|
141 |
|
| 145 |
<pre>SHA1: f23822b985b89ebb6a1ea989e9d095426b7ab2d9</pre>
|
142 |
<pre>SHA1: f23822b985b89ebb6a1ea989e9d095426b7ab2d9</pre>
|
| 146 |
|
143 |
|
| 147 |
|
144 |
|
| 148 |
|
145 |
|
| 149 |
So, name of the algorithm and then the value that you need. The name of
|
146 |
So, name of the algorithm and then the value that you need. The name of
|
| 150 |
the algorithm can be either on lower or upper case. The value that you
|
147 |
the algorithm can be either on lower or upper case. The value that you
|
| 151 |
are looking should be used in EXACT case match. This is particularly
|
148 |
are looking should be used in EXACT case match. This is particularly
|
| 152 |
important for the similarity matching algorithm where the signature
|
149 |
important for the similarity matching algorithm where the signature
|
| 153 |
cannot be modified.<br>
|
150 |
cannot be modified.<br>
|
| 154 |
|
151 |
|
| 155 |
|
152 |
|
| 156 |
|
153 |
|
| 157 |
<br>
|
154 |
<br>
|
| 158 |
|
155 |
|
| 159 |
<h3>
|
156 |
<h3>
|
| 160 |
Plugin system</h3>
|
157 |
Plugin system</h3>
|
| 161 |
|
158 |
|
| 162 |
This software comes equipped with an advanced plugin system. We use
|
159 |
This software comes equipped with an advanced plugin system. We use
|
| 163 |
script files based in Java language. If you're familiar with PHP, C or
|
160 |
script files based in Java language. If you're familiar with PHP, C or
|
| 164 |
Java, you will feel right at home to change around the
|
161 |
Java, you will feel right at home to change around the
|
| 165 |
software using nothing more than a text editor. If you wish, a
|
162 |
software using nothing more than a text editor. If you wish, a
|
| 166 |
normal Java IDE such as Eclipse or NetBeans can be used to provide the
|
163 |
normal Java IDE such as Eclipse or NetBeans can be used to provide the
|
| 167 |
comfort of programming with automatic code completion. Write us an
|
164 |
comfort of programming with automatic code completion. Write us an
|
| 168 |
email and we'll explain how to get the IDE setup going.<br>
|
165 |
email and we'll explain how to get the IDE setup going.<br>
|
| 169 |
|
166 |
|
| 170 |
<br>
|
167 |
<br>
|
| 171 |
|
168 |
|
| 172 |
Look inside the "plugins" folder to get started and hack away. :-)<br>
|
169 |
Look inside the "plugins" folder to get started and hack away. :-)<br>
|
| 173 |
|
170 |
|
| 174 |
<br>
|
171 |
<br>
|
| 175 |
|
172 |
|
| 176 |
<h3>License and Extension recognition</h3>
|
173 |
<h3>License and Extension recognition</h3>
|
| 177 |
|
174 |
|
| 178 |
Similar to the plugin system, we made available a way for adding up new
|
175 |
Similar to the plugin system, we made available a way for adding up new
|
| 179 |
licenses and extension types. It uses the same Java-based scripts to
|
176 |
licenses and extension types. It uses the same Java-based scripts to
|
| 180 |
process files and detect if the a given license or extension are
|
177 |
process files and detect if the a given license or extension are
|
| 181 |
applicable. <br>
|
178 |
applicable. <br>
|
| 182 |
|
179 |
|
| 183 |
<br>
|
180 |
<br>
|
| 184 |
|
181 |
|
| 185 |
Furthermore, when the tool finds a new file extension that wasn't
|
182 |
Furthermore, when the tool finds a new file extension that wasn't
|
| 186 |
indexed before then it will create a new template. Look inside the
|
183 |
indexed before then it will create a new template. Look inside the
|
| 187 |
folder "extensions/unknown" to see what is automatically generated.
|
184 |
folder "extensions/unknown" to see what is automatically generated.
|
| 188 |
Then, you can edit these files to fill up the details as needed. This
|
185 |
Then, you can edit these files to fill up the details as needed. This
|
| 189 |
way you can teach the software to recognize new extensions and know
|
186 |
way you can teach the software to recognize new extensions and know
|
| 190 |
what to do with them. This is useful to add new source code types that
|
187 |
what to do with them. This is useful to add new source code types that
|
| 191 |
were not added before.<br>
|
188 |
were not added before.<br>
|
| 192 |
|
189 |
|
| 193 |
<br>
|
190 |
<br>
|
| 194 |
|
191 |
|
| 195 |
There is no need for a lengthy manual to lean how to modify these
|
192 |
There is no need for a lengthy manual to lean how to modify these
|
| 196 |
files. Just look at one of the files already created and use it as
|
193 |
files. Just look at one of the files already created and use it as
|
| 197 |
template for the new ones. :-)<br>
|
194 |
template for the new ones. :-)<br>
|
| 198 |
|
195 |
|
| 199 |
<br>
|
196 |
<br>
|
| 200 |
|
197 |
|
| 201 |
We would be grateful if you can help us improve the license and file
|
198 |
We would be grateful if you can help us improve the license and file
|
| 202 |
extension libraries. All you have to do is send back to us your
|
199 |
extension libraries. All you have to do is send back to us your
|
| 203 |
modified files by email and we will add them up for the next release.
|
200 |
modified files by email and we will add them up for the next release.
|
| 204 |
As point of rule, we preserve your name and copyright on the provided
|
201 |
As point of rule, we preserve your name and copyright on the provided
|
| 205 |
files.<br>
|
202 |
files.<br>
|
| 206 |
|
203 |
|
| 207 |
<br>
|
204 |
<br><br><h3>What is the license applicable?</h3>This software is made available under the terms of the European Public License, version 1.1 without the Appendix. <br><br>Unless
|
| 208 |
|
205 |
expressed otherwise, all contents declared under copyright by
|
| 209 |
|
206 |
TripleCheck are covered by the terms of the European Public
|
| 210 |
|
207 |
License, Version 1.1 without the Appendix section. <br><br>Specifically, this means that the Appendix containing the list of compatible licenses is not applicable to this software.<br><br>You find a copy of the EUPL 1.1 Licence at <a href="https://joinup.ec.europa.eu/software/page/eupl" target="_blank">https://joinup.ec.europa.eu/software/page/eupl</a><br><br><br>This
|
|
|
208 |
software contains libraries and other resources developed by third
|
|
|
209 |
party authors. We maintain an up to date list of these resources at <a href="http://opensourceprojects.eu/p/triplecheck/wiki/Third%20party%20resources/" target="_blank">this page</a>.<br><br>
|
|
|
210 |
|
|
|
211 |
|
|
|
212 |
|
| 211 |
<h3>Feedback?</h3>
|
213 |
<h3>Feedback?</h3>
|
| 212 |
|
214 |
|
| 213 |
|
215 |
|
| 214 |
This tool is quite young. Development moves at great speed since we use
|
216 |
This tool is quite young. Development moves at great speed since we use
|
| 215 |
it on for our own work at TripleCheck. However, what is necessary for
|
217 |
it on for our own work at TripleCheck. However, what is necessary for
|
| 216 |
our use-case scenario might not necessary meet what you need.<br>
|
218 |
our use-case scenario might not necessary meet what you need.<br>
|
| 217 |
|
219 |
|
| 218 |
|
220 |
|
| 219 |
|
221 |
|
| 220 |
<br>
|
222 |
<br>
|
| 221 |
|
223 |
|
| 222 |
|
224 |
|
| 223 |
|
225 |
|
| 224 |
If you miss some specific feature or something is not working good, don't worry. Just write us a message
|
226 |
If you miss some specific feature or something is not working good, don't worry. Just write us a message
|
| 225 |
so that we know which features matter the most to fix or implement.
|
227 |
so that we know which features matter the most to fix or implement.
|
| 226 |
<br>
|
228 |
<br>
|
| 227 |
|
229 |
|
| 228 |
<br>
|
230 |
<br>
|
| 229 |
|
231 |
|
| 230 |
You find us at <a href="http://www.triplecheck.de/">http://www.triplecheck.de/</a><br>
|
232 |
You find us at <a href="http://www.triplecheck.de/">http://www.triplecheck.de/</a><br>
|
| 231 |
|
233 |
|
| 232 |
<br>
|
234 |
<br>
|
| 233 |
|
235 |
|
| 234 |
<br>
|
236 |
<br>
|
| 235 |
|
237 |
|
| 236 |
Above all, have fun! :-)
|
238 |
Above all, have fun! :-)
|
| 237 |
</body>
|
239 |
</body></html> |
| 238 |
</html>
|
|
|