BESCHREIBUNG¶
licensecheck - einfache Lizenzprüfung für Quelldateien
ÜBERSICHT¶
licensecheck --help|
--version
licensecheck [
--no-conf] [
--verbose] [
--copyright] [
-l|
--lines=N]
[
-i|
--ignore=regulärer Ausdruck] [
-c|
--check= regulärer Ausdruck]
[
-m|
--machine] [
-r|
--recursive]
Liste zu
prüfender Dateien und Verzeichnisse
BESCHREIBUNG¶
licensecheck versucht die Lizenz zu bestimmen, die für jede ihm
übergebene Datei gilt, indem es am Anfang der Datei nach Text sucht, der
zu verschiedenen Lizenzen gehört.
Falls es sich bei irgendwelchen übergebenen Argumenten um Verzeichnisse
handelt, wird
licensecheck die darin enthaltenen Dateien der zu
verarbeitenden Dateiliste hinzufügen.
OPTIONEN¶
- --verbose, --no-verbose
- gibt an, ob der verarbeitete Text von jeder Datei vor der
entsprechenden Lizenzinformation ausgegeben wird.
Standardmäßig wird nichts ausgegeben.
- -l=N, --lines=N
- gibt an, wie viele Kopfzeilen von jeder Datei für die
Lizenzinformation ausgewertet werden sollen. (Vorgabe ist 60.)
- -i=regulärer Ausdruck,
--ignore=regulärer Ausdruck
- Wenn die Liste der Dateien und Verzeichnisse verarbeitet
wird, wird der durch diese Option angegebene reguläre Ausdruck
verwendet, um diejenigen anzugeben, die nicht berücksichtigt werden
sollen (z.B. Sicherungsdateien, VCS-Metadaten).
- -r, --recursive
- gibt an, dass der Inhalt von Verzeichnissen rekursiv
hinzugefügt werden soll.
- -c=regulärer_Ausdruck,
--check=regulärer_Ausdruck
- gibt ein Muster an, mit dem Dateinamen verglichen werden,
um zu entscheiden, von welchen Dateien die Lizenz geprüft werden
soll.
Die Vorgabe enthält übliche Quelldateien.
- --copyright
- zeigt außerdem den in der Datei gefundenen
Copyright-Text an.
- -m, --machine
- zeigt die Informationen auf eine maschinenlesbare Art, d.h.
in der Form
<Datei><Tabulator><Lizenz>[<Tabulator><Copyright>],
so dass sie einfach sortiert und/oder gefiltert werden können, z.B.
mit den Befehlen awk und sort. Beachten Sie, dass die
Verwendung der Option --verbose die Lesbarkeit zunichte macht.
- --no-conf, --noconf
- liest keine Konfigurationsdateien. Dies kann nur als erste
Option auf der angegebenen Befehlszeile benutzt werden.
KONFIGURATIONSVARIABLEN¶
Die beiden Konfigurationsdateien
/etc/devscripts.conf und
~/.devscripts werden in dieser Reihenfolge durch eine Shell eingelesen,
um Konfigurationsvariablen zu setzen. Befehlszeilenoptionen können
benutzt werden, um Einstellungen aus Konfigurationsdateien außer Kraft zu
setzen. Einstellungen aus Umgebungsvariablen werden zu diesem Zweck ignoriert.
Die derzeit bekannten Variablen sind:
- LICENSECHECK_VERBOSE
- Falls dies auf yes gesetzt ist, ist es so, als ob
der Befehlszeilenparameter --verbose benutzt würde. Die
Vorgabe ist no.
- LICENSECHECK_PARSELINES
- Falls dies auf eine positive Zahl gesetzt ist, wird die
angegebene Anzahl von Zeilen am Anfang jeder Datei gelesen, während
versucht wird, die benutzte(n) Lizenz(en) zu bestimmen. Dies entspricht
der Befehlszeilenoption --lines.
LIZENZ¶
Dieser Code unterliegt dem Copyright von Adam D. Barratt <
adam@adam-barratt.org.uk>, alle Rechte vorbehalten, basierend auf
dem gleichnamigen Skript des KDE-SDK, das unter dem Copyright von <
dfaure@kde.org> steht. Für dieses Programm besteht KEINERLEI
GARANTIE. Es ist Ihnen erlaubt, diesen Code unter den Bedingungen der GNU
General Public License, Version 2 oder neuer, weiterzugeben.
AUTOR¶
Adam D. Barratt <adam@adam-barratt.org.uk>