267f7f18b10e23a49960426f4073709a3ccce549
[gentoolkit.git] / trunk / src / revdep-rebuild / revdep-rebuild.1
1 .TH "revdep\-rebuild" "1" "" "gentoolkit" ""
2 .SH "NAME"
3 revdep\-rebuild \- Gentoo: Reverse Dependency Rebuilder
4 .SH "SYNOPSIS"
5 .B revdep\-rebuild
6 [OPTIONS] [\-\-] [EMERGE OPTIONS]
7 .SH "DESCRIPTION"
8 revdep\-rebuild scans libraries and binaries for missing shared library dependencies and attempts to fix them by re\-emerging those broken binaries and shared libraries.  It is useful when an upgraded package breaks other software packages that are dependent upon the upgraded package.
9 .SH "OPTIONS"
10 .TP 
11 .B \-C | \-\-nocolor
12 Turn off colored output. (This option is also passed to portage.)
13 .TP      
14 .B \-e | \-\-exact
15 Emerge the most recent version of found packages, without regard to SLOT.
16 .TP 
17 .B \-h | \-\-help
18 Print usage.
19 .TP
20 .B \-i | \-\-ignore
21 Delete temporary files from previous runs.
22 .TP
23 .B \-k | \-\-keep\-temp
24 Force revdep\-rebuild not to delete temporary files after it successfully rebuilds packages. This option will NOT prevent revdep\-rebuild from deleting inconsistent or out\-of\-date temporary files.
25 .TP
26 .B \-\-library NAME | -L NAME
27 Search for reverse dependencies for a particular library or group of libraries, rather than every library on the system. Emerge packages that use the named library. NAME can be a full path to a library or basic regular expression.  (See regex(7).)
28 .TP 
29 .B \-l | \-\-no\-ld\-path
30 Do not set LD_LIBRARY_PATH. \fBNote:\fR Using this option will cause revdep-rebuild to report some false positives.
31 .TP 
32 .B \-o | \-\-no-order
33 Do not check the build order against the deep dependency list.  This will make revdep-rebuild faster, but it can cause emerge failures.  Please try revdep\-rebuild without \-o before reporting any bugs.
34 .TP 
35 .B \-p | \-\-pretend
36 Do a dry-run.  Do not delete temporary files.  (\-k \-p is redundant, but harmless.)  \-\-pretend is assumed when not running revdep\-rebuild as root.
37 .TP 
38 .B \-P | \-\-no\-progress
39 Turn off the progress meter
40 .TP 
41 .B \-q | \-\-quiet
42 Print less output and disable the progress meter.  (This option is also passed to portage.)
43 .TP 
44 .B \-u UTIL | \-\-no-util UTIL
45 Do not use features provided by UTIL.
46 UTIL can be one of portage-utils or pkgcore, or it can be a \fBquoted\fR space-delimited list.
47 .TP
48 .B \-v | \-\-verbose
49 More output.  (Prints the revdep\-rebuild search environment.)
50 .TP
51 .B All other options (including unrecognized ones) are passed to the emerge command.  Single\-letter options may not be combined, so for example, \-pv is not valid.  Please use \-p \-v.
52 .SH "CONFIGURATION"
53 revdep\-rebuild no longer uses hardcoded paths. To change the default behavior the following variables can be changed by the user.
54
55 LD_LIBRARY_MASK \- Mask of specially evaluated libraries
56 .LP 
57 SEARCH_DIRS \- List of directories to search for executables and libraries
58 .LP 
59 SEARCH_DIRS_MASK \- List of directories to not search
60
61 You can prepend to these variables by setting the variable in your environment prior to execution, by placing an entry in /etc/make.conf, or by placing a file in /etc/revdep\-rebuild containing the appropriate variables.
62
63 The variables are read and set in the following order:
64
65 environment settings \- one time changes by user
66 .br 
67 /etc/make.conf \- persistent changes by user
68 .br 
69 /etc/revdep\-rebuild/* \- persistent changes by ebuild authors
70
71 While a user can edit and modify the files in the /etc/revdep\-rebuild directory, please be aware that the /etc/revdep\-rebuild directory is not under configuration protection and files can be removed and/or overwritten by an ebuild. To change this add /etc/revdep\-rebuild to the CONFIG_PROTECT variable in /etc/make.conf.
72
73 An entry of "\-*" means to clear the variable from that point forward.
74 Example: SEARCH_DIRS="/usr/bin \-*" will set SEARCH_DIRS to contain only /usr/bin
75
76 revdep\-rebuild honors the NOCOLOR and PORTAGE_NICENESS variables from /etc/make.conf
77 .SH "EXAMPLES"
78 It is recommended that when running revdep\-rebuild that the following command be used initially:
79 .br 
80 \fBrevdep\-rebuild \-\-ignore \-\-pretend\fR
81
82 To search the entire system, while excluding /mnt and /home:
83 .br 
84 \fBenv SEARCH_DIRS="/ \-*" SEARCH_DIRS_MASK="/mnt /home" revdep\-rebuild\fR
85
86 To rebuild packages that depend on libkdecore.so.4 from KDE 3.3:
87 .br 
88 \fBrevdep\-rebuild \-\-library /usr/kde/3.3/lib/libkdecore.so.4\fR
89
90 To rebuild packages that depend upon libImlib.so and libImlib2.so:
91 .br 
92 \fBrevdep\-rebuild \-\-library libImlib[2]*.so.*\fR
93
94 .SH "EXIT STATUS"
95 revdep\-rebuild returns a zero exit status if it \fBand emerge\fR succeeds, and a nonzero exit status otherwise.
96 .SH "BUGS"
97 .LP 
98 Report bugs to <http://bugs.gentoo.org>. Please do not report emerge failures caused by \-o or \-e. Please include your .revdep\-rebuild* files, your emerge \-\-info, and patches. ;)
99
100 .SH "SEE ALSO"
101 emerge(1), portage(5), regex(7)