Introduction

Introduction @@ -113,250 +116,390 @@

-equery is a tool that displays a great deal of useful information about -the packages on your system and much more. equery --help gives you the -full set of options. +equery is a tool that displays useful information about the packages on +your system. equery is based on a system of modules. +Every module has a shorthand name. For example equery l gcc is the same +as equery list gcc. equery --help explains global options + and lists all available modules and their shorthand names. + equery --help module will display the help screen for a specific + module. Lastly, man equery provides a detailed explanation of all + available modules and options, and provides useful examples.

- -Not all features listed by equery --help have been implemented yet. -Those that have not been, are mentioned clearly. You will also see that -every command has a short option, e.g. b instead of belongs. - +

+Below is a list of features +that work over the majority of modules. +

+(Many modules require a package argument. equery accepts all emerge-like input):
+$ equery --quiet list gcc                  # package
+sys-devel/gcc-4.3.2-r3
+$ equery --quiet list sys-devel/gcc        # category/package
+sys-devel/gcc-4.3.2-r3
+$ equery --quiet list '>=sys-devel/gcc-4'  # atom syntax
+sys-devel/gcc-4.3.2-r3
+
+(Like emerge, equery doesn't understand partial package names):
+$ equery check zilla
+!!! No package found matching zilla
+
+(Unlike emerge, equery can accept shell-like globbing in the category and/or package name):
+$ equery check '*zilla*'
+ * Checking www-client/mozilla-firefox-3.0.14 ...
+    90 out of 90 files passed
+$ equery check www-c*/*
+ * Checking www-client/links-2.2 ...
+   30 out of 30 files passed
+ * Checking www-client/mozilla-firefox-3.0.14 ...
+   90 out of 90 files passed
+
+(Most equery modules take multiple input):
+$ equery hasuse sse sse2
+ * Searching for USE flag sse ... 
+[IP-] [  ] media-libs/flac-1.2.1-r3 (0)
+[IP-] [  ] media-libs/speex-1.2_beta3_p2 (0)
+
+ * Searching for USE flag sse2 ... 
+[IP-] [  ] dev-libs/openssl-0.9.8k (0)
+[IP-] [  ] x11-libs/pixman-0.16.0 (0)
+
+(A few modules also allow full regular expressions):
+$ equery -q list --portage-tree --full-regex '[kr]?flickr.*'
+dev-dotnet/flickrnet-bin-2.2
+dev-ruby/flickr-1.0.2-r1
+dev-ruby/flickr-1.0.2-r2
+dev-ruby/rflickr-20060201
+media-gfx/kflickr-0.6
+[...]
+

-Be aware that equery currently changes the format of the output if it is sent -through a pipe. The piped format is intended to be easier to parse by tools, but -you can also turn it off by adding the --no-pipe option. If you write -scripts that employ equery, you should be aware of this. +Globbing support replaced a number of older options in equery. + For example, to act on all packages in a certain set, use '*'. +To act on all packages in a category, use 'category-name/*'. +Don't forget to quote input when using special shell characters +like asterisks or greater than/less than signs. + +

Below is a quick introduction to the different equery modules.

-Finding the Package That a File Came From +Finding the Package That a File Came From with belongs (b) +

+$ equery belongs -e /usr/bin/glxgears
+ * Searching for /usr/bin/glxgears ... 
+ x11-apps/mesa-progs-7.5.1 (/usr/bin/glxgears)
+

-equery also provides the functionality of finding the package that a -file came from, using belongs command (or just b). +belongs can search for files matching a regular expression with the +-f option. The -e option stops searching after it finds a match. +Since no file on your system should be owned by two packages, this is a safe +optimization.

-# equery belongs /usr/bin/audacious
-[ Searching for file(s) /usr/bin/audacious in *... ]
-media-sound/audacious-1.1.2 (/usr/bin/audacious)
-

+ +

+Viewing ChangeLog Entries with changes (c) +

-By using the -f option, you may search for packages with files -matching any regular expression. The -e option is useful for -terminating your search immediately when a match is found. +changes lets you view ChangeLog entries for a package version or range + of versions. Imagine after an emerge --sync, you +notice Portage is going to be upgraded and want to check what has changed:

+(Show the latest installable version's entry):
+$ equery changes portage
+*portage-2.1.6.13 (03 May 2009)
+
+  03 May 2009; Zac Medico <zmedico@gentoo.org> +portage-2.1.6.13.ebuild:
+  2.1.6.13 bump. This fixes bug #268398 (document econf automatic die)
+  and bug #267104 (handle insufficient space interaction with userfetch).
+  Bug #268228 tracks all bugs fixed since 2.1.6.11.
+

-Verifying Package Integrity +Verifying Package Integrity with check (k)

Sometimes it is useful to check a package's integrity. equery can -verify md5 sums as well as timestamps to indicate when a package might +verify MD5 sums as well as timestamps to indicate when a package might have been corrupted, replaced, or removed.

-# equery check gentoolkit -[ Checking app-portage/gentoolkit-0.2.0 ] - * 54 out of 54 files good +

+$ equery check gentoolkit
+ * Checking app-portage/gentoolkit-0.3.0_rc7 ...
+   71 out of 71 files passed

-Please note that if you change configuration files after installation, -these may be reported as "not good". -

-List of all packages depending on ... +Listing All Packages Depending on Package X with depends (d)

-equery is able to list all direct dependencies matching a package. -The function we should use to do this is depends and it's as easy as: +Ever wonder why a certain package has been installed on your system? + equery can tell which packages list it as a dependency with depends. Include indirect dependencies with the -D +option.

-# equery depends pygtk
-[ Searching for packages depending on pygtk... ]
-app-office/dia-0.93
-dev-python/gnome-python-2.0.0-r1
-gnome-extra/gdesklets-core-0.26.2
-media-gfx/gimp-2.0.4
-x11-libs/vte-0.11.11-r1
++$ equery depends pygtk
+ * Searching for pygtk ...
+app-admin/pessulus-2.24.0 (>=dev-python/pygtk-2.6.0)
+app-editors/gedit-2.24.3 (python ? >=dev-python/pygtk-2.12)
+dev-libs/libgweather-2.24.3 (python ? >=dev-python/pygtk-2)
+dev-python/gnome-python-base-2.22.3 (>=dev-python/pygtk-2.10.3)
+dev-python/gnome-python-desktop-base-2.24.1 (>=dev-python/pygtk-2.10.3)
+[...]

-Dependency Graphs +Getting Dependency Graphs with depgraph (g)

-equery is capable of giving us a dependency graph for a specified -package. The dependency graph gives a listing of all the packages that have -direct and indirect dependencies on the package in question. -

- -

-# equery depgraph cdrtools -Displaying dependencies for app-cdr/cdrtools-2.01_alpha37 -`-- app-cdr/cdrtools-2.01_alpha37 - `-- sys-libs/glibc-2.3.4.20040808 (virtual/libc) - `-- sys-kernel/linux-headers-2.4.22 (virtual/os-headers) - `-- sys-apps/baselayout-1.10.4 - `-- sys-apps/sysvinit-2.85-r1 - `-- sys-apps/gawk-3.1.3-r1 - `-- sys-apps/util-linux-2.12-r4 - `-- sys-apps/sed-4.0.9 - `-- sys-libs/ncurses-5.4-r4 - `-- sys-apps/pam-login-3.14 - `-- sys-libs/pam-0.77-r1 - `-- sys-libs/cracklib-2.7-r10 - `-- sys-apps/miscfiles-1.3-r1 - `-- app-arch/gzip-1.3.5-r1 - `-- sys-apps/portage-2.0.50-r10 +depgraph is the opposite of depends. You pass it a package, and +it will find the packages it depends on (not that depend on it). + When it finds a dependency, it will recursively search for all of + that package's dependencies. Control how deep the tree gets with + the --depth option. +

+ +

+$ equery depgraph mozilla-firefox
+ * Searching for mozilla-firefox ...
+ * dependency graph for www-client/mozilla-firefox-2.0.0.19:
+`-- www-client/mozilla-firefox-2.0.0.19
+ `-- virtual/jre-1.6.0 (virtual/jre) [java]
+  `-- virtual/jdk-1.6.0 (virtual/jdk-1.6.0*)
+  `-- dev-java/icedtea6-bin (unable to resolve: package masked or removed)
+   `-- dev-java/sun-jdk-1.6.0.15
+    `-- dev-java/java-sdk-docs-1.6.0.10 [doc]
+     `-- app-arch/unzip-6.0-r1
+      `-- app-arch/bzip2-1.0.5-r1 [bzip2]
+    `-- sys-libs/glibc-2.9_p20081201-r2
+     `-- sys-devel/gettext-0.17 [nls]
+      `-- virtual/libiconv-0 (virtual/libiconv)
+[...]

-For example, while glibc is a direct dependency for cdrtools,linux-headers -are an indirect dependency. Note that the output also includes information -about virtual packages. In the example above, cdrtools is actually -written to require virtual/libc, not sys-libs/glibc, but on the given -system in the example sys-libs/glibc provides virtual/libc. +Notice how jre is a direct dependency and jdk is an indirect +dependency if the java USE flag is set.

-Listing Files Belonging to an Ebuild +Listing Files Installed by a Package with files (f)

-equery can list the files that belong to an installed ebuild. If I -don't know the files that Gentoolkit has installed on the system, I will -use equery to show them. -

- -

-# equery files gentoolkit -[ Searching for packages matching gentoolkit... ] -app-portage/gentoolkit-0.2.0 -* Contents of app-portage/gentoolkit-0.2.0: -/usr -/usr/bin -/usr/bin/equery -/usr/bin/etcat -/usr/bin/euse -/usr/bin/glsa-check -/usr/bin/qpkg -/usr/bin/revdep-rebuild -/usr/lib -/usr/lib/gentoolkit -/usr/lib/gentoolkit/pym -/usr/lib/gentoolkit/pym/gentoolkit -/usr/lib/gentoolkit/pym/gentoolkit/__init__.py -/usr/lib/gentoolkit/pym/gentoolkit/gentoolkit.py -/usr/lib/gentoolkit/pym/gentoolkit/pprinter.py -/usr/lib/gentoolkit/pym/glsa.py -/usr/sbin -/usr/share -/usr/share/doc -/usr/share/doc/gentoolkit-0.2.0_pre10 - +equery can list all the files installed by an ebuild with the +files command. Try --tree to get an easy to read directory +layout. Use --filter to only find a certain type of file. For example, +to find where executables were installed, use --filter=cmd, and to +quickly find the configuration file location, try --filter=conf. +

+ +

+$ equery files --tree gentoolkit
+ * Searching for gentoolkit ...
+ * Contents of app-portage/gentoolkit-0.3.0_rc7:
+ /etc
+   > /eclean
+      + distfiles.exclude
+      + packages.exclude
+   > /env.d
+      + 99gentoolkit-env
+   > /revdep-rebuild
+      + 99revdep-rebuild
+ /usr
+   > /bin
+      + eclean
+      + eclean-dist -> eclean
+      + eclean-pkg -> eclean
+      + epkginfo
+      + equery
+      + eread
+      + euse
+      + glsa-check
+      + revdep-rebuild
+   > /lib
+      > /python2.6
+         > /site-packages
+            > /gentoolkit
+            + gentoolkit-0.3.0_rc7-py2.6.egg-info
+               + __init__.py
+               > /equery
+                  + __init__.py
+                  + belongs.py
+                  + changes.py
+                  + check.py
+                  + depends.py
+                  + depgraph.py
+                  + files.py
 [...]

-The command files of equery provide some options to modify -the output. You can look them all up in the equery man page. -

-Looking for packages that use a specific USE flag +Looking for Packages that Have a Specific USE Flag with hasuse (h)

-If you want to find which packages on your system that make use of a specific -USE flag, equery has the function hasuse: +You can use hasuse to find out which packages have a given USE flag. +hasuse won't tell you if the flag is enabled, only if the ebuild lists +it as an option. See the EXAMPLES section of hasuse in the +equery man page for more tip on getting that information.

-# equery hasuse firefox
-[ Searching for USE flag firefox in all categories among: ]
- * installed packages
-[I--] [  ] dev-python/gnome-python-extras-2.14.0-r1 (0)
-[I--] [  ] media-video/totem-2.16.4 (0)
++$ equery hasuse qt3 qt4
+ * Searching for USE flag qt3 ... 
+[IP-] [  ] app-crypt/pinentry-0.7.5 (0)
+[IP-] [  ] net-dns/avahi-0.6.24-r2 (0)
+[IP-] [  ] net-wireless/wpa_supplicant-0.6.9 (0)
+
+ * Searching for USE flag qt4 ... 
+[IP-] [  ] net-dns/avahi-0.6.24-r2 (0)
+[IP-] [  ] net-wireless/wpa_supplicant-0.6.9 (0)

-Listing Packages +Listing Packages with list (l)

-equery has a power feature to list packages belonging to our system, -portage or even an overlay. Let's try this: +list is a simple but powerful module to list packages that are installed, +in the Portage tree or in an overlay.

-# equery list gentoolkit
-[ Searching for package 'gentoolkit' in all categories among: ]
- * installed packages
-[I--] [  ] app-portage/gentoolkit-0.2.0 (0)
++$ equery list '*'
+ * Searching for * ...
+[IP-] [  ] app-admin/eselect-1.2.3 (0)
+[IP-] [  ] app-admin/eselect-ctags-1.10 (0)
+[IP-] [  ] app-admin/eselect-esd-20060719 (0)
+[IP-] [  ] app-admin/eselect-fontconfig-1.0 (0)
+[IP-] [  ] app-admin/eselect-opengl-1.0.8-r1 (0)
+[IP-] [  ] app-admin/eselect-python-20090824 (0)
+[IP-] [  ] app-admin/eselect-ruby-20081227 (0)
+[IP-] [  ] app-admin/eselect-vi-1.1.5 (0)
+[IP-] [  ] app-admin/perl-cleaner-1.05 (0)
+[IP-] [  ] app-admin/pessulus-2.24.0 (0)
+[IP-] [  ] app-admin/python-updater-0.7 (0)
+[IP-] [  ] app-admin/sudo-1.7.2_p1 (0)
+[...]
 
 
 
-The standard query will search our installed packages for the name given.
-If found, the following info will be displayed: the package location between
-the first square brackets (I for Installed packages, P for Portage, O for
-Overlay), the possible masks between the second (~ by keyword, -  by arch or
-M hard masked), then the category and complete name and last of all, the slot
-in which the package is stored.
+The standard query will search installed packages for the given package name.
+Passing in '*' displays all packages in the set. In the left-most field, we 
+see that all the above packages are Installed and from the Portage
+tree. They're not masked (the second field is blank), and they're all installed
+in the default slot (0).
+
+
+
+This time we are going to use local options to look for packages in the
+ Portage tree and overlays.
+
+
++$ equery list -po vim
+ * Searching for vim ...
+[-P-] [  ] app-editors/vim-7.0.235 (0)
+[-P-] [ ~] app-editors/vim-7.0.243 (0)
+[-P-] [  ] app-editors/vim-7.1.123 (0)
+[-P-] [ ~] app-editors/vim-7.1.330 (0)
+[-P-] [  ] app-editors/vim-7.2 (0)
+[-P-] [ ~] app-editors/vim-7.2.108 (0)
+[IP-] [  ] app-editors/vim-7.2.182 (0)
+[-P-] [ ~] app-editors/vim-7.2.238 (0)
+[-P-] [ ~] app-editors/vim-7.2.264 (0)
+
+
+
+In this example you can see version 7.2.182 is installed and there are no
+ versions available from an overlay. You can see which versions are keyword 
+masked by the ~ in the second field.
+
+
+
+

+Viewing Package Metadata with meta (m) + + +

+Each package in the Portage tree provides at least some metadata about +its maintainer, herd, etc. Read about Gentoo Metadata. +The amount of useful information depends on how much package maintainers +decide to provide. With no options, meta returns some basic useful +information.

+$ equery meta gnucash
+ * app-office/gnucash [gentoo]
+ Herd:        gnome-office (gnome-office@gentoo.org)
+ Maintainer:  tove@gentoo.org (Torsten Veller)
+ Upstream:    None specified
+ Location:    /usr/portage/app-office/gnucash
+ Keywords:    2.2.9-r1:0: alpha amd64 ppc sparc x86
+ Keywords:    2.2.9-r2:0: 
+ Keywords:    2.3.8:0: 
+ Keywords:    2.3.10:0: ~alpha ~amd64 ~ppc ~sparc ~x86
+

-Another example, this time we are going to use the local options in order -to look for packages in our portage tree and overlay. +When the maintainer provides extra information, it can be very useful:

-# equery list -p -o vim
-[ Searching for package 'vim' in all categories among: ]
- * installed packages
-[I--] [  ] app-editors/vim-6.3-r4 (0)
- * Portage tree (/usr/portage)
-[-P-] [M~] app-editors/vim-7.0_alpha20050126 (0)
-[-P-] [M~] app-editors/vim-7.0_alpha20050201 (0)
-[-P-] [  ] app-editors/vim-6.3-r2 (0)
-[-P-] [M~] app-editors/vim-7.0_alpha20050122 (0)
-[-P-] [M~] app-editors/vim-core-7.0_alpha20050126 (0)
-[-P-] [  ] app-editors/vim-core-6.3-r3 (0)
-[-P-] [M~] app-editors/vim-core-7.0_alpha20050122 (0)
-[-P-] [M~] app-editors/vim-core-7.0_alpha20050201 (0)
-[-P-] [  ] app-editors/vim-core-6.3-r4 (0)
- * overlay tree (/opt/ebuilds)
++$ equery meta --description emacs
+ * app-editors/emacs
+  GNU Emacs is an extensible, customizable text editor - and more. At its core
+  is an interpreter for Emacs Lisp, a dialect of the Lisp programming language
+  with extensions to support text editing. The features of GNU Emacs include:
+   * Content-sensitive editing modes, including syntax coloring, for a wide
+     variety of file types including plain text, source code, and HTML.
+   * Complete built-in documentation, including a tutorial for new users.
+   * Support for many languages and their scripts, including all the European
+     "Latin" scripts, Russian, Greek, Japanese, Chinese, Korean, Thai,
+     Vietnamese, Lao, Ethiopian, and some Indian scripts.
+   * Highly customizable, using Emacs Lisp code or a graphical customization
+     interface.
+   * A large number of extensions that add other functionality, including a
+     project planner, mail and news reader, debugger interface, calendar, and
+     more. Many of these extensions are distributed with GNU Emacs; others are
+     available separately.

-Finding Package Sizes +Finding Package Sizes with size (s)

@@ -366,52 +509,65 @@ equery to the rescue!

-# equery size openoffice-bin
-* app-office/openoffice-bin-1.1.2
-     Total Files : 2908
-     Total Size  : 223353.31 KiB
++$ equery size openoffice-bin
+ * app-office/openoffice-bin-3.1.1
+         Total files : 4624
+         Total size  : 361.38 MiB
 
 
 
-As you can see, equery prints the total space used in kilobytes and
-also lists the total number of files the package has.
+As you can see, size prints the total space used in human-readable
+units and also lists the total number of files the package has. To get the
+total size in bytes, use --bytes.

-Package-wise list of USE Flags +Listing Per-Package USE Flags with uses (u)

-equery can be used to give us information about what USE flags -are being used by a specific package. It also tells us what our current USE -flags are for a package and also what USE flags are available for the package. +equery's uses module can provide information about what USE +flags are available for a specific package, and which of those flags is +currently enabled.

-# equery uses wireshark
-[ Colour Code : set unset ]
-[ Legend    : (U) Col 1 - Current USE flags        ]
-[           : (I) Col 2 - Installed With USE flags ]
-
- U I [ Found these USE variables in : net-analyzer/wireshark-0.99.4 ]
- - - adns      : Adds support for the adns DNS client library
- + + gtk       : Adds support for x11-libs/gtk+ (The GIMP Toolkit)
- - - ipv6      : Adds support for IP version 6
- - - kerberos  : Adds kerberos support
- - - portaudio : Adds support for the crossplatform portaudio audio API
- - - selinux   : !!internal use only!! Security Enhanced Linux support, this must be set by the selinux profile or breakage will occur
- - - snmp      : Adds support for the Simple Network Management Protocol if available
- + + ssl       : Adds support for Secure Socket Layer connections
- - - threads   : Adds threads support for various packages. Usually pthreads
++$ equery uses gst-plugins-meta
+ * Searching for gst-plugins-meta ...
+[ Legend : U - flag is set in make.conf       ]
+[        : I - package is installed with flag ]
+[ Colors : set, unset                         ]
+ * Found these USE flags for media-plugins/gst-plugins-meta-0.10-r2:
+ U I
+ + + X      : Adds support for X11
+ - - a52    : Enables support for decoding ATSC A/52 streams used in DVD
+ + + alsa   : Adds support for media-libs/alsa-lib (Advanced Linux Sound
+              Architecture)
+ - - dvb    : Adds support for DVB (Digital Video Broadcasting)
+ + + dvd    : Adds support for DVDs
+ + + esd    : Adds support for media-sound/esound (Enlightened Sound Daemon)
+ + + ffmpeg : Enable ffmpeg-based audio/video codec support
+ + + flac   : Adds support for FLAC: Free Lossless Audio Codec
+ - - mad    : Adds support for mad (high-quality mp3 decoder library and cli
+              frontend)
+ + + mpeg   : Adds libmpeg3 support to various packages
+ - - mythtv : Support for retrieval from media-tv/mythtv backend
+ + + ogg    : Adds support for the Ogg container format (commonly used by
+              Vorbis, Theora and flac)
+ - - oss    : Adds support for OSS (Open Sound System)
+ + + theora : Adds support for the Theora Video Compression Codec
+ + + vorbis : Adds support for the OggVorbis audio codec
+ - - xv     : Adds in optional support for the Xvideo extension (an X API for
+              video playback)
 
 
 
-I have installed wireshark with only the gtk and ssl flags set, but there are
-several other USE flags for wireshark still available. For more information on
-USE flags, please refer to the gstreamer's plugin
+ meta-package, but you can see that there are other USE flags available.
+ For more information on USE flags, please refer to the USE Flags
 chapter of the Gentoo Handbook.
 
@@ -419,20 +575,40 @@

-Where's the ebuild? +Finding the Ebuild Path with which (w)

-We can also find out which ebuild is being used for a specific package using -equery. This is done by using the equery which command which -displays the full path to the ebuild. +which is a simple script to help you quickly find the file path to an + ebuild. If you pass an unversioned package name, which will return the +path to the newest installable ebuild version, in other words, the ebuild +Portage would use if you typed emerge package. Pass in a versioned + package to get the path to that ebuild.

-# equery which cdrtools -/usr/portage/app-cdr/cdrtools/cdrtools-2.01_alpha37.ebuild +

+$ equery which gnome
+/usr/portage/gnome-base/gnome/gnome-2.26.3.ebuild

+Lastly, if none of the above features of equery have answered your +question, try using which to manually search an ebuild with programs + like cat, less or grep: +

+ +

+$ grep HOMEPAGE $(equery which gentoolkit)
+HOMEPAGE="http://www.gentoo.org/proj/en/portage/tools/index.xml"
+

+ + +Be aware that equery currently changes the format of the output if it is sent +through a pipe. The piped format is intended to be easier to parse by tools, but +you can also turn it off by adding the --no-pipe option. If you write +scripts that employ equery, you should be aware of this. + +

-glsa-check is mainly a test tool that keeps track of the various GLSAs +glsa-check is mainly a test tool that keeps track of the various GLSA's (Gentoo Linux Security Advisory) and will eventually be integrated into emerge and equery.