man/equery.1

   1 .TH "EQUERY" "1" "August 2009" "GENTOOLKIT"
   2 .SH "NAME"
   3 equery \- Gentoo Package Query Tool
   4
   5 .SH "SYNOPSIS"
   6 .BI "equery " "[global-options] " "module " "[local-options]"
   7
   8 .SH "DESCRIPTION"
   9 .B Equery
  10 is a collection of modules for querying the state of Gentoo packages, files and USE flags.
  11
  12 .SH "GLOBAL OPTIONS"
  13 .HP
  14 .B \-h, \-\-help
  15 .br
  16 Output a help message.
  17 .HP
  18 .B \-q, \-\-quiet
  19 .br
  20 Be less verbose where possible. In some modules, this option can increase the output speed.
  21 .HP
  22 .B \-C, \-\-no-color
  23 .br
  24 Do not colorize output.
  25 .HP
  26 .B \-N, \-\-no\-pipe
  27 .br
  28 Turn off automatic pipe detection. Use this option if you do not want
  29 .B equery
  30 to detect if the output is being directed to the screen or to another program and adjust color and verbosity accordingly.
  31 .HP
  32 .B \-V, \-\-version
  33 .br
  34 Display \fBGentoolkit\fP's version. Please include this in all bug reports. (see
  35 .B BUGS
  36 below)
  37
  38 .SH "MODULES"
  39 .B Equery
  40 uses a system of modules. Each module has both a long and short name. The list below uses the notation "\fBmodule (m)\fP", where \fIm\fP is the short name and \fImodule\fP is the long name.
  41 .P
  42 You can view the
  43 .B help
  44 message for a specific module by using
  45 .BR "-h" ", " "--help "
  46 as either a global option (after
  47 .B equery
  48 and before the module name) or as a local option (after the module name).
  49
  50 .SS
  51 .BI "belongs (b) [OPTIONS] " "FILE"
  52 List the package that owns \fIFILE\fP.
  53 .P
  54 .BI Note:
  55 Normally, only one package will own \fIFILE\fP. If multiple packages own the
  56 same file it should be reported. (see
  57 .B BUGS
  58 below)
  59
  60 .IR "LOCAL OPTIONS" ":"
  61 .HP
  62 .B \-f, \-\-full-regex
  63 .br
  64 The supplied query is a regular expression.
  65 .HP
  66 .B \-e, \-\-early-out
  67 .br
  68 Stop when the first match is found. This is generally a safe optimization when searching for the owner of a single file.
  69 .HP
  70 .B \-n, \-\-name-only
  71 .br
  72 Do not print the version.
  73 .P
  74 .IR "EXAMPLES" ":"
  75 .EX
  76 .HP
  77 equery belongs --early-out /usr/bin/euse
  78 .EE
  79 .br
  80 Find out what package installed a certain command.
  81 .EX
  82 .HP
  83 emerge -p $(equery -q belongs -nf '^/usr/bin/g?vim.*')
  84 .EE
  85 .br
  86 Tell
  87 .B emerge
  88 to reinstall or update any package that installed a file matching a regular expression.
  89
  90 .SS
  91 .BI "changes (c) [OPTIONS] " "PKG"
  92 Display the Gentoo ChangeLog entry for the latest installable version of \fIPKG\fP.
  93
  94 .IR "LOCAL OPTIONS" ":"
  95 .HP
  96 .B \-l, \-\-latest
  97 .br
  98 Display only the latest ChangeLog entry. It's not uncommon for changes to be prepended to the ChangeLog without a version header if the changes did not require a version bump. Use this option to display such entries.
  99 .HP
 100 .B \-f, \-\-full
 101 .br
 102 Display the full ChangeLog.
 103 .br
 104 \fBHint\fP: Try piping (|) the output to a pager, like 'less'.
 105 .HP
 106 .BI "\-\-limit=" "NUM"
 107 .br
 108 Limit the \fINUM\fP of entries displayed. Use  this option in conjunction with \fB--full\fP. \fB--limit=3\fP would display the three latest entries.
 109 .HP
 110 .BI "\-\-from=" "VER"
 111 .br
 112 Set which \fIVER\fP to display from. Using this option by itself is equivalent to passing \fBchanges\fP a ranged package atom, e.g., '>=foo/bar-1.5'. It can be used in conjunction with \fB--to\fP to request a more complex range of entries.
 113 .HP
 114 .BI "\-\-to=" "VER"
 115 .br
 116 Set which \fIVER\fP to display to. (See \fB--from\fP)
 117 .P
 118 .IR "EXAMPLES" ":"
 119 .EX
 120 .HP
 121 equery changes portage
 122 .EE
 123 .br
 124 Display the Gentoo ChangeLog entry for the latest installable version of Portage.
 125 .EX
 126 .HP
 127 equery changes '=sys-apps/portage-2.1.6*'
 128 .EE
 129 .br
 130 Use Portage's atom syntax. (See \fBman 5 ebuild\fP)
 131 .EX
 132 .HP
 133 equery changes portage --from=2.2_rc1 --to=2.2
 134 .EE
 135 .br
 136 Display any ChangeLog entry within a range of versions.
 137
 138 .SS
 139 .BI "check (k) [OPTIONS] " "PKG"
 140 Check timestamps and MD5 sums for files owned by \fIPKG\fP, where \fIPKG\fP is an installed package.
 141
 142 .IR "LOCAL OPTIONS" ":"
 143 .HP
 144 .B \-f, \-\-full-regex
 145 .br
 146 The supplied query is a regular expression.
 147 .HP
 148 .B \-o, \-\-only-failures
 149 .br
 150 Only display packages which don't pass all checks.
 151 .P
 152 .IR "EXAMPLES" ":"
 153 .EX
 154 .HP
 155 equery check --only-failures '*'
 156 .EE
 157 .br
 158 Verify timestamps and MD5 sums for all installed packages and show only packages which fail checks.
 159 .EX
 160 .HP
 161 equery check 'dev-python/*' dev-lang/python
 162 .EE
 163 .br
 164 Verify every installed package in the \fBdev-python\fP category, and Python itself.
 165
 166 .SS
 167 .BI "depends (d) [OPTIONS] " "PKG"
 168 List all packages that depend on \fIPKG\fP.
 169
 170 .IR "LOCAL OPTIONS" ":"
 171 .HP
 172 .B \-a, \-\-all-packages
 173 .br
 174 Include dependencies that are not installed. This can take a while.
 175 .HP
 176 .B \-D, \-\-indirect
 177 .br
 178 Search for both direct and indirect dependencies.
 179 .HP
 180 .BI "\-\-depth=" "NUM"
 181 .br
 182 Limit the indirect dependency tree to a depth of \fINUM\fP. \fB--depth=0\fP is equivalent to not using \fB--indirect\fP.
 183 .P
 184 .IR "EXAMPLES" ":"
 185 .EX
 186 .HP
 187 equery depends --indirect xulrunner
 188 .EE
 189 .br
 190 Figure out why a package got installed on your system.
 191
 192 .SS
 193 .BI "depgraph (g) [OPTIONS] " "PKG"
 194 Display a direct dependency graph for every matching version of \fIPKG\fP. A dependency graph is an
 195 indented tree showing the relationship between packages and their dependencies.
 196
 197 .IR "LOCAL OPTIONS" ":"
 198 .HP
 199 .B \-A, \-\-no-atom
 200 .br
 201 Do not show the dependency atom that match the package.
 202 .HP
 203 .B \-U, \-\-no-useflags
 204 .br
 205 Do not show USE flags.
 206 .HP
 207 .B \-l, \-\-linear
 208 .br
 209 Do not format the graph by indenting dependencies. This option will print the
 210 recursion depth in square brackets before the package name for easier viewing
 211 in narrow terminals.
 212 .HP
 213 .BI "\-\-depth=" "NUM"
 214 .br
 215 Limit the dependency graph to a depth of \fINUM\fP. \fB--depth=0\fP means no
 216 maximum depth. Default depth is set to 1.
 217 .P
 218 .IR "EXAMPLES" ":"
 219 .EX
 220 .HP
 221 equery depgraph --depth=0 portage
 222 .EE
 223 .br
 224 View a full tree of all direct and indirect compile-time, run-time, and post-merge dependencies for a package.
 225
 226 .SS
 227 .BI "files (f) [OPTIONS] " "PKG"
 228 List files and directories installed by \fIPKG\fP.
 229
 230 .IR "LOCAL OPTIONS" ":"
 231 .HP
 232 .B \-m, \-\-md5sum
 233 .br
 234 Include the file's MD5 sum in the output.
 235 .HP
 236 .B \-s, \-\-timestamp
 237 .br
 238 Include the file's timestamp in the output.
 239 .HP
 240 .B \-t, \-\-type
 241 .br
 242 Include the file type in the output.
 243 .HP
 244 .B \-\-tree
 245 .br
 246 Display files in a tree format. This option turns off all other local options.
 247 .HP
 248 .BI "\-f, \-\-filter=" "RULES"
 249 .br
 250 Filter output by file type.
 251 .HP
 252 RULES
 253 .br
 254 A comma-separated list (no spaces); choose from:
 255 .br
 256 .B dir, obj, sym, dev, path, conf, cmd, doc, man, info
 257 .P
 258 .IR "EXAMPLES" ":"
 259 .EX
 260 .HP
 261 equery files --tree vlc
 262 .EE
 263 .br
 264 View a file tree of all files installed by a package.
 265 .EX
 266 .HP
 267 equery files --filter=cmd vlc
 268 .EE
 269 .br
 270 Find out where a package installed its executables.
 271
 272 .SS
 273 .BI "hasuse (h) [OPTIONS] " "USE"
 274 List all installed packages that have a given \fIPKG\fP flag.
 275
 276 \fBNote\fP: \fBhasuse\fP does not currently have the ability to display if packages are built with the given USE flag or not. It can only list which packages have the flag as an option. (See \fIEXAMPLES\fP)
 277
 278 .IR "LOCAL OPTIONS" ":"
 279 .HP
 280 .B \-I, \-\-exclude-installed
 281 .br
 282 Exclude installed packages from being output.
 283 .HP
 284 .B \-o, \-\-overlay-tree
 285 .br
 286 Include package from overlays in the search path.
 287 .HP
 288 .B \-p, \-\-portage-tree
 289 .br
 290 Include all packages from the Portage tree in the search path. Use this option to search through all standard Gentoo packages, including those that are not installed.
 291 .HP
 292 .B \-F, \-\-format=\fITMPL\fP
 293 .br
 294 Customize the output format of the matched packages using the template string \fITMPL\fP. See the \fB\-\-format\fP option for \fBlist\fP below for a description of the \fITMPL\fP argument.
 295 .P
 296 .IR "OUTPUT" ":"
 297 .HP
 298 (See \fIOUTPUT\fP for \fBlist\fP below)
 299 .P
 300 .IR "EXAMPLES" ":"
 301 .EX
 302 .HP
 303 equery hasuse -pI perl
 304 .EE
 305 .br
 306 View all Gentoo packages that have the "perl" USE flag, exluding installed packages.
 307 .EX
 308 .HP
 309 USE="perl"; for PKG in $(equery -q hasuse $USE); do echo $PKG: $(equery -q uses $PKG |grep $USE); done
 310 .EE
 311 .br
 312 This Bash one-liner uses \fBhasuse\fP to find a list of packages that have a certain USE flag, and \fBuses\fP to check whether the flag is enabled or disabled. Modify \fBUSE="perl"\fP to change the query.
 313
 314 .SS
 315 .BI "list (l) [OPTIONS] " "PKG"
 316 List installed versions of \fIPKG\fP or all packages matching the query pattern.
 317
 318 .IR "LOCAL OPTIONS" ":"
 319 .HP
 320 .B \-d, \-\-duplicates
 321 .br
 322 List only packages with more than one version installed.
 323 .HP
 324 .B \-f, \-\-full-regex
 325 .br
 326 The supplied query is a regular expression.
 327 .HP
 328 .B \-m, \-\-mask-reason
 329 .br
 330 Print the reason why a package was masked.
 331 .HP
 332 .B \-I, \-\-exclude-installed
 333 .br
 334 Exclude installed packages from being output.
 335 .HP
 336 .B \-o, \-\-overlay-tree
 337 .br
 338 Include package from overlays in the search path.
 339 .HP
 340 .B \-p, \-\-portage-tree
 341 .br
 342 Include all packages from the Portage tree in the search path. Use this option to search through all standard Gentoo packages, including those that are not installed.
 343 .HP
 344 .B \-F, \-\-format=\fITMPL\fP
 345 .br
 346 Customize the output format of the matched packages using the template string \fITMPL\fP. \fITMPL\fP can contain the following placeholders:
 347 .RS
 348 .TP
 349 \fB$cp\fP \- Contains the category and the package name only (e.g 'app\-portage/gentoolkit').
 350 .TP
 351 \fB$cpv\fP \- Contains the category, the package name and the full version (e.g. 'app\-portage/gentoolkit\-0.3.0_rc10\-r1').
 352 .TP
 353 \fB$category\fP \- Contains just the category (e.g. 'app\-portage').
 354 .TP
 355 \fB$name\fP \- Contains just the package name (e.g. 'gentoolkit').
 356 .TP
 357 \fB$version\fP \- Contains the package version (without the revision) (e.g. '0.3.0_rc10').
 358 .TP
 359 \fB$revision\fP \- Contains the package revision (e.g. 'r1').
 360 .TP
 361 \fB$fullversion\fP \- Contains the package version including its revision (e.g. '0.3.0_rc10\-r1').
 362 .TP
 363 \fB$slot\fP \- Contains the package's slot.
 364 .TP
 365 \fB$repo\fP \- Contains the name of the package's repository (e.g. 'gentoo').
 366 .TP
 367 \fB$mask\fP \- The Mask\-status field (\fB~M\-??\fP), see \fIOUTPUT\fP below for an explanation.
 368 .TP
 369 \fB$mask2\fP \- Contains a verbose description of the packages masking status.
 370 .TP
 371 \fB$location\fP \- The Location field (\fBIPO\-\fP), see \fIOUTPUT\fP below for an explanation.
 372 .P
 373 Apart from the above placeholders the template string can contain arbitrary
 374 text as desired. Similar to bash variables, curly braces can be used to
 375 disambiguate the variable names from the enclosing text.
 376 .RE
 377 .P
 378 .IR "OUTPUT" ":"
 379
 380 .EX
 381 $ equery list binutils
 382  * Searching for binutils ...
 383  [I--] [??] sys-devel/binutils-2.18-r1:i686-pc-linux-gnu-2.18
 384  [IP-] [ ~] sys-devel/binutils-2.19.1-r1:i686-pc-linux-gnu-2.19.1
 385 .EE
 386 .HP
 387 Location field (\fB[IPO-]\fP):
 388 .br
 389 The first field shows the location and install status of the package. It consists of three letters in square brackets. \fBI\fP indicates the package is currently installed. \fBP\fP indicates the package is available in the Portage tree. \fBO\fP indicates the package is available in at least one overlay. \fB-\fP is a place holder and has no meaning. \fB[I-O]\fP would mean that the package is installed and available from an overlay, but not available from the Portage tree.
 390 .HP
 391 Mask-status field (\fB[ ~M-??]\fP):
 392 .br
 393 The second field shows the mask status of the package. Empty brackets indicate that the package is unmasked. A \fB~\fP means the package is masked by keyword, e.g., you are running a stable system and the package is marked testing). \fBM\fP means hard masked, e.g., the package maintainer has determined the package is unfit for widespread usage. \fB-\fP means arch masked, e.g., you are running an amd64 system, but this package only works on x86. Lastly, \fB??\fP only occurs when the location field is \fB[I--]\fP. Together, they indicate that the package was installed from the Portage tree or an overlay, but has since been removed from that tree; therefore \fBequery\fP can not determine a mask status for it.
 394 .HP
 395 Package name:
 396 .br
 397 The third field is the full package name and version.
 398 .HP
 399 Slot:
 400 .br
 401 The fourth field, after the colon, is the package's slot. \fB0\fP is the default slot. To find all packages with multiple slots installed, use \fB--duplicates\fP.
 402 .P
 403 \fBNote:\fP Because it takes extra processing time to determine the location, mask status and slot, you can speed up output by passing the \fB--quiet\fP global option to \fBequery\fP when you don't care about the extra information.
 404
 405 .P
 406 .IR "EXAMPLES" ":"
 407 .EX
 408 .HP
 409 equery list '*'
 410 .EE
 411 .br
 412 List all installed packages. This is equivalent to '\fBequery list\fP' in \fBGentoolkit\fP versions prior to 0.3.0.
 413 .EX
 414 .HP
 415 equery list -op mozilla-firefox
 416 .EE
 417 .br
 418 List all available versions of the package exactly matching 'mozilla-firefox'. This is equivalent to '\fBequery list --exact-name -o -p mozilla-firefox\fP' in \fBGentoolkit\fP versions prior to 0.3.0.
 419 .EX
 420 .HP
 421 equery list '*zilla*'
 422 .EE
 423 .br
 424 List all packages that contain (fuzzy match) 'zilla'. This is equivalent to '\fBequery list zilla\fP' in \fBGentoolkit\fP versions prior to 0.3.0.
 425 .EX
 426 .HP
 427 equery list 'www-client/*'
 428 .EE
 429 .br
 430 List all packages in the category \fBwww-client\fP. This is equivalent to '\fBequery list --category=www-client\fP' in \fBGentoolkit\fP versions prior to 0.3.0.
 431 .EX
 432 .HP
 433 equery list --duplicates '*'
 434 .EE
 435 .br
 436 List all packages with more than one version installed. This is equivalent to '\fBequery list --duplicates\fP' in \fBGentoolkit\fP versions prior to 0.3.0.
 437 .EX
 438 .HP
 439 equery list -F '$cp:$slot' '*'
 440 .EE
 441 .br
 442 Get a list of slotted atoms for all installed packages.
 443 .EX
 444 .HP
 445 equery list -po -F '[$location] [$mask] $cpv:$slot [$repo]' '*'
 446 .EE
 447 .br
 448 Show all packages in the default (verbose) output format but also include their repository name.
 449
 450 .SS
 451 .BI "meta (m) [OPTIONS] " "PKG"
 452 Display metadata about \fIPKG\fP.
 453
 454 \fBmeta\fP reads a file called metadata.xml which must be included with all Portage tree packages. \fBmeta\fP does not read ebuilds, so it can only return version independent metadata. Since until now there had not been an easy way for users to view metadata.xml, and because package maintainers are only required to fill out a very small portion of the file, there are still many packages without detailed metadata available. For more information about metadata.xml, see:
 455 .br
 456 .EX
 457 http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=4
 458 .EE
 459
 460 .IR "LOCAL OPTIONS" ":"
 461 .HP
 462 .B \-d, \-\-description
 463 .br
 464 Show an extended package description.
 465 .HP
 466 .B \-H, \-\-herd
 467 .br
 468 Show the herd(s) for the package. When not piping and not passing \fB--quiet\fP as a global option, also show the herd's email address. (shown by default)
 469 .HP
 470 .B \-k, \-\-keywords
 471 .br
 472 Show keywords for all matching versions. \fBkeywords\fP does not list all keywords for all versions. Instead, it filters the list to make it easier to spot versions that need bumping or are okay to remove from the tree. It filters by slot. For example:
 473 .br
 474 Keywords:    1.35.0-r3:\fB0\fP:
 475 .br
 476 Keywords:    1.35.0-r5:\fB0\fP: amd64 hppa ppc x86 ~alpha ~arm ~ia64 ~mips ~ppc64 ~s390 ~sh ~sparc
 477 .br
 478 In this output from \fBequery meta boost\fP, -r5 is the highest available version in slot 0, so all keywords are listed. The actual keywords for -r3 are "~amd64 ~hppa ~ppc ~x86", but since a higher version in the same slot has the same or more stable keywording, they are filtered out. Arch mask keywords (-*) are always shown.
 479 .HP
 480 .B \-m, \-\-maintainer
 481 .br
 482 Show the package maintainer(s) email address. If the metadata is available, also show the maitainer's name and/or job description. (shown by default)
 483 .HP
 484 .B \-u, \-\-useflags
 485 .br
 486 Show per-package USE flag descriptions. Per-package USE flag descriptions are sometimes added to metadata.xml if the affect of the USE flag is unusual, or if the USE flag is rare enough to be undefined in the global definition file. \fBequery uses\fP now displays these same local descriptions as well, so this option is left in \fBmeta\fP for completeness only.
 487 .HP
 488 .B \-U, \-\-upstream
 489 .br
 490 Show information about the package's upstream project, including the author's email, upstream bug tracker or upstream documentation. At the time of writing, most maintainers do not provide this information. (shown by default)
 491 .HP
 492 .B \-x, \-\-xml
 493 .br
 494 Dump the plain XML file to the screen.
 495 .P
 496 .IR "EXAMPLES" ":"
 497 .EX
 498 .HP
 499 equery meta gnucash
 500 .EE
 501 .br
 502 Show general information about maintainership, including herd, maintainer and upstream.
 503 .EX
 504 .HP
 505 equery meta --description screen
 506 .EE
 507 .br
 508 See if the package maintainer has provided an extended description.
 509 .EX
 510 .HP
 511 equery -N meta -H gnome |grep -o --color=never '[^( ]*@gentoo.org'
 512 .EE
 513 .br
 514 Extract the herd's email address to let them know they're doing a great job. Remember, bug reports should go to bugs.gentoo.org. The above example will extract one or more emails if available, or return nothing if the herd is \fBno-herd\fP.
 515
 516 .SS
 517 .BI "size (s) [OPTIONS] " "PKG"
 518 Print total size of files contained in a given \fIPKG\fP.
 519
 520 .IR "LOCAL OPTIONS" ":"
 521 .HP
 522 .B \-b, \-\-bytes
 523 .br
 524 Report package size in bytes.
 525 .HP
 526 .B \-f, \-\-full-regex
 527 .br
 528 The query is a regular expression.
 529 .P
 530 .IR "EXAMPLES" ":"
 531 .EX
 532 .HP
 533 equery -q size 'www-client/*'
 534 .EE
 535 .br
 536 Get a one-line summary of the number of files and total size (in bytes) of those files for each installed package in a category.
 537
 538 .SS
 539 .BI "uses (u) [OPTIONS] " "PKG"
 540 Display USE flag statuses and desriptions for a given \fRPKG\fP.
 541
 542 .IR "LOCAL OPTIONS" ":"
 543 .HP
 544 .B \-a, \-\-all
 545 .br
 546 Display all package versions. Without this option, \fBequery\fP will choose the best available version.
 547 .P
 548 .IR "EXAMPLES" ":"
 549 .EX
 550 .HP
 551 equery uses app-misc/beagle
 552 .EE
 553 .br
 554 See which USE flags are enabled for a specific package.
 555 .EX
 556 .HP
 557 USE="perl"; for PKG in $(equery -q hasuse $USE); do echo $PKG: $(equery -q uses $PKG |grep $USE); done
 558 .EE
 559 .br
 560 This Bash one-liner uses \fBhasuse\fP to find a list of packages that have a certain USE flag, and \fBuses\fP to check whether the flag is enabled or disabled. Modify \fBUSE="perl"\fP to change the query.
 561
 562 .SS
 563 .BI "which (w) [OPTIONS] " "PKG"
 564 Display the path to the ebuild that would be used by Portage with the current configuation.
 565
 566 .IR "LOCAL OPTIONS" ":"
 567 .HP
 568 .B \-m, \-\-include-masked
 569 .br
 570 Return the path to the hightest version ebuild available.
 571 .P
 572 .IR "EXAMPLES" ":"
 573 .EX
 574 .HP
 575 less $(equery which xorg-server)
 576 .EE
 577 .br
 578 View the most recent installable ebuild.
 579
 580 .SH "BUGS"
 581 Submit bug reports to http://bugs.gentoo.org.
 582
 583 .SH "AUTHORS"
 584 Karl Trygve Kalleberg <karltk@gentoo.org>, 2003
 585 .br
 586 Katerina Barone\-Adesi <katerinab@gmail.com>, 2004
 587 .br
 588 Douglas Anderson <douglasjanderson@gmail.com>, 2009