/[gentoo]/xml/htdocs/doc/en/gentoolkit.xml
Gentoo

Diff of /xml/htdocs/doc/en/gentoolkit.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.9 Revision 1.10
1<?xml version="1.0" encoding="UTF-8"?> 1<?xml version="1.0" encoding="UTF-8"?>
2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/gentoolkit.xml,v 1.9 2004/03/26 12:47:10 cam Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/gentoolkit.xml,v 1.10 2004/03/26 12:58:32 cam Exp $ -->
3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4 4
5<guide link="/doc/en/gentoolkit.xml"> 5<guide link="/doc/en/gentoolkit.xml">
6<title>Gentoolkit</title> 6<title>Gentoolkit</title>
7 7
8<author title="Author"> 8<author title="Author">
9 <mail link="mbutcher@aleph-null.tv">Matt Butcher</mail> 9 <mail link="mbutcher@aleph-null.tv">Matt Butcher</mail>
10</author> 10</author>
11 11
12<author title="Editor"> 12<author title="Editor">
13 <!-- zhen@gentoo.org -->John P. Davis 13 <!-- zhen@gentoo.org -->John P. Davis
14</author> 14</author>
15 15
16<author title="Editor"> 16<author title="Editor">
17 <mail link="erwin@gentoo.org">Erwin</mail> 17 <mail link="erwin@gentoo.org">Erwin</mail>
48-- will benefit from having gentoolkit installed. 48-- will benefit from having gentoolkit installed.
49</p> 49</p>
50 50
51</body> 51</body>
52</section> 52</section>
53 53
54<section> 54<section>
55<title>Installation</title> 55<title>Installation</title>
56<body> 56<body>
57 57
58<p> 58<p>
59Just as with any Gentoo package, installation is just a simple emerge. 59Just as with any Gentoo package, installation is just a simple emerge.
60</p> 60</p>
61 61
62<pre> 62<pre>
63# <i>emerge gentoolkit </i> 63# <i>emerge gentoolkit</i>
64</pre> 64</pre>
65 65
66<note> 66<note>
67Many of the tools in gentoolkit reveal important information about your system 67Many of the tools in gentoolkit reveal important information about your system
68or require root permissions. For that reason, some of the programs may only be 68or require root permissions. For that reason, some of the programs may only be
69executed (or only function properly) if run by a user with root permissions. 69executed (or only function properly) if run by a user with root permissions.
70</note> 70</note>
71 71
72</body> 72</body>
73</section> 73</section>
74 74
75<section> 75<section>
76<title>Finding Documentation</title> 76<title>Finding Documentation</title>
77<body> 77<body>
78 78
79<p> 79<p>
80At the time of this writing, not all of the programs in gentoolkit are well 80At the time of this writing, not all of the programs in gentoolkit are well
81documented. Some have man pages, but not all. Any documentation 81documented. Some have man pages, but not all. Any documentation that a program
82that a program might have (other than man pages) is stored in 82might have (other than man pages) is stored in
83<path>/usr/doc/gentoolkit-[version]/[program-name]/</path>. 83<path>/usr/doc/gentoolkit-[version]/[program-name]/</path>.
84</p> 84</p>
85
85</body> 86</body>
86</section> 87</section>
87</chapter> 88</chapter>
89
88<chapter> 90<chapter>
89<title>Querying Package Data with qpkg</title> 91<title>Querying Package Data with qpkg</title>
90<section> 92<section>
91
92<title>Introduction</title> 93<title>Introduction</title>
93<body> 94<body>
95
96<p>
94<p><c>qpkg</c> is flexible tool for determining information about ebuilds, 97<c>qpkg</c> is a flexible tool for determining information about ebuilds,
95whether installed or not. It can provide information about what files belong 98whether installed or not. It can provide information about what files belong
96to which ebuilds, whether multiple versions of the same package are installed, 99to which ebuilds, whether multiple versions of the same package are installed,
97and what a particular ebuild does. 100and what a particular ebuild does.
98</p> 101</p>
102
103<p>
99<p>Calling <c>qpkg</c> with no arguments prints a list of all ebuilds, with asterisks 104Calling <c>qpkg</c> with no arguments prints a list of all ebuilds, with
100(*) next to the packages that are installed on the system. 105asterisks (*) next to the packages that are installed on the system.
101</p> 106</p>
107
108<note>
102<note>By default, <c>qpkg</c> prints output in color. To turn this off on the command 109By default, <c>qpkg</c> prints output in color. To turn this off on the command
103line, use the <c>--no-color</c> or <c>-nc</c> flag.</note> 110line, use the <c>--no-color</c> or <c>-nc</c> flag.
111</note>
104 112
105</body> 113</body>
106</section> 114</section>
115
107<section> 116<section>
108<title>Querying Package Information</title> 117<title>Querying Package Information</title>
109<body> 118<body>
119
120<p>
110<p>One of the most common uses for <c>qpkg</c> is determining what a given package 121One of the most common uses for <c>qpkg</c> is determining what a given package
111is. For instance, while looking through <path>net-misc</path>, I saw a package 122is. For instance, while looking through <path>net-misc</path>, I saw a package
112called <path>neon</path>. Having no idea what it was, I ran qpkg. 123called <path>neon</path>. Having no idea what it was, I ran qpkg.
113</p> 124</p>
114 125
115<pre> 126<pre>
116hebron root # <i>qpkg -i net-misc/neon 127# <i>qpkg -i net-misc/neon</i>
117net-misc/neon-0.15.3-r1 128net-misc/neon-0.15.3-r1
118 HTTP and WebDAV client library [ http://www.webdav.org/neon ] 129 HTTP and WebDAV client library [ http://www.webdav.org/neon ]
119net-misc/neon-0.18.5 130net-misc/neon-0.18.5
120 HTTP and WebDAV client library [ http://www.webdav.org/neon ] 131 HTTP and WebDAV client library [ http://www.webdav.org/neon ]
121net-misc/neon-0.19.2 132net-misc/neon-0.19.2
122 HTTP and WebDAV client library [ http://www.webdav.org/neon ] 133 HTTP and WebDAV client library [ http://www.webdav.org/neon ]
123net-misc/neon-0.19.2-r1 134net-misc/neon-0.19.2-r1
124 HTTP and WebDAV client library [ http://www.webdav.org/neon ] 135 HTTP and WebDAV client library [ http://www.webdav.org/neon ]
125net-misc/neon-0.21.1 136net-misc/neon-0.21.1
126 HTTP and WebDAV client library [ http://www.webdav.org/neon ] </i> 137 HTTP and WebDAV client library [ http://www.webdav.org/neon ]
127</pre> 138</pre>
128<p> 139
129<c>qpkg</c> read through the ebuild files for the five <path>net-misc/neon</path>
130ebuilds and printed out the information stored in DESCRIPTION and HOMEPAGE.
131</p> 140<p>
132</body> 141<c>qpkg</c> read through the ebuild files for the five
142<path>net-misc/neon</path> ebuilds and printed out the information stored in
143DESCRIPTION and HOMEPAGE.
144</p>
133 145
146</body>
134</section> 147</section>
148
135<section> 149<section>
136<title>Listing Files Belonging to an Ebuild</title> 150<title>Listing Files Belonging to an Ebuild</title>
137<body> 151<body>
152
138<p> 153<p>
139<c>qpkg</c> can also list the files that belong to an installed ebuild. I 154<c>qpkg</c> can also list the files that belong to an installed ebuild. I
140Know that gentoolkit installed several tools, but I don't know what they 155Know that gentoolkit installed several tools, but I don't know what they
141all are. To find out, I can do a <c>qpkg -l</c> 156all are. To find out, I can do a <c>qpkg -l</c>.
142
143</p> 157</p>
158
144<pre> 159<pre>
145hebron portage # <i>qpkg -l app-portage/gentoolkit 160# <i>qpkg -l app-portage/gentoolkit</i>
146app-portage/gentoolkit-0.1.14-r1 * 161app-portage/gentoolkit-0.1.14-r1 *
147CONTENTS: 162CONTENTS:
148/usr 163/usr
149/usr/share 164/usr/share
150/usr/share/gentoolkit 165/usr/share/gentoolkit
151/usr/share/gentoolkit/histogram.awk 166/usr/share/gentoolkit/histogram.awk
152/usr/share/doc 167/usr/share/doc
153/usr/share/doc/gentoolkit-0.1.14-r1 168/usr/share/doc/gentoolkit-0.1.14-r1
154/usr/share/doc/gentoolkit-0.1.14-r1/gentool 169/usr/share/doc/gentoolkit-0.1.14-r1/gentool
155/usr/share/doc/gentoolkit-0.1.14-r1/gentool/ChangeLog.gz 170/usr/share/doc/gentoolkit-0.1.14-r1/gentool/ChangeLog.gz
156/usr/share/doc/gentoolkit-0.1.14-r1/lintool 171/usr/share/doc/gentoolkit-0.1.14-r1/lintool
157/usr/share/doc/gentoolkit-0.1.14-r1/lintool/checklist-for-ebuilds.gz 172/usr/share/doc/gentoolkit-0.1.14-r1/lintool/checklist-for-ebuilds.gz
158/usr/share/doc/gentoolkit-0.1.14-r1/lintool/ChangeLog.gz 173/usr/share/doc/gentoolkit-0.1.14-r1/lintool/ChangeLog.gz
159/usr/share/doc/gentoolkit-0.1.14-r1/etc-update 174/usr/share/doc/gentoolkit-0.1.14-r1/etc-update
160/usr/share/doc/gentoolkit-0.1.14-r1/etc-update/ChangeLog.gz 175/usr/share/doc/gentoolkit-0.1.14-r1/etc-update/ChangeLog.gz
166/usr/bin 181/usr/bin
167/usr/bin/gentool-bump-revision 182/usr/bin/gentool-bump-revision
168/usr/bin/gentool-total-coverage 183/usr/bin/gentool-total-coverage
169/usr/bin/gentool-author-coverage 184/usr/bin/gentool-author-coverage
170/usr/bin/gentool-package-count 185/usr/bin/gentool-package-count
171/usr/bin/qpkg 186/usr/bin/qpkg
172/usr/bin/pkg-size 187/usr/bin/pkg-size
173/usr/bin/lintool 188/usr/bin/lintool
174/usr/sbin 189/usr/sbin
175/usr/sbin/pkg-clean 190/usr/sbin/pkg-clean
176/usr/sbin/mkebuild 191/usr/sbin/mkebuild
177/usr/sbin/emerge-webrsync 192/usr/sbin/emerge-webrsync
178/usr/sbin/epm 193/usr/sbin/epm
179/usr/sbin/etc-update 194/usr/sbin/etc-update
180/etc 195/etc
181/etc/etc-update.conf </i> 196/etc/etc-update.conf
182</pre> 197</pre>
198
183</body> 199</body>
184</section> 200</section>
201
185<section> 202<section>
186<title>Finding the Package from Where a File Came</title> 203<title>Finding the Package from Where a File Came</title>
187<body> 204<body>
188 205
189<p> 206<p>
190To find the package that a file came from, use the <c>-f</c> 207To find the package that a file came from, use the <c>-f</c> or
191or <c>--find-file</c> flag. 208<c>--find-file</c> flag.
192</p> 209</p>
193<pre> 210
194hebron portage # <i>qpkg -fnet-www/mozilla * </i>
195</pre> 211<pre>
212# <i>qpkg -fnet-www/mozilla * </i>
213</pre>
196 214
197</body> 215</body>
198</section> 216</section>
217
199<section> 218<section>
200<title>Listing Duplicate Packages</title> 219<title>Listing Duplicate Packages</title>
201<body> 220<body>
221
202<p> 222<p>
203Sometimes multiple versions of the same package may exist. <c>qpkg --dup</c> 223Sometimes multiple versions of the same package may exist. <c>qpkg --dup</c>
204
205will print a list of duplicate packages. The existence of a duplicate package 224will print a list of duplicate packages. The existence of a duplicate package
206though may not indicate that the older version may be removed. They may fill 225though may not indicate that the older version may be removed. They may fill
207different slots. To look for duplicates in the same slot, use 226different slots. To look for duplicates in the same slot, use
208<c>qpkg --dups --slot</c>. I just updated KDE from 3.0 to 3.0.2, so I have some 227<c>qpkg --dups --slot</c>. I just updated KDE from 3.0 to 3.0.2, so I have some
209duplicates in the same slot. 228duplicates in the same slot.
210</p> 229</p>
230
211<pre> 231<pre>
212hebron portage # <i>qpkg --dups --slot 232# <i>qpkg --dups --slot</i>
213app-portage/gentoolkit 233app-portage/gentoolkit
214kde-base/kdeaddons 234kde-base/kdeaddons
215kde-base/kdeadmin 235kde-base/kdeadmin
216kde-base/kdeartwork 236kde-base/kdeartwork
217kde-base/kdebase 237kde-base/kdebase
218kde-base/kdegames 238kde-base/kdegames
219kde-base/kdelibs 239kde-base/kdelibs
220kde-base/kdemultimedia 240kde-base/kdemultimedia
221kde-base/kdenetwork 241kde-base/kdenetwork
222kde-base/kdetoys 242kde-base/kdetoys
223kde-base/kdeutils 243kde-base/kdeutils
224media-libs/freetype 244media-libs/freetype
225x11-libs/qt </i> 245x11-libs/qt
226</pre> 246</pre>
247
227</body> 248</body>
228</section> 249</section>
250
229<section> 251<section>
230<title>Verifying Package Integrity</title> 252<title>Verifying Package Integrity</title>
231
232<body> 253<body>
254
233<p> 255<p>
234Sometimes it is useful to check a package's integrity to know that files 256Sometimes it is useful to check a package's integrity to know that files have
235have not been replaced since they were installed. <c>qpkg</c> can 257not been replaced since they were installed. <c>qpkg</c> can verify md5 sums as
236verify md5 sums as well as install times to indicate whether or not files 258well as install times to indicate whether or not files for the package might
237for the package might have been corrupted, replaced, or removed. 259have been corrupted, replaced, or removed.
260</p>
261
238</p> 262<p>
239<p>To check both mtimes and md5 sums, use the <c>-c</c> flag.</p> 263To check both mtimes and md5 sums, use the <c>-c</c> flag.
240<pre> 264</p>
241 265
242hebron portage # <i>qpkg gnupg -c -v 266<pre>
267# <i>qpkg gnupg -c -v</i>
243app-crypt/gnupg-1.0.6 * 268app-crypt/gnupg-1.0.6 *
244/usr/lib/gnupg/rndunix !md5! !mtime! 269/usr/lib/gnupg/rndunix !md5! !mtime!
245/usr/lib/gnupg/rndegd !md5! !mtime! 270/usr/lib/gnupg/rndegd !md5! !mtime!
246/usr/lib/gnupg/tiger !md5! !mtime! 271/usr/lib/gnupg/tiger !md5! !mtime!
247/usr/bin/gpg !md5! !mtime! 272/usr/bin/gpg !md5! !mtime!
248/usr/bin/gpgv !md5! !mtime! 273/usr/bin/gpgv !md5! !mtime!
249/usr/share/gnupg/options.skel !md5! !mtime! 274/usr/share/gnupg/options.skel !md5! !mtime!
250/usr/share/gnupg/FAQ !md5! !mtime! 275/usr/share/gnupg/FAQ !md5! !mtime!
251/usr/share/gnupg/faq.html !md5! !mtime! 276/usr/share/gnupg/faq.html !md5! !mtime!
252/usr/share/locale/da/LC_MESSAGES/gnupg.mo !md5! !mtime! 277/usr/share/locale/da/LC_MESSAGES/gnupg.mo !md5! !mtime!
253/usr/share/locale/de/LC_MESSAGES/gnupg.mo !md5! !mtime! 278/usr/share/locale/de/LC_MESSAGES/gnupg.mo !md5! !mtime!
254/usr/share/locale/eo/LC_MESSAGES/gnupg.mo !md5! !mtime! 279/usr/share/locale/eo/LC_MESSAGES/gnupg.mo !md5! !mtime!
255/usr/share/locale/et/LC_MESSAGES/gnupg.mo !md5! !mtime! 280/usr/share/locale/et/LC_MESSAGES/gnupg.mo !md5! !mtime!
256/usr/share/locale/fr/LC_MESSAGES/gnupg.mo !md5! !mtime! 281/usr/share/locale/fr/LC_MESSAGES/gnupg.mo !md5! !mtime!
257/usr/share/locale/id/LC_MESSAGES/gnupg.mo !md5! !mtime! 282/usr/share/locale/id/LC_MESSAGES/gnupg.mo !md5! !mtime!
258/usr/share/locale/it/LC_MESSAGES/gnupg.mo !md5! !mtime! 283/usr/share/locale/it/LC_MESSAGES/gnupg.mo !md5! !mtime!
259/usr/share/locale/ja/LC_MESSAGES/gnupg.mo !md5! !mtime! 284/usr/share/locale/ja/LC_MESSAGES/gnupg.mo !md5! !mtime!
260/usr/share/locale/nl/LC_MESSAGES/gnupg.mo !md5! !mtime! 285/usr/share/locale/nl/LC_MESSAGES/gnupg.mo !md5! !mtime!
261/usr/share/locale/pl/LC_MESSAGES/gnupg.mo !md5! !mtime! 286/usr/share/locale/pl/LC_MESSAGES/gnupg.mo !md5! !mtime!
262/usr/share/locale/pt_BR/LC_MESSAGES/gnupg.mo !md5! !mtime! 287/usr/share/locale/pt_BR/LC_MESSAGES/gnupg.mo !md5! !mtime!
263/usr/share/locale/sv/LC_MESSAGES/gnupg.mo !md5! !mtime! 288/usr/share/locale/sv/LC_MESSAGES/gnupg.mo !md5! !mtime!
264/usr/share/locale/tr/LC_MESSAGES/gnupg.mo !md5! !mtime! 289/usr/share/locale/tr/LC_MESSAGES/gnupg.mo !md5! !mtime!
265/usr/share/info/gpgv.info.gz !md5! !mtime! 290/usr/share/info/gpgv.info.gz !md5! !mtime!
266/usr/share/man/man1/gpg.1.gz !md5! !mtime! 291/usr/share/man/man1/gpg.1.gz !md5! !mtime!
267/usr/share/man/man1/gpgv.1.gz !md5! !mtime! 292/usr/share/man/man1/gpgv.1.gz !md5! !mtime!
26824/92 29324/92
269 294
270app-crypt/gnupg-1.0.7 * 295app-crypt/gnupg-1.0.7 *
2710/101 </i> 2960/101
272</pre> 297</pre>
298
273<p> 299<p>
274As you can see, I have more than one version of GnuPG installed. <c>qpkg</c> 300As you can see, I have more than one version of GnuPG installed. <c>qpkg</c>
275reports that many of the files from the older version have been changed since I 301reports that many of the files from the older version have been changed since I
276installed it. Those packages were most likely modified when I updated 302installed it. Those packages were most likely modified when I updated from
277from <path>gnupg-1.0.6</path> to <path>gnupg-1.0.7</path>. Note that the last two 303<path>gnupg-1.0.6</path> to <path>gnupg-1.0.7</path>. Note that the last two
278lines indicate
279that 0 of 101 files from <path>gnupg-1.0.7</path> have been changed since I 304lines indicate that 0 of 101 files from <path>gnupg-1.0.7</path> have been
280installed. That 305changed since I installed. That is good. If any of them had been changed, I
281is good. If any of them had been changed, I would be worried. 306would be worried.
282</p> 307</p>
283 308
284</body> 309</body>
285</section> 310</section>
311
286<section> 312<section>
287<title>But Wait... There's More</title> 313<title>But Wait... There's More</title>
288<body> 314<body>
315
289<p> 316<p>
290<c>qpkg</c> can be used for other querying tasks that I will not go over here. There 317<c>qpkg</c> can be used for other querying tasks that I will not go over here.
291is a very complete 318There is a very complete manpage for <c>qpkg</c>. Consult that for more
292manpage for <c>qpkg</c>. Consult that for more information. 319information.
293</p> 320</p>
294 321
295</body> 322</body>
296</section> 323</section>
297</chapter> 324</chapter>
325
298<chapter> 326<chapter>
299<title>lintool</title> 327<title>lintool</title>
300<section> 328<section>
301<title>Introduction</title> 329<title>Introduction</title>
302<body> 330<body>
303<p>
304 331
332<p>
333
305<c>lintool</c> is a program that checks ebuild scripts for conformance to 334<c>lintool</c> is a program that checks ebuild scripts for conformance to
306standards and requirements. It is important for ebuild developers to use <c>lintool</c> 335standards and requirements. It is important for ebuild developers to use
307to ensure that they are doing things correctly and not requiring the core team 336<c>lintool</c> to ensure that they are doing things correctly and not requiring
308to do more than they already have to in order to include the ebuild in the Gentoo 337the core team to do more than they already have to in order to include the
309repository. 338ebuild in the Gentoo repository.
310</p> 339</p>
340
311</body> 341</body>
312</section> 342</section>
343
313<section> 344<section>
314<title>Use</title> 345<title>Use</title>
315
316<body> 346<body>
347
317<p> 348<p>
318Running <c>lintool</c> will produce a nicely formatted list of checks and results that 349Running <c>lintool</c> will produce a nicely formatted list of checks and
319it performs. 350results that it performs.
320</p> 351</p>
352
321<pre> 353<pre>
322hebron portage # <i>lintool app-crypt/gnupg/gnupg-1.0.7.ebuild 354# <i>lintool app-crypt/gnupg/gnupg-1.0.7.ebuild</i>
323app-crypt/gnupg/gnupg-1.0.7.ebuild : Not OK 355app-crypt/gnupg/gnupg-1.0.7.ebuild : Not OK
324 356
325------------------------------------------------------------------------------- 357-------------------------------------------------------------------------------
326 Summary for all 1 ebuild(s) checked # errors/warns 358 Summary for all 1 ebuild(s) checked # errors/warns
327 ------------------------------------------------------------------------------- 359 -------------------------------------------------------------------------------
328 Testing for illegal space characters, weird backslash formatting : 0 / 0 360 Testing for illegal space characters, weird backslash formatting : 0 / 0
329 Testing for malformed headers : 0 / 1 361 Testing for malformed headers : 0 / 1
330 Testing for occurence of deprecated try : 0 / 0 362 Testing for occurence of deprecated try : 0 / 0
331 Testing for superfluous A=${P}.tar.gz : 0 / 0 363 Testing for superfluous A=${P}.tar.gz : 0 / 0
332 Testing for empty DEPEND : 0 / 0 364 Testing for empty DEPEND : 0 / 0
333 Testing for empty HOMEPAGE : 0 / 0 365 Testing for empty HOMEPAGE : 0 / 0
334 Testing for empty DESCRIPTION : 0 / 0 366 Testing for empty DESCRIPTION : 0 / 0
335 Testing for presence of env vars : 1 / 1 367 Testing for presence of env vars : 1 / 1
336 Testing for sane USE flag usage : 0 / 0 368 Testing for sane USE flag usage : 0 / 0
337 369
338 Total number of ebuilds with errors : 1 (100%) 370 Total number of ebuilds with errors : 1 (100%)
339 Total number of ebuilds with warnings : 1 (100%) 371 Total number of ebuilds with warnings : 1 (100%)
340</i></pre> 372</pre>
373
341<p> 374<p>
342The first line summarizes whether the ebuild is okay or not. In the case of 375The first line summarizes whether the ebuild is okay or not. In the case of
343<c>gnupg-1.0.7.ebuild</c>, it's not. Reading through the list of checks, we can see 376<c>gnupg-1.0.7.ebuild</c>, it's not. Reading through the list of checks, we can
344that it got a warning for malformed headers and an error for presence of env 377see that it got a warning for malformed headers and an error for presence of env
345vars. 378vars.
346</p> 379</p>
347 380
348<p> 381<p>
349Looking at the ebuild, I see that it is missing a couple of required 382Looking at the ebuild, I see that it is missing a couple of required
350env vars (LICENSE and RDEPEND). Adding those fixes the error. But there are 383env vars (LICENSE and RDEPEND). Adding those fixes the error. But there are
351still two warnings -- one for malformed headers and one for env vars. To help 384still two warnings -- one for malformed headers and one for env vars. To help
352me find those, I can run <c>lintool</c> again with <c>--show-details</c> 385me find those, I can run <c>lintool</c> again with <c>--show-details</c>
353</p> 386</p>
387
354<pre> 388<pre>
355hebron gnupg # <i>lintool --show-details ./gnupg-1.0.7.ebuild 389# <i>lintool --show-details ./gnupg-1.0.7.ebuild</i>
356 390
357------------------------------------------------------------------------------- 391-------------------------------------------------------------------------------
358# Some data cut for brevity.... 392# Some data cut for brevity....
359 393
360 Status for ./gnupg-1.0.7.ebuild 394 Status for ./gnupg-1.0.7.ebuild
361* Testing for malformed headers : passed 395* Testing for malformed headers : passed
362- (W) Has illegal or suspect headers: 396- (W) Has illegal or suspect headers:
363 |Suspect copyright year: # Copyright 1999-2000 Gentoo Technologies, Inc. 397 |Suspect copyright year: # Copyright 1999-2000 Gentoo Technologies, Inc.
364 * Testing for occurence of deprecated try : passed 398 * Testing for occurence of deprecated try : passed
365 * Testing for superfluous A=${P}.tar.gz : passed 399 * Testing for superfluous A=${P}.tar.gz : passed
366 * Testing for empty DEPEND : passed 400 * Testing for empty DEPEND : passed
367 * Testing for empty HOMEPAGE : passed 401 * Testing for empty HOMEPAGE : passed
368 * Testing for empty DESCRIPTION : passed 402 * Testing for empty DESCRIPTION : passed
369 * Testing for presence of env vars : passed 403 * Testing for presence of env vars : passed
370 - (W) Missing SLOT= 404 - (W) Missing SLOT=
371 * Testing for sane USE flag usage : passed 405 * Testing for sane USE flag usage : passed
373 ------------------------------------------------------------------------------- 407 -------------------------------------------------------------------------------
374 Summary for all 1 ebuild(s) checked # errors/warns 408 Summary for all 1 ebuild(s) checked # errors/warns
375 ------------------------------------------------------------------------------- 409 -------------------------------------------------------------------------------
376 Testing for illegal space characters, weird backslash formatting : 0 / 0 410 Testing for illegal space characters, weird backslash formatting : 0 / 0
377 Testing for malformed headers : 0 / 1 411 Testing for malformed headers : 0 / 1
378 Testing for occurence of deprecated try : 0 / 0 412 Testing for occurence of deprecated try : 0 / 0
379 Testing for superfluous A=${P}.tar.gz : 0 / 0 413 Testing for superfluous A=${P}.tar.gz : 0 / 0
380 Testing for empty DEPEND : 0 / 0 414 Testing for empty DEPEND : 0 / 0
381 Testing for empty HOMEPAGE : 0 / 0 415 Testing for empty HOMEPAGE : 0 / 0
382 Testing for empty DESCRIPTION : 0 / 0 416 Testing for empty DESCRIPTION : 0 / 0
383 Testing for presence of env vars : 0 / 1 417 Testing for presence of env vars : 0 / 1
384 Testing for sane USE flag usage : 0 / 0 418 Testing for sane USE flag usage : 0 / 0
385 419
386 Total number of ebuilds with errors : 0 (0%) 420 Total number of ebuilds with errors : 0 (0%)
387 Total number of ebuilds with warnings : 1 (100%) 421 Total number of ebuilds with warnings : 1 (100%)
388</i></pre> 422</pre>
423
424<p>
389<p>Now I can see that the year in the ebuild is probably wrong, and that it is 425Now I can see that the year in the ebuild is probably wrong, and that it is
390missing the SLOT variable. Fixing those eliminates all warnings.</p> 426missing the SLOT variable. Fixing those eliminates all warnings.
427</p>
391 428
392</body> 429</body>
393</section> 430</section>
394</chapter> 431</chapter>
432
395<chapter> 433<chapter>
396
397<title>epm</title> 434<title>epm</title>
398<section> 435<section>
399<title>Introduction</title> 436<title>Introduction</title>
400<body> 437<body>
438
401<p> 439<p>
402<c>epm</c> is a package managing tool that clones Red Hat rpm commands. As it stands 440<c>epm</c> is a package managing tool that clones Red Hat rpm commands. As it
403now, it does not offer all of the features of rpm, but it offers some of the more 441stands now, it does not offer all of the features of rpm, but it offers some of
404powerful rpm query options. 442the more powerful rpm query options.
405</p>
406
407<p> 443</p>
444
445<p>
408It also handles removing packages, which is not covered here. Use <c>epm --help</c> 446It also handles removing packages, which is not covered here. Use <c>epm
409to learn more about deleting packages with <c>epm</c>. 447--help</c> to learn more about deleting packages with <c>epm</c>.
410</p> 448</p>
449
411</body> 450</body>
412</section> 451</section>
413<section> 452<section>
414 453
415<title>Querying Packages with epm</title> 454<title>Querying Packages with epm</title>
416<body> 455<body>
456
417<p> 457<p>
418<c>epm</c> functions with essentially the same command line functions as Red Hat's 458<c>epm</c> functions with essentially the same command line functions as Red
419rpm. <c>epm -qa</c> lists all packages installed. <c>epm -ql</c> lists all the 459Hat's rpm. <c>epm -qa</c> lists all packages installed. <c>epm -ql</c> lists all
420files from a specific ebuild. 460the files from a specific ebuild.
421</p> 461</p>
422 462
423<pre> 463<pre>
424hebron etc # <i>epm -ql ethereal 464# <i>epm -ql ethereal</i>
425/usr/lib/ethereal/plugins/0.8.20/gryphon.so 465/usr/lib/ethereal/plugins/0.8.20/gryphon.so
426/usr/lib/ethereal/plugins/0.8.20/gryphon.la 466/usr/lib/ethereal/plugins/0.8.20/gryphon.la
427/usr/lib/ethereal/plugins/0.8.20/gryphon.a 467/usr/lib/ethereal/plugins/0.8.20/gryphon.a
428/usr/lib/ethereal/plugins/0.8.20/mgcp.so 468/usr/lib/ethereal/plugins/0.8.20/mgcp.so
429/usr/lib/ethereal/plugins/0.8.20/mgcp.la 469/usr/lib/ethereal/plugins/0.8.20/mgcp.la
430/usr/lib/ethereal/plugins/0.8.20/mgcp.a 470/usr/lib/ethereal/plugins/0.8.20/mgcp.a
431/usr/lib/ethereal/plugins/0.8.20/cosnaming.so 471/usr/lib/ethereal/plugins/0.8.20/cosnaming.so
432/usr/lib/ethereal/plugins/0.8.20/cosnaming.la 472/usr/lib/ethereal/plugins/0.8.20/cosnaming.la
433/usr/lib/ethereal/plugins/0.8.20/cosnaming.a 473/usr/lib/ethereal/plugins/0.8.20/cosnaming.a
434/usr/lib/ethereal/plugins/0.8.20/coseventcomm.so 474/usr/lib/ethereal/plugins/0.8.20/coseventcomm.so
435/usr/lib/ethereal/plugins/0.8.20/coseventcomm.la 475/usr/lib/ethereal/plugins/0.8.20/coseventcomm.la
436/usr/lib/ethereal/plugins/0.8.20/coseventcomm.a 476/usr/lib/ethereal/plugins/0.8.20/coseventcomm.a
437/usr/bin/ethereal 477/usr/bin/ethereal
438/usr/bin/editcap 478/usr/bin/editcap
439/usr/bin/mergecap 479/usr/bin/mergecap
449/usr/share/doc/ethereal-0.8.20/AUTHORS.gz 489/usr/share/doc/ethereal-0.8.20/AUTHORS.gz
450/usr/share/doc/ethereal-0.8.20/COPYING.gz 490/usr/share/doc/ethereal-0.8.20/COPYING.gz
451/usr/share/doc/ethereal-0.8.20/NEWS.gz 491/usr/share/doc/ethereal-0.8.20/NEWS.gz
452/usr/share/doc/ethereal-0.8.20/ChangeLog.gz 492/usr/share/doc/ethereal-0.8.20/ChangeLog.gz
453/usr/share/doc/ethereal-0.8.20/README.gz 493/usr/share/doc/ethereal-0.8.20/README.gz
454/usr/share/doc/ethereal-0.8.20/INSTALL.configure.gz 494/usr/share/doc/ethereal-0.8.20/INSTALL.configure.gz
455/usr/share/doc/ethereal-0.8.20/TODO.gz 495/usr/share/doc/ethereal-0.8.20/TODO.gz
456/usr/share/doc/ethereal-0.8.20/README.aix.gz 496/usr/share/doc/ethereal-0.8.20/README.aix.gz
457/usr/share/doc/ethereal-0.8.20/README.bsd.gz 497/usr/share/doc/ethereal-0.8.20/README.bsd.gz
458/usr/share/doc/ethereal-0.8.20/README.hpux.gz 498/usr/share/doc/ethereal-0.8.20/README.hpux.gz
459/usr/share/doc/ethereal-0.8.20/README.irix.gz 499/usr/share/doc/ethereal-0.8.20/README.irix.gz
460/usr/share/doc/ethereal-0.8.20/README.linux.gz 500/usr/share/doc/ethereal-0.8.20/README.linux.gz
461/usr/share/doc/ethereal-0.8.20/README.tru64.gz 501/usr/share/doc/ethereal-0.8.20/README.tru64.gz
462/usr/share/doc/ethereal-0.8.20/README.win32.gz 502/usr/share/doc/ethereal-0.8.20/README.win32.gz
463/usr/share/doc/ethereal-0.8.20/README.vmware.gz 503/usr/share/doc/ethereal-0.8.20/README.vmware.gz
464/etc/ethereal/manuf </i>
465</pre>
466<p>
467<c>epm</c> offers a few advanced query options that are not present in <c>qpkg</c>
468at the
469time of this writing. For instance, it can query for just configuration files or
470just documentation
471files.
472</p>
473<pre>
474
475hebron etc # <i>epm -qc ethereal
476/etc/ethereal/manuf 504/etc/ethereal/manuf
505</pre>
477 506
478hebron etc # epm -qd ethereal 507<p>
508<c>epm</c> offers a few advanced query options that are not present in
509<c>qpkg</c> at the time of this writing. For instance, it can query for just
510configuration files or just documentation files.
511</p>
512
513<pre>
514# <i>epm -qc ethereal</i>
515/etc/ethereal/manuf
516
517# <i>epm -qd ethereal</i>
479/usr/share/man/man1/idl2eth.1.gz 518/usr/share/man/man1/idl2eth.1.gz
480/usr/share/man/man1/tethereal.1.gz 519/usr/share/man/man1/tethereal.1.gz
481/usr/share/man/man1/text2pcap.1.gz 520/usr/share/man/man1/text2pcap.1.gz
482/usr/share/man/man1/editcap.1.gz 521/usr/share/man/man1/editcap.1.gz
483/usr/share/man/man1/ethereal.1.gz 522/usr/share/man/man1/ethereal.1.gz
484/usr/share/man/man1/mergecap.1.gz 523/usr/share/man/man1/mergecap.1.gz
485/usr/share/doc/ethereal-0.8.20/AUTHORS.gz 524/usr/share/doc/ethereal-0.8.20/AUTHORS.gz
486/usr/share/doc/ethereal-0.8.20/COPYING.gz 525/usr/share/doc/ethereal-0.8.20/COPYING.gz
487/usr/share/doc/ethereal-0.8.20/NEWS.gz 526/usr/share/doc/ethereal-0.8.20/NEWS.gz
488/usr/share/doc/ethereal-0.8.20/ChangeLog.gz 527/usr/share/doc/ethereal-0.8.20/ChangeLog.gz
489/usr/share/doc/ethereal-0.8.20/README.gz 528/usr/share/doc/ethereal-0.8.20/README.gz
490/usr/share/doc/ethereal-0.8.20/INSTALL.configure.gz 529/usr/share/doc/ethereal-0.8.20/INSTALL.configure.gz
491/usr/share/doc/ethereal-0.8.20/TODO.gz 530/usr/share/doc/ethereal-0.8.20/TODO.gz
492/usr/share/doc/ethereal-0.8.20/README.aix.gz 531/usr/share/doc/ethereal-0.8.20/README.aix.gz
493/usr/share/doc/ethereal-0.8.20/README.bsd.gz 532/usr/share/doc/ethereal-0.8.20/README.bsd.gz
494/usr/share/doc/ethereal-0.8.20/README.hpux.gz 533/usr/share/doc/ethereal-0.8.20/README.hpux.gz
495/usr/share/doc/ethereal-0.8.20/README.irix.gz 534/usr/share/doc/ethereal-0.8.20/README.irix.gz
496/usr/share/doc/ethereal-0.8.20/README.linux.gz 535/usr/share/doc/ethereal-0.8.20/README.linux.gz
497/usr/share/doc/ethereal-0.8.20/README.tru64.gz 536/usr/share/doc/ethereal-0.8.20/README.tru64.gz
498/usr/share/doc/ethereal-0.8.20/README.win32.gz 537/usr/share/doc/ethereal-0.8.20/README.win32.gz
499/usr/share/doc/ethereal-0.8.20/README.vmware.gz 538/usr/share/doc/ethereal-0.8.20/README.vmware.gz
500</i></pre> 539</pre>
540
501<note> 541<note>
502<c>epm --help</c> lists the options that epm <e>will eventually</e> support. Note, 542<c>epm --help</c> lists the options that epm <e>will eventually</e> support.
503however, that
504options prefixed with asterisks (*) are not yet implemented. 543Note, however, that options prefixed with asterisks (*) are not yet implemented.
505</note> 544</note>
545
506</body> 546</body>
507</section> 547</section>
508</chapter> 548</chapter>
509 549
510<chapter> 550<chapter>
511<title>Others</title> 551<title>Others</title>
512<section> 552<section>
513<title>etc-update</title> 553<title>etc-update</title>
514<body> 554<body>
515<!-- 555<!--
516- Feel free to add more to this. It probably deserves its own chapter, but I don't 556- Feel free to add more to this. It probably deserves its own chapter, but I don't
517- use it, so I can't really write much about it. 557- use it, so I can't really write much about it.
518--> 558-->
559
519<p> 560<p>
520<c>etc-update</c> provides a convenient alternative to updating configuration 561<c>etc-update</c> provides a convenient alternative to updating configuration
521files by hand. After running an emerge that changes configuration files, you 562files by hand. After running an emerge that changes configuration files, you
522can run etc-update to step you through the process of updating all impacted 563can run etc-update to step you through the process of updating all impacted
523configuration files. 564configuration files.
524</p> 565</p>
525 566
526<p> 567<p>
527It is driven by a menu-based interface and includes the ability to view and merge 568It is driven by a menu-based interface and includes the ability to view and
528in config files before deciding what to do. 569merge in config files before deciding what to do.
529</p> 570</p>
571
530</body> 572</body>
531</section> 573</section>
574
532<section> 575<section>
533<title>gentool</title> 576<title>gentool</title>
534<body> 577<body>
578
579<p>
535<p>gentool is a collective name for several small scripts that analyze ebuild 580gentool is a collective name for several small scripts that analyze ebuild
536statistics. 581statistics.
537For instance, gentool-total-coverage prints a list of email addresses and the 582For instance, gentool-total-coverage prints a list of email addresses and the
538number of ebuilds each has in the portage tree. 583number of ebuilds each has in the portage tree.
539</p> 584</p>
540 585
541</body> 586</body>
542</section> 587</section>
588
543<section> 589<section>
544<title>pkg-size</title> 590<title>pkg-size</title>
545<body> 591<body>
592
593<p>
546<p><c>pkg-size</c> prints the size of the installed files in a given package. 594<c>pkg-size</c> prints the size of the installed files in a given package.
547</p> 595</p>
548<pre>
549 596
550hebron portage # <i>pkg-size nmap 597<pre>
598# <i>pkg-size nmap</i>
551net-analyzer/nmap-2.54_beta24-r1 897024 (876KB) </i> 599net-analyzer/nmap-2.54_beta24-r1 897024 (876KB)
552</pre> 600</pre>
601
553</body> 602</body>
554</section> 603</section>
604
555<section> 605<section>
556<title>mkebuild</title> 606<title>mkebuild</title>
557<body> 607<body>
608
609<p>
558<p><c>mkebuild</c> simplifies the process of creating a new ebuild by automating as 610<c>mkebuild</c> simplifies the process of creating a new ebuild by automating as
559much
560of the process as possible. Running <c>mkebuild [filename]</c> will create an 611much of the process as possible. Running <c>mkebuild [filename]</c> will create
561ebuild for that file. the file should be an archive of some kind. As it works, it 612an ebuild for that file. the file should be an archive of some kind. As it
562will provide
563feedback about changes you may need to make. 613works, it will provide feedback about changes you may need to make.
564</p> 614</p>
565 615
566</body> 616</body>
567</section> 617</section>
618
568<section> 619<section>
569<title>emerge-webrsync</title> 620<title>emerge-webrsync</title>
570<body> 621<body>
571<!-- Can't find any documentation on this anywhere... not even a comment in the 622<!-- Can't find any documentation on this anywhere... not even a comment in the
572code. --> 623code. -->
624
625<p>
573<p>Downloads the daily snapshot over HTTP with wget, and (optionally) syncs with 626Downloads the daily snapshot over HTTP with wget, and (optionally) syncs with
574portage. 627portage.
575</p> 628</p>
576</body>
577 629
630</body>
578</section> 631</section>
579</chapter> 632</chapter>
580</guide> 633</guide>
581

Legend:
Removed from v.1.9  
changed lines
  Added in v.1.10

  ViewVC Help
Powered by ViewVC 1.1.20