-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpkglint.1.html
127 lines (127 loc) · 4.93 KB
/
pkglint.1.html
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
pkglint(1) manual page
See COPYING and COPYRIGHT files for corresponding information.
-->
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
<title>PKGLINT(1)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">PKGLINT(1)</td>
<td class="head-vol">General Commands Manual</td>
<td class="head-rtitle">PKGLINT(1)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">pkglint</code> — <span class="Nd">detect
common mistakes and stylistic issues in pkgsrc package
definitions</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<table class="Nm">
<tr>
<td><code class="Nm">pkglint</code></td>
<td>[<code class="Fl">-dhijsvw</code>] [<var class="Ar">pkgsrc
...</var>]</td>
</tr>
</table>
<br/>
<table class="Nm">
<tr>
<td><code class="Nm">pkglint</code></td>
<td>[<code class="Fl">-dhijsvw</code>] <code class="Fl">-R</code>
[<var class="Ar">pkgsrc-collection ...</var>]</td>
</tr>
</table>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">pkglint</code> utility runs a series of
checks on one or more pkgsrc directories to detect common mistakes and
stylistic issues in package source. <code class="Nm">pkglint</code> follows
the requirements of <a class="Xr" href="Pkgfile.5.html">Pkgfile(5)</a>
manual page, but also contains additional checks.</p>
<p class="Pp">The options are as follows:</p>
<dl class="Bl-tag">
<dt id="d"><a class="permalink" href="#d"><code class="Fl">-d</code></a>,
<code class="Fl">--dead-links</code></dt>
<dd>Check “Pkgfile” and “README{,.md}” files for
dead links.</dd>
<dt id="i"><a class="permalink" href="#i"><code class="Fl">-i</code></a>,
<code class="Fl">--invalid</code></dt>
<dd>Check “.footprint” file for invalid directories, like
<span class="Pa">/usr/local</span>,
<span class="Pa">/usr/share/locale</span>,
<span class="Pa">/usr/share/doc</span>,
<span class="Pa">/usr/share/info</span>, etc.</dd>
<dt id="j"><a class="permalink" href="#j"><code class="Fl">-j</code></a>,
<code class="Fl">--junk</code></dt>
<dd>Check “.footprint” file for junk files, like
“README”, “TODO”, “NEWS”,
etc.</dd>
<dt id="s"><a class="permalink" href="#s"><code class="Fl">-s</code></a>,
<code class="Fl">--suid-sgid</code></dt>
<dd>Check “.footprint” file for SUID/SGID files and
directories.</dd>
<dt id="w"><a class="permalink" href="#w"><code class="Fl">-w</code></a>,
<code class="Fl">--world-writeable</code></dt>
<dd>Check “.footprint” file for world-writeable files and
directories.</dd>
<dt id="R"><a class="permalink" href="#R"><code class="Fl">-R</code></a>,
<code class="Fl">--recursive</code></dt>
<dd>Search for and check pkgsrc directories recursively.</dd>
<dt id="v"><a class="permalink" href="#v"><code class="Fl">-v</code></a>,
<code class="Fl">--version</code></dt>
<dd>Print version and exit.</dd>
<dt id="h"><a class="permalink" href="#h"><code class="Fl">-h</code></a>,
<code class="Fl">--help</code></dt>
<dd>Print help and exit.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="EXIT_STATUS"><a class="permalink" href="#EXIT_STATUS">EXIT
STATUS</a></h1>
<p class="Pp">The <code class="Nm">pkglint</code> utility exits 0 on
success, and >0 if an error occurs.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
<p class="Pp">Lint package source located in the current/working directory:</p>
<div class="Bd Pp Bd-indent Li">
<pre>$ pwd
/usr/src/pkgsrc-core/acl
$ pkglint -dijsw</pre>
</div>
<p class="Pp">Lint specific package source:</p>
<div class="Bd Pp Bd-indent Li">
<pre>$ pkglint -dijsw /usr/src/pkgsrc-core/acl</pre>
</div>
<p class="Pp">Lint all pkgsrc-core collection recursively:</p>
<div class="Bd Pp Bd-indent Li">
<pre>$ pkglint -dijsw -R /usr/src/pkgsrc-core</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<p class="Pp"><a class="Xr" href="finddepslinked.1.html">finddepslinked(1)</a>,
<a class="Xr" href="findredundantdeps.1.html">findredundantdeps(1)</a></p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">September 3, 2023</td>
<td class="foot-os">Zeppe-Lin</td>
</tr>
</table>
</body>
</html>