Debian Codegraph @

upstream/mageia-cauldron/man1/rpmorphan.1

raw
1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 . if \nF \{\
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{\
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
75 .if n \{\
76 . ds #H 0
77 . ds #V .8m
78 . ds #F .3m
79 . ds #[ \f1
80 . ds #] \fP
81 .\}
82 .if t \{\
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 . ds #V .6m
85 . ds #F 0
86 . ds #[ \&
87 . ds #] \&
88 .\}
89 . \" simple accents for nroff and troff
90 .if n \{\
91 . ds ' \&
92 . ds ` \&
93 . ds ^ \&
94 . ds , \&
95 . ds ~ ~
96 . ds /
97 .\}
98 .if t \{\
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 . ds : e
123 . ds 8 ss
124 . ds o a
125 . ds d- d\h'-1'\(ga
126 . ds D- D\h'-1'\(hy
127 . ds th \o'bp'
128 . ds Th \o'LP'
129 . ds ae ae
130 . ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "RPMORPHAN 1"
136 .TH RPMORPHAN 1 "2018-09-13" "perl v5.26.2" "User Contributed Perl Documentation"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 rpmorphan \- find orphaned packages
143 .SH "DESCRIPTION"
144 .IX Header "DESCRIPTION"
145 rpmorphan finds \*(L"orphaned\*(R" packages on your system. It determines which packages have no other
146 packages depending on their installation, and shows you a list of these packages.
147 It is clone of deborphan debian software for rpm packages.
148 .PP
149 It will try to help you to remove unused packages, for exemple :
150 .PP
151 \&\- after a distribution upgrade
152 .PP
153 \&\- when you want to suppress packages after some tests
154 .SH "SYNOPSIS"
155 .IX Header "SYNOPSIS"
156 rpmorphan [options] [targets]
157 .PP
158 or
159 .PP
160 grpmorphan [options] [targets]
161 .PP
162 using grpmorphan is a short way to use \*(L"rpmorphan \-gui\*(R"
163 .PP
164 options:
165 .PP
166 .Vb 3
167 \& \-help brief help message
168 \& \-man full documentation
169 \& \-V, \-\-version print version
170 \&
171 \& \-verbose verbose
172 \& \-debug debug mode (for developpers only)
173 \& \-dry\-run simulate package remove
174 \& \-fullalgo force full algorythm
175 \& \-suggests use suggested package as if required
176 \& \-recommends use recommends package as if required
177 \& \-arch work and show on full name with version and architecture
178 \& \-log\-file mylog change default log file to mylog
179 \& \-use\-cache use cache to avoid rpm query
180 \& \-clear\-cache remove cache file
181 \& \-gui display the graphical interface
182 \& \-tk display the tk graphical interface
183 \& \-curses display the curses graphical interface
184 \&
185 \& \-exclude pac exclude pac from results
186 \& \-install\-time +/\-d apply on packages which are installed before (after) d days
187 \& \-access\-time d apply on packages which are not been accessed for d days (slow)
188 .Ve
189 .PP
190 targets:
191 .PP
192 .Vb 10
193 \& \-package pac search if pac is an orphan package
194 \& \-all apply on all packages
195 \& \-guess\-perl apply on perl packages
196 \& \-guess\-python apply on python packages
197 \& \-guess\-pike apply on pike packages
198 \& \-guess\-ruby apply on ruby packages
199 \& \-guess\-common apply on common packages
200 \& \-guess\-data apply on data packages
201 \& \-guess\-doc apply on documentation packages
202 \& \-guess\-dev apply on development packages
203 \& \-guess\-lib apply on library packages (this is the default target if none is specified)
204 \& \-guess\-all apply all \-guess\-* options (perl, python ...)
205 \& \-guess\-custom regex apply the given regex to filter to package\*(Aqs names to filter the output
206 .Ve
207 .PP
208 keep file management
209 .PP
210 .Vb 5
211 \& \-keep\-file file define the keep file to be used
212 \& \-list\-keep list permanent exclude list
213 \& \-zero\-keep empty permanent exclude list
214 \& \-add\-keep pac add pac package to permanent exclude list
215 \& \-del\-keep pac remove pac package from permanent exclude list
216 .Ve
217 .SH "REQUIRED ARGUMENTS"
218 .IX Header "REQUIRED ARGUMENTS"
219 you should provide at least one target. this can be
220 .IP "\fB\-all\fR" 8
221 .IX Item "-all"
222 all the installed rpm package
223 .IP "\fB\-package\fR" 8
224 .IX Item "-package"
225 one or several explicit package
226 .IP "\fB\-guess\-*\fR" 8
227 .IX Item "-guess-*"
228 pre-selected packages groups
229 .IP "\fB\-guess\-custom\fR" 8
230 .IX Item "-guess-custom"
231 give a filter to select the packages you want study. you can use regular expressions.
232 .SH "OPTIONS"
233 .IX Header "OPTIONS"
234 .IP "\fB\-help\fR" 8
235 .IX Item "-help"
236 Print a brief help message and exits.
237 .IP "\fB\-man\fR" 8
238 .IX Item "-man"
239 Print the manual page and exits.
240 .IP "\fB\-version\fR" 8
241 .IX Item "-version"
242 Print the program release and exit.
243 .IP "\fB\-verbose\fR" 8
244 .IX Item "-verbose"
245 The program works and print debugging messages.
246 .IP "\fB\-debug\fR" 8
247 .IX Item "-debug"
248 for developpers, the program will dump internals structures
249 .IP "\fB\-dry\-run\fR" 8
250 .IX Item "-dry-run"
251 this is a simulation mode : rpmorphan will show you what is
252 the result of package removing. The window's title is modified
253 to show this mode.
254 .IP "\fB\-use\-cache\fR" 8
255 .IX Item "-use-cache"
256 the rpm query may be long (10 to 30 s). If you will run an rpmorphan tool
257 several time, this option will allow to gain a lot of time :
258 it save the rpm query on a file cache (first call), then
259 use this cache instead quering rpm (others calls).
260 .IP "\fB\-clear\-cache\fR" 8
261 .IX Item "-clear-cache"
262 to remove cache file. Can be used with \-use\-cache to write
263 a new cache.
264 .IP "\fB\-gui\fR" 8
265 .IX Item "-gui"
266 display a graphical interface which allow to show informations, remove packages
267 (an internal help is provided). This is currently the same as the \-tk option
268 .IP "\fB\-tk\fR" 8
269 .IX Item "-tk"
270 display a tk graphical interface which allow to show informations, remove packages
271 (an internal help is provided). The Tk perl module is necessary to run the gui.
272 .IP "\fB\-curses\fR" 8
273 .IX Item "-curses"
274 display a curses graphical interface which allow to show informations, remove packages
275 (an internal help is provided). The Curses::UI perl module is necessary to run the gui.
276 .IP "\fB\-exclude\fR" 8
277 .IX Item "-exclude"
278 this option will specify the packages to exclude from the output.
279 Can be used as '\-\-exclude pac1 \-\-exclude pac2'
280 or '\-\-exclude \*(L"pac1, pac2\*(R"'
281 .IP "\fB\-install\-time\fR" 8
282 .IX Item "-install-time"
283 install-time is a filter on the period from the package installation date to now (in days).
284 if set positive, it only allow packages installed before x days.
285 if set negative, it only allow packages installed since x days.
286 .IP "\fB\-access\-time\fR" 8
287 .IX Item "-access-time"
288 access-time is designed to filter packages which have not been used since x days.
289 .Sp
290 be careful : this option will slow the program
291 .IP "\fB\-fullalgo\fR" 8
292 .IX Item "-fullalgo"
293 for a small list of packages, rpmorphan use a different quicker methode : rpm \-e \-\-test
294 .Sp
295 this option can be used to force the use of the full algo
296 .IP "\fB\-suggests\fR" 8
297 .IX Item "-suggests"
298 some rpm version offers a meta-data dependency call suggests : it is
299 for usefull but not necessary packages (very weak dependency). if this option is set, the
300 suggested packages are used in rpmorphan as required packages.
301 The default value for this option is unset.
302 .IP "\fB\-recommends\fR" 8
303 .IX Item "-recommends"
304 some rpm version offers a meta-data dependency call recommends : it is
305 for usefull but not necessary packages(weak dependency). if this option is set, the
306 recommended packages are used in rpmorphan as required packages.
307 The default value for this option is unset.
308 .IP "\fB\-arch\fR" 8
309 .IX Item "-arch"
310 by default, rpmorphan works on package name. this option will rpmorphan work
311 on full package name : name\-version\-release.arch.
312 This may be usefull if you have several version or several archictectures installed.
313 .IP "\fB\-log\-file\fR" 8
314 .IX Item "-log-file"
315 change the default log file (/var/log/rpmorphan.log) to the given file name
316 .IP "\fB\-package\fR" 8
317 .IX Item "-package"
318 search if the given package(s) is(are) orphaned.
319 Can be used as '\-\-package pac1 \-\-package pac2'
320 or '\-\-package \*(L"pac1, pac2\*(R"'
321 .IP "\fB\-all\fR" 8
322 .IX Item "-all"
323 apply on all installed packages. The output should be interpreted.
324 For example lilo or grub are orphaned packages, but are necessary
325 to boot ...
326 .Sp
327 the \*(L"\-install\-time\*(R" and \*(L"\-access\-time\*(R" options may be useful to filter the list
328 .IP "\fB\-guess\-perl\fR" 8
329 .IX Item "-guess-perl"
330 This option tries to find perl modules. It tries to match \*(L"^perl\*(R"
331 .IP "\fB\-guess\-python\fR" 8
332 .IX Item "-guess-python"
333 This option tries to find python modules. It tries to match \*(L"^python\*(R"
334 .IP "\fB\-guess\-pike\fR" 8
335 .IX Item "-guess-pike"
336 This option tries to find pike modules. It tries to match \*(L"^pike\*(R"
337 .IP "\fB\-guess\-ruby\fR" 8
338 .IX Item "-guess-ruby"
339 This option tries to find ruby modules. It tries to match \*(L"^ruby\*(R"
340 .IP "\fB\-guess\-common\fR" 8
341 .IX Item "-guess-common"
342 This option tries to find common packages. It tries to match \*(L"\-common$\*(R"
343 .IP "\fB\-guess\-data\fR" 8
344 .IX Item "-guess-data"
345 This option tries to find data packages. It tries to match \*(L"\-data$\*(R"
346 .IP "\fB\-guess\-doc\fR" 8
347 .IX Item "-guess-doc"
348 This option tries to find documentation packages. It tries to match \*(L"\-doc$\*(R"
349 .IP "\fB\-guess\-data\fR" 8
350 .IX Item "-guess-data"
351 This option tries to find data packages. It tries to match \*(L"\-data$\*(R"
352 .IP "\fB\-guess\-dev\fR" 8
353 .IX Item "-guess-dev"
354 This option tries to find development packages. It tries to match \*(L"\-devel$\*(R"
355 .IP "\fB\-guess\-lib\fR" 8
356 .IX Item "-guess-lib"
357 This option tries to find library packages. It tries to match \*(L"^lib\*(R"
358 .IP "\fB\-guess\-all\fR" 8
359 .IX Item "-guess-all"
360 This is a short to tell : Try all of the above (perl, python ...)
361 .IP "\fB\-guess\-custom\fR" 8
362 .IX Item "-guess-custom"
363 this will allow you to specify your own filter. for exemple \*(L"^wh\*(R"
364 will match whois, whatsnewfm ...
365 .IP "\fB\-keep\-file\fR" 8
366 .IX Item "-keep-file"
367 define the keep file to be used. If not set, the /var/lib/rpmorphan/keep will be used
368 .IP "\fB\-list\-keep\fR" 8
369 .IX Item "-list-keep"
370 list the permanent list of excluded packages and exit.
371 .IP "\fB\-zero\-keep\fR" 8
372 .IX Item "-zero-keep"
373 empty the permanent list of excluded packages and exit.
374 .IP "\fB\-add\-keep\fR" 8
375 .IX Item "-add-keep"
376 add package(s) to the permanent list of excluded packages and exit.
377 .Sp
378 Can be used as '\-\-add\-keep pac1 \-\-add\-keep pac2'
379 or '\-\-add\-keep \*(L"pac1, pac2\*(R"'
380 .IP "\fB\-del\-keep\fR" 8
381 .IX Item "-del-keep"
382 remove package(s) from the permanent list of excluded packages and exit.
383 .Sp
384 Can be used as '\-\-add\-keep pac1 \-\-add\-keep pac2'
385 or '\-\-add\-keep \*(L"pac1, pac2\*(R"'
386 .SH "USAGE"
387 .IX Header "USAGE"
388 rpmorphan can be useful after a distribution upgrade, to remove packages forgotten
389 by the upgrade tool. It is interesting to use the options "\-all \-install\-time +xx'.
390 .PP
391 If you want to remove some recent tested packages, my advice is "\-all \-install\-time \-xx'.
392 .PP
393 if you just want to clean your disk, use '\-all \-access\-time xxx'
394 .SH "FILES"
395 .IX Header "FILES"
396 /var/lib/rpmorphan/keep : the permanent exclude list
397 .PP
398 /tmp/rpmorphan.cache : cache file to store rpm query. The cache
399 file is common to all rpmorphan tools
400 .PP
401 /var/log/rpmorphan.log : log of all deleted packages
402 .SH "CONFIGURATION"
403 .IX Header "CONFIGURATION"
404 the program can read rcfile if some exists.
405 it will load in order
406 .PP
407 /etc/rpmorphanrc
408 .PP
409 ~/.rpmorphanrc
410 .PP
411 \&.rpmorphanrc
412 .PP
413 In this file,
414 .PP
415 # are comments,
416 .PP
417 and parameters are stored in the following format :
418 parameter = value
419 .PP
420 example :
421 .PP
422 all = 1
423 .PP
424 curses = 1
425 .SH "DEPENDENCIES"
426 .IX Header "DEPENDENCIES"
427 rpmorphan uses standard perl module in console mode.
428 .PP
429 If you want to use the Tk graphical interface, you should install the Tk module
430 (perl-Tk rpm package).
431 .PP
432 If you want to use the curses interface, you should install the Curses::UI perl module
433 ( perl-Curses-UI rpm package).
434 .PP
435 If you want to speed up rpmorphan, you should install the \s-1RPM2\s0 perl module ( perl\-RPM2 rpm package).
436 On mandriva, the \s-1URPM\s0 perl module (dependency from urpmi) will be used instead.
437 .SH "EXAMPLES"
438 .IX Header "EXAMPLES"
439 .IP "display orphaned libraries" 8
440 .IX Item "display orphaned libraries"
441 rpmorphan
442 .IP "display all orphaned packages in a curses interface" 8
443 .IX Item "display all orphaned packages in a curses interface"
444 rpmorphan \-\-all \-\-curses
445 .IP "display orphaned packages, not used since one year" 8
446 .IX Item "display orphaned packages, not used since one year"
447 rpmorphan \-\-all \-access\-time +365
448 .IP "display all orphaned packages, installed in the last 10 days" 8
449 .IX Item "display all orphaned packages, installed in the last 10 days"
450 rpmorphan \-\-all \-install\-time \-10
451 .IP "display all orphaned packages, installed one month ago (or more)" 8
452 .IX Item "display all orphaned packages, installed one month ago (or more)"
453 rpmorphan \-\-all \-install\-time +30
454 .IP "display orphaned packages but not weak dependencies" 8
455 .IX Item "display orphaned packages but not weak dependencies"
456 rpmorphan \-\-all \-\-recommends
457 .IP "display orphaned packages but not all weak dependencies" 8
458 .IX Item "display orphaned packages but not all weak dependencies"
459 rpmorphan \-\-all \-\-recommends \-\-suggests
460 .SH "BUGS AND LIMITATIONS"
461 .IX Header "BUGS AND LIMITATIONS"
462 Virtuals packages are not well (for now) taken in account.
463 Let's see an example : lilo and grub provide 'bootloader' virtual, which is
464 necessary for system boot.
465 if the 2 are installed, they will be shown all 2 as orphans (but you can not remove
466 the 2).
467 If you remove one of them, the other is now longer shown as orphan.
468 .PP
469 the software can only work with one version of each software :
470 we only treat the first version seen
471 .PP
472 the code does not use the following rpm tags : Supplements, Enhances
473 .SH "INCOMPATIBILITIES"
474 .IX Header "INCOMPATIBILITIES"
475 not known
476 .SH "DIAGNOSTICS"
477 .IX Header "DIAGNOSTICS"
478 to be written
479 .SH "NOTES"
480 .IX Header "NOTES"
481 this program can be used as \*(L"normal\*(R" user to show orphans,
482 but you need to run it as supersuser (root) to remove packages
483 or apply changes in the permanent exclude list
484 .PP
485 access-time and install-time options are \*(L"new\*(R" features, not available
486 in deborphan tool
487 .PP
488 For Fedora users :
489 Yum offers a program called 'package\-cleanup' which,
490 called with the '\-\-leaves' option, can show quickly a list of
491 unused library packages.
492 .PP
493 For Mandriva users :
494 the 'urpme \-\-auto\-orphans' command show quickly a a list of
495 unused library packages.
496 .SH "ENVIRONMENT"
497 .IX Header "ENVIRONMENT"
498 .IP "\s-1RPMORPHAN_METHOD\s0" 8
499 .IX Item "RPMORPHAN_METHOD"
500 for experts only : allow to force the method used to get rpm
501 data. It can be set to \s-1URPM, RPM2\s0 or 'basic' (for external rpm query)
502 .SH "SEE ALSO"
503 .IX Header "SEE ALSO"
504 \fIrpm\fR\|(1) for rpm call
505 .PP
506 \fIrpmusage\fR\|(1)
507 .PP
508 \fIrpmdep\fR\|(1)
509 .PP
510 \fIrpmduplicates\fR\|(1)
511 .PP
512 \fIrpmextra\fR\|(1)
513 .SH "EXIT STATUS"
514 .IX Header "EXIT STATUS"
515 should be allways 0
516 .SH "LICENSE AND COPYRIGHT"
517 .IX Header "LICENSE AND COPYRIGHT"
518 Copyright (C) 2006 by Eric Gerbier
519 This program is free software; you can redistribute it and/or modify
520 it under the terms of the \s-1GNU\s0 General Public License as published by
521 the Free Software Foundation; either version 2 of the License, or
522 (at your option) any later version.
523 .SH "AUTHOR"
524 .IX Header "AUTHOR"
525 Eric Gerbier
526 .PP
527 you can report any bug or suggest to [email protected]