aboutsummaryrefslogtreecommitdiff
path: root/lv2lint.1.in
blob: 4943438baae705cadd7f6aab465be5b0cccea920 (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
84
85
86
87
88
89
90
91
92
93
94
.TH LV2LINT "1" "Jan 13, 2020"

.SH NAME
lv2lint \- an LV2 lintian

.SH SYNOPSIS
.B lv2lint
[\fIOPTIONS\fR] {\fIPLUGIN_URI\fR}*

.SH DESCRIPTION
\fBlv2lint\fP checks whether given LV2 plugins are up to the specification.
.PP
It not only checks the *.ttl, but actually loads plugins (and their UIs) and
checks whether required features and exposed extensions actually match between
binary and *.ttl.
.PP
It thus finds errors that cannot readily be found by just checking the *.ttl
for validity.
.PP
It is good practice to run it over your plugins as part of your continuous
integration after checking them for validity with \fBsord_validate\fP and
before releasing them to the public

.SH OPTIONS
.HP
\fB\-v\fR
.IP
Print version and license information

.HP
\fB\-h\fR
.IP
Print usage information

.HP
\fB\-q\fR
.IP
Quiet mode, show only a summary

.HP
\fB\-d\fR
.IP
Show verbose test item documentation

@MAN@.HP
@MAN@\fB\-o\fR
@MAN@.IP
@MAN@Run online test items

@MAN@.HP
@MAN@\fB\-m\fR
@MAN@.IP
@MAN@Create mail to plugin author

@MAN@.HP
@MAN@\fB\-g\fR GREETER
@MAN@.IP
@MAN@Custom mail greeter

.HP
\fB\-I\fR INCLUDE_DIR
.IP
Apart from default LV2 plugin install paths, use include directory to search
for plugins

.HP
\fB\-M\fR (no)pack (Default: pack)
.IP
Modes to enable/disable, e.g. (pack)ager mode skips some fatal tests for
distribution packagers that are important only for freely distributed binaries.

If you are a distribution packager, preferebly run with '-M pack' (Default).
If you want to build binaries for distributing, preferably run with -M nopack.

.HP
\fB\-S\fR (no)warn|note|pass|all (Default: fail|warn)
.IP
Apart from errors alone (fail), also show warnings (warn), notes (note),
passes (pass) or all (all) on console. The no- prefix inverts the meaning.

.HP
\fB\-E\fR (no)warn|note|all (Default: fail)
.IP
Apart from errors alone (fail), also treat warnings (warn), notes (note)
or all (all) as errors. The no- prefix inverts the meaning.

.SH LICENSE
Artistic License 2.0.

.SH AUTHOR
Hanspeter Portner (dev@open-music-kontrollers.ch).

.SH SEE ALSO
sord_validate(1)