-.TH "ANALYSE" "22" "Febuary 2010" "GENTOOLKIT"
+.TH "ANALYSE" "22" "Febuary 2010" "GENTOOLKIT" ""
.SH "NAME"
analyse \- Gentoo Installed Package Analysis Tool
.SH "SYNOPSIS"
-.BI "analyse " "[global-options] " "module " "[local-options]" "TARGET"
+.BI "analyse " "[global\-options] " "module " "[local\-options]" "TARGET"
.SH "DESCRIPTION"
.B Analyse
Is a collection of modules for analysing the state of installed Gentoo packages for
USE flags or keywords used for installation, and their current masking status.
-.br
+.br
It can also optionally (re)generate new /etc/portage/package.* files.
.br
-.br
+.br
.B CAUTION:
This is beta software and is not yet feature complete. Some features, options or its name
may change in the future. Any files that it generates are saved to your home directory
and will not harm your system without effort on your part.
-.br
+.br
.SH "GLOBAL OPTIONS"
.HP
.B \-h, \-\-help
-.br
+.br
Output a help message.
.HP
.B \-q, \-\-quiet
-.br
+.br
Be less verbose where possible. In some modules, this option can increase the output speed.
.HP
-.B \-C, \-\-no-color
-.br
+.B \-C, \-\-no\-color
+.br
Do not colorize output.
.HP
.B \-N, \-\-no\-pipe
-.br
+.br
Turn off automatic pipe detection. Use this option if you do not want
.B analyse
To detect if the output is being directed to the screen or to another program
and adjust color and verbosity accordingly.
.HP
.B \-V, \-\-version
-.br
+.br
Display \fBGentoolkit\fP's version. Please include this in all bug reports. (see
.B BUGS
below)
You can view the
.B help
message for a specific module by using
-.BR "-h" ", " "--help "
+.BR "\-h" ", " "\-\-help "
as either a global option (after
.B analyse
and before the module name) or as a local option (after the module name).
Report on all installed packages for \fITARGET\fP.
.P
-.IR "TARGET" ":"
+.I R "TARGET" ":"
.HP
.B use
-.br
+.br
Will analyse the installed with USE flags for output results.
.HP
.B pkguse
-.br
+.br
Will analyse the USE flags information from the installed pkg's 'PKGUSE' file which contains
only flags settings from /etc/portage/package.use at the time of installation.
.HP
.B keywords
-.br
+.br
Will analyse the recorded keywords for output results.
.HP
.B unmask
-.br
+.br
Will analyse the installed packages and portage trees for pkgs that require unmasking and report them.
-.br
+.br
.P
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
.B \-u, \-\-unset
-.br
+.br
Will also include any USE flags used that were not enabled for some packages.
.HP
.B \-v, \-\-verebose
-.br
+.br
Gives more detail about the results found and the current task being performed.
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
-analyse a --verbose --unset use
+analyse a \-\-verbose \-\-unset use
.EE
-.br
-Report on all use flags used to install the packages. (--unset) Include in the report all flags
+.br
+Report on all use flags used to install the packages. (\-\-unset) Include in the report all flags
that have been used but also were not set enabled for some packages.
-(--verbose) Also list the packages that used the USE flag setting.
+(\-\-verbose) Also list the packages that used the USE flag setting.
The report will break down the useage and report the USE flag up to 3 times indicating its
-setting {"+","-"," "= unset} prepended to the flag name.
+setting {"+","\-"," "= unset} prepended to the flag name.
It will also color the output, red = Disabled, blue = Enabled, plain text = unset
-.br
+.br
.SS
.BI "rebuild (r) [OPTIONS] TARGET"
Create a list all packages for \fITARGET\fP settings that are needed for
other than the default settings.
-.IR "TARGET" ":"
+.I R "TARGET" ":"
.HP
.B use
-.br
+.br
Will analyse the USE flags for output results.
.HP
.B keywords
-.br
+.br
Will analyse the keywords for output results.
.HP
.B unmask
-.br
+.br
Will analyse the installed packages and portage trees for pkgs that require
unmasking and produce output/a new /etc/portage/package.unmask file.
.P
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
.B \-a, \-\-all
-.br
+.br
Create files/output for all TARGET(s) found to need it. (not Implemented yet)
.HP
.B \-e, \-\-excact
-.br
+.br
Will prepend the pkg with = as well as use the version information for the entries.
-.br
-eg.: =CAT/PKG-VER flag1 flag2
+.br
+eg.: =CAT/PKG\-VER flag1 flag2
.HP
.B \-p, \-\-pretend
-.br
+.br
Sends the output to the screen instead of a file.
.HP
.B \-v, \-\-verebose
-.br
+.br
Gives more detail about the results found and the current task being performed.
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
-analyse rebuild -p use
+analyse rebuild \-p use
.EE
-.br
+.br
Analyse the installed packages database and current system USE flag settings
and output the results in the form of:
-.br
+.br
-.br
+.br
.EX
-CAT/PKG -flag1 -flag2 flag3 flag4...
+CAT/PKG \-flag1 \-flag2 flag3 flag4...
.SS
.BI "clean (c) [OPTIONS] TARGET"
Clean all packages for \fITARGET\fP settings that are found with obsolete settings
for the current settings and pkg ebuild. (not Implemented yet)
-.IR "TARGET" ":"
+.I R "TARGET" ":"
.HP
.B use
-.br
+.br
Will analyse the USE flags and /etc/portage/package.use file(s) for entries that
are redundant or no longer used by the pkg.
.HP
.B keywords
-.br
+.br
Will analyse the keywords and /etc/portage/package.keywords file(s) for entries
that are no longer needed.
.HP
.B unmask
-.br
+.br
Will analyse the installed packages, /etc/portage/package.unmask file(s) and
portage trees for pkgs that no longer require unmasking.
.P
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
.B \-a, \-\-all
-.br
+.br
Clean files/output for all TARGET(s) found to need it. (not Implemented yet)
.HP
.B \-p, \-\-pretend
-.br
+.br
Sends the output to the screen instead of a file.
.HP
.B \-v, \-\-verebose
-.br
+.br
Gives more detail about the results found and the current task being performed.
Submit bug reports to http://bugs.gentoo.org.
.SH "AUTHORS"
-.br
+.br
Brian Dolbec <brian.dolbec@gmail.com>, 2010
-.TH "eclean" "1" "0.4.1" "gentoolkit"
+.TH "eclean" "1" "0.4.1" "gentoolkit" ""
.SH "NAME"
eclean \- A cleaning tool for Gentoo distfiles and binary packages.
.SH "SYNOPSIS"
-.LP
+.LP
.B eclean \fR[\fIglobal\-options\fR] ... <\fIactions\fR> \fR[\fIaction\-options\fR] ...
-.LP
+.LP
.B eclean\-dist \fR[\fIglobal\-options, distfiles\-options\fR] ...
-.LP
+.LP
.B eclean\-pkg \fR[\fIglobal\-options, packages\-options\fR] ...
-.LP
-.B eclean(-dist,-pkg) \fR[\fI\-\-help, \-\-version\fR]
+.LP
+.B eclean(\-dist,\-pkg) \fR[\fI\-\-help, \-\-version\fR]
.SH "DESCRIPTION"
\fBeclean\fP is small tool to remove obsolete portage sources files and binary packages.
Used on a regular basis, it prevents your DISTDIR and PKGDIR directories to
infinitely grow, while not deleting files which may still be useful.
-.PP
+.PP
By default, eclean will protect all distfiles or binary packages corresponding to some
ebuilds available in the Portage tree. This is the safest mode, since it will protect
whatever may still be useful, for instance to downgrade a package without downloading
without recompiling it. Sure, it's also a mode in which your DISTDIR and PKGDIR will
stay rather big (although still not growing infinitely). For the 'distfiles', this
mode is also quite slow because it requiries some access to the whole Portage tree.
-.PP
+.PP
If you use the \-\-destructive option, eclean will only protect files corresponding to
some currently installed package (taking their exact version into account). It will
save much more space, while still preserving sources files around for minor revision
for less usual operations like downgrading or reinstalling an unmerged package. This
is also the fastest execution mode (big difference for distfiles), and the one used by
most other cleaning scripts around like yacleaner (at least in its version 0.3).
-.PP
+.PP
Somewhere in the middle, adding the \-\-package\-names option when using \-\-destructive
will protect files corresponding to all existing versions of installed packages. It will
allow easy downgrading without recompilation or redownloading in case of trouble, but
won't protect you against package uninstallation.
-.PP
+.PP
In addition to this main modes, some options allow to declare a few special cases file
protection rules:
.IP o
-\-\-time-limit is useful to protect files which are more recent than a given amount of time.
+\-\-time\-limit is useful to protect files which are more recent than a given amount of time.
.IP o
-\-\-size-limit (for distfiles only) is useful if you want to protect files bigger than a given size.
+\-\-size\-limit (for distfiles only) is useful if you want to protect files bigger than a given size.
.IP o
-\-\-fetch-restricted (for distfiles only) is useful to protect manually downloaded files.
+\-\-fetch\-restricted (for distfiles only) is useful to protect manually downloaded files.
But it's also very slow (again, it's a reading of the whole Portage tree data)...
.IP o
Finally, you can list some categories or package names to protect in exclusion files (see
\fBEXCLUSION FILES\fP below).
.SH "PARAMETERS"
.SS "Global options"
-.TP
+.TP
\fB\-C, \-\-nocolor\fP turn off colors on output
-.TP
+.TP
\fB\-d, \-\-destructive\fP only keep the minimum for a reinstallation
-.TP
+.TP
\fB\-e, \-\-exclude\-file=<path>\fP path to the exclusion file
\fB<path>\fP is the absolute path to the exclusion file you want to use.
When this option is not used, default paths are /etc/eclean/{packages,distfiles}.exclude
(if they exist). Use /dev/null if you have such a file at it standard location and
you want to temporary ignore it.
-.TP
+.TP
\fB\-i, \-\-interactive\fP ask confirmation before deleting
-.TP
+.TP
\fB\-n, \-\-package\-names\fP protect all versions (\-\-destructive only)
-.TP
+.TP
\fB\-p, \-\-pretend\fP only display what would be cleaned
-.TP
+.TP
\fB\-q, \-\-quiet\fP be as quiet as possible, only display errors
-.TP
-\fB\-t, \-\-time-limit=<time>\fP don't delete files modified since <time>
+.TP
+\fB\-t, \-\-time\-limit=<time>\fP don't delete files modified since <time>
\fB<time>\fP is an amount of time: "1y" is "one year", "2w" is "two weeks", etc.
-.br
+.br
Units are: y (years), m (months), w (weeks), d (days) and h (hours).
-.TP
+.TP
\fB\-h, \-\-help\fP display the help screen
-.TP
+.TP
\fB\-v, \-\-verbose\fP display more verbose messages during processing
-.TP
+.TP
\fB\-V, \-\-version\fP display version informations
.SS "Actions"
-.TP
+.TP
\fBdistfiles\fR
Clean files from /usr/portage/distfiles (or whatever else is your DISTDIR in /etc/make.conf).
This action should be useful to almost any Gentoo user, we all have to big DISTDIRs sometime...
-.br
+.br
\fBeclean\-dist\fP is a shortcut to call eclean with the "distfiles" action, for simplified
command\-line.
-.TP
+.TP
\fBpackages\fR
Clean files from /usr/portage/packages (or whatever else is your PKGDIR in /etc/make.conf).
This action is in particular useful for people who use the "buildpkg" or "buildsyspkg"
FEATURES flags.
-.br
+.br
\fBeclean\-pkg\fP is a shortcut to call eclean with the "packages" action, for simplified
command\-line.
.SS "Options for the 'distfiles' action"
-.TP
-\fB\-f, \-\-fetch-restricted\fP protect fetch-restricted files (\-\-destructive only)
-.TP
-\fB\-s, \-\-size-limit=<size>\fP don't delete distfiles bigger than <size>
+.TP
+\fB\-f, \-\-fetch\-restricted\fP protect fetch\-restricted files (\-\-destructive only)
+.TP
+\fB\-s, \-\-size\-limit=<size>\fP don't delete distfiles bigger than <size>
<size> is a size specification: "10M" is "ten megabytes", "200K" is "two hundreds kilobytes",
etc.
-.br
+.br
Units are: G, M, K and B.
.SS "Options for the 'packages' action"
-.TP
+.TP
There is no specific option for this action.
.SH "EXCLUSION FILES"
Exclusions files are lists of packages names or categories you want to protect
all installed distfile sources, run elcelan in pretend mode first. Then check which sources it was
not able to find the filename(s) for and add entries for them in the distfiles.exclude file before
running eclean again.
-.LP
+.LP
By default, if it exists, /etc/eclean/packages.exclude (resp. distfiles.exclude) will be use
when action is "packages" (resp. "distfiles"). This can be overide with the \-\-exclude\-file
option.
.SH "EXAMPLES"
-.LP
+.LP
Clean distfiles only, with per file confirmation prompt:
-.br
+.br
.B # eclean \-i distfiles
-.LP
-Check which binary packages could be removed, with a no-color display:
-.br
+.LP
+Check which binary packages could be removed, with a no\-color display:
+.br
.B # eclean \-Cp packages
-.LP
+.LP
Clean binary packages of uninstalled packages, but keep all versions of installed ones:
-.br
-.B # eclean-pkg \-d \-n
-.LP
+.br
+.B # eclean\-pkg \-d \-n
+.LP
Clean all distfiles except for installed packages (exact version), those which
-are less than one month old, bigger than 50MB, or fetch-restricted:
-.br
-.B # eclean-dist \-d \-t1m -s50M -f
-.LP
+are less than one month old, bigger than 50MB, or fetch\-restricted:
+.br
+.B # eclean\-dist \-d \-t1m \-s50M \-f
+.LP
From a crontab, silently clean packages in the safest mode, and then distfiles in destructive
mode but protecting files less than a week old, every sunday at 1am:
-.br
+.br
.B 0 1 * * sun \ \ eclean \-C \-q packages ; eclean \-C \-q \-d \-t1w distfiles
.SH "NOTE"
-.TP
+.TP
While running and searching distfiles for cleaning, elcean will report any deprecated packages
it finds installed on your system. Those sources may not be protected if the SRC_URI is not recorded
in the installed package database. The SRC_URI is no longer recorded by recent portage/pkgcore versions.
-.".SH "BUGS"
-.".TP
+."
+.SH "BUGS"
+.".TP
."The policy used to decide if a distfile can be removed or not relies on the SRC_URI variables ."of ebuilds. It means that if an ebuild uses files that are not part of its SRC_URI, eclean will ."probably remove them. This are ebuilds bugs, please report them as such on ."http://bugs.gentoo.org.
-.".TP
+.".TP
."In safest mode (default, without the \-\-destructive option), this script can be very slow. There
."is not much to do about it without hacking outside of the portage API.
.SH "SEE ALSO"
-.TP
+.TP
The Gentoo forum thread that gave birth to eclean:
.B http://forums.gentoo.org/viewtopic.php?t=3011
-.TP
+.TP
The bug report requesting eclean inclusion in gentoolkit:
.B http://bugs.gentoo.org/show_bug.cgi?id=33877
.SH "AUTHORS"
Thomas de Grenier de Latour (tgl) <degrenier@easyconnect.fr>
-.br
-modular re-write by:
-.br
-Brian Dolbec (dol-sen) <brian.dolbec@gmail.com>
+.br
+modular re\-write by:
+.br
+Brian Dolbec (dol\-sen) <brian.dolbec@gmail.com>
-.TH "EQUERY" "1" "August 2009" "GENTOOLKIT"
+.TH "EQUERY" "1" "August 2009" "GENTOOLKIT" ""
.SH "NAME"
equery \- Gentoo Package Query Tool
.SH "SYNOPSIS"
-.BI "equery " "[global-options] " "module " "[local-options]"
+.BI "equery " "[global\-options] " "module " "[local\-options]"
.SH "DESCRIPTION"
.B Equery
.SH "GLOBAL OPTIONS"
.HP
.B \-h, \-\-help
-.br
+.br
Output a help message.
.HP
.B \-q, \-\-quiet
-.br
+.br
Be less verbose where possible. In some modules, this option can increase the output speed.
.HP
-.B \-C, \-\-no-color
-.br
+.B \-C, \-\-no\-color
+.br
Do not colorize output.
.HP
.B \-N, \-\-no\-pipe
-.br
+.br
Turn off automatic pipe detection. Use this option if you do not want
.B equery
to detect if the output is being directed to the screen or to another program and adjust color and verbosity accordingly.
.HP
.B \-V, \-\-version
-.br
+.br
Display \fBGentoolkit\fP's version. Please include this in all bug reports. (see
.B BUGS
below)
You can view the
.B help
message for a specific module by using
-.BR "-h" ", " "--help "
+.BR "\-h" ", " "\-\-help "
as either a global option (after
.B equery
and before the module name) or as a local option (after the module name).
.B BUGS
below)
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
-.B \-f, \-\-full-regex
-.br
+.B \-f, \-\-full\-regex
+.br
The supplied query is a regular expression.
.HP
-.B \-e, \-\-early-out
-.br
+.B \-e, \-\-early\-out
+.br
Stop when the first match is found. This is generally a safe optimization when searching for the owner of a single file.
.HP
-.B \-n, \-\-name-only
-.br
+.B \-n, \-\-name\-only
+.br
Do not print the version.
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
-equery belongs --early-out /usr/bin/euse
+equery belongs \-\-early\-out /usr/bin/euse
.EE
-.br
+.br
Find out what package installed a certain command.
.EX
.HP
-emerge -p $(equery -q belongs -nf '^/usr/bin/g?vim.*')
+emerge \-p $(equery \-q belongs \-nf '^/usr/bin/g?vim.*')
.EE
-.br
+.br
Tell
.B emerge
to reinstall or update any package that installed a file matching a regular expression.
.BI "changes (c) [OPTIONS] " "PKG"
Display the Gentoo ChangeLog entry for the latest installable version of \fIPKG\fP.
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
.B \-l, \-\-latest
-.br
+.br
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.
.HP
.B \-f, \-\-full
-.br
+.br
Display the full ChangeLog.
-.br
+.br
\fBHint\fP: Try piping (|) the output to a pager, like 'less'.
.HP
.BI "\-\-limit=" "NUM"
-.br
-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.
+.br
+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.
.HP
.BI "\-\-from=" "VER"
-.br
-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.
+.br
+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.
.HP
.BI "\-\-to=" "VER"
-.br
-Set which \fIVER\fP to display to. (See \fB--from\fP)
+.br
+Set which \fIVER\fP to display to. (See \fB\-\-from\fP)
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
equery changes portage
.EE
-.br
+.br
Display the Gentoo ChangeLog entry for the latest installable version of Portage.
.EX
.HP
-equery changes '=sys-apps/portage-2.1.6*'
+equery changes '=sys\-apps/portage\-2.1.6*'
.EE
-.br
+.br
Use Portage's atom syntax. (See \fBman 5 ebuild\fP)
.EX
.HP
-equery changes portage --from=2.2_rc1 --to=2.2
+equery changes portage \-\-from=2.2_rc1 \-\-to=2.2
.EE
-.br
+.br
Display any ChangeLog entry within a range of versions.
.SS
.BI "check (k) [OPTIONS] " "PKG"
Check timestamps and MD5 sums for files owned by \fIPKG\fP, where \fIPKG\fP is an installed package.
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
-.B \-f, \-\-full-regex
-.br
+.B \-f, \-\-full\-regex
+.br
The supplied query is a regular expression.
.HP
-.B \-o, \-\-only-failures
-.br
+.B \-o, \-\-only\-failures
+.br
Only display packages which don't pass all checks.
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
-equery check --only-failures '*'
+equery check \-\-only\-failures '*'
.EE
-.br
+.br
Verify timestamps and MD5 sums for all installed packages and show only packages which fail checks.
.EX
.HP
-equery check 'dev-python/*' dev-lang/python
+equery check 'dev\-python/*' dev\-lang/python
.EE
-.br
-Verify every installed package in the \fBdev-python\fP category, and Python itself.
+.br
+Verify every installed package in the \fBdev\-python\fP category, and Python itself.
.SS
.BI "depends (d) [OPTIONS] " "PKG"
List all packages that depend on \fIPKG\fP.
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
-.B \-a, \-\-all-packages
-.br
+.B \-a, \-\-all\-packages
+.br
Include dependencies that are not installed. This can take a while.
.HP
.B \-D, \-\-indirect
-.br
+.br
Search for both direct and indirect dependencies.
.HP
.BI "\-\-depth=" "NUM"
-.br
-Limit the indirect dependency tree to a depth of \fINUM\fP. \fB--depth=0\fP is equivalent to not using \fB--indirect\fP.
+.br
+Limit the indirect dependency tree to a depth of \fINUM\fP. \fB\-\-depth=0\fP is equivalent to not using \fB\-\-indirect\fP.
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
-equery depends --indirect xulrunner
+equery depends \-\-indirect xulrunner
.EE
-.br
+.br
Figure out why a package got installed on your system.
.SS
Display a direct dependency graph for every matching version of \fIPKG\fP. A dependency graph is an
indented tree showing the relationship between packages and their dependencies.
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
-.B \-A, \-\-no-atom
-.br
+.B \-A, \-\-no\-atom
+.br
Do not show the dependency atom that match the package.
.HP
-.B \-U, \-\-no-useflags
-.br
+.B \-U, \-\-no\-useflags
+.br
Do not show USE flags.
.HP
.B \-l, \-\-linear
-.br
+.br
Do not format the graph by indenting dependencies. This option will print the
recursion depth in square brackets before the package name for easier viewing
in narrow terminals.
.HP
.BI "\-\-depth=" "NUM"
-.br
-Limit the dependency graph to a depth of \fINUM\fP. \fB--depth=0\fP means no
+.br
+Limit the dependency graph to a depth of \fINUM\fP. \fB\-\-depth=0\fP means no
maximum depth. Default depth is set to 1.
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
-equery depgraph --depth=0 portage
+equery depgraph \-\-depth=0 portage
.EE
-.br
-View a full tree of all direct and indirect compile-time, run-time, and post-merge dependencies for a package.
+.br
+View a full tree of all direct and indirect compile\-time, run\-time, and post\-merge dependencies for a package.
.SS
.BI "files (f) [OPTIONS] " "PKG"
List files and directories installed by \fIPKG\fP.
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
.B \-m, \-\-md5sum
-.br
+.br
Include the file's MD5 sum in the output.
.HP
.B \-s, \-\-timestamp
-.br
+.br
Include the file's timestamp in the output.
.HP
.B \-t, \-\-type
-.br
+.br
Include the file type in the output.
.HP
.B \-\-tree
-.br
+.br
Display files in a tree format. This option turns off all other local options.
.HP
.BI "\-f, \-\-filter=" "RULES"
-.br
+.br
Filter output by file type.
.HP
RULES
-.br
-A comma-separated list (no spaces); choose from:
-.br
+.br
+A comma\-separated list (no spaces); choose from:
+.br
.B dir, obj, sym, dev, path, conf, cmd, doc, man, info
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
-equery files --tree vlc
+equery files \-\-tree vlc
.EE
-.br
+.br
View a file tree of all files installed by a package.
.EX
.HP
-equery files --filter=cmd vlc
+equery files \-\-filter=cmd vlc
.EE
-.br
+.br
Find out where a package installed its executables.
.SS
\fBNote\fP: \fBKEY\fP is case sensitive. Also \fBhas\fP does not currently have the ability to inteligently compare values dependending on the type of information being looked up. It performs a simple string match. It can only list which packages have the matching \fBVALUE\fP as given on the command line. It is a general purpose lookup for most information available via portage's dbapi.aux_get() function. Warning the quality of the results printed is dependant on the quality of the search (given the limited comparison method) and the recorded data available in the vardb. (See \fIEXAMPLES\fP)
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
-.B \-I, \-\-exclude-installed
-.br
+.B \-I, \-\-exclude\-installed
+.br
Exclude installed packages from being output.
.HP
-.B \-o, \-\-overlay-tree
-.br
+.B \-o, \-\-overlay\-tree
+.br
Include package from overlays in the search path.
.HP
-.B \-p, \-\-portage-tree
-.br
+.B \-p, \-\-portage\-tree
+.br
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.
.HP
.B \-F, \-\-format=\fITMPL\fP
.br
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.
.P
-.IR "OUTPUT" ":"
+.I R "OUTPUT" ":"
.HP
(See \fIOUTPUT\fP for \fBlist\fP below)
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
equery has SLOT 2.4
.EE
-.br
+.br
View all installed Gentoo packages that have a recorded SLOT = "2.4".
.EX
.HP
equery has repository sunrise
.EE
-.br
+.br
View all installed Gentoo packages that were recorded to be installed from ebuilds from the "sunrise" overlay.
.EX
.HP
equery has EAPI 2
.EE
-.br
+.br
View all installed Gentoo packages that were installed with ebuilds with a recorded EAPI of "2".
.SS
\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)
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
-.B \-I, \-\-exclude-installed
-.br
+.B \-I, \-\-exclude\-installed
+.br
Exclude installed packages from being output.
.HP
-.B \-o, \-\-overlay-tree
-.br
+.B \-o, \-\-overlay\-tree
+.br
Include package from overlays in the search path.
.HP
-.B \-p, \-\-portage-tree
-.br
+.B \-p, \-\-portage\-tree
+.br
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.
.HP
.B \-F, \-\-format=\fITMPL\fP
.br
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.
.P
-.IR "OUTPUT" ":"
+.I R "OUTPUT" ":"
.HP
(See \fIOUTPUT\fP for \fBlist\fP below)
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
-equery hasuse -pI perl
+equery hasuse \-pI perl
.EE
-.br
+.br
View all Gentoo packages that have the "perl" USE flag, exluding installed packages.
.EX
.HP
-USE="perl"; for PKG in $(equery -q hasuse $USE); do echo $PKG: $(equery -q uses $PKG |grep $USE); done
+USE="perl"; for PKG in $(equery \-q hasuse $USE); do echo $PKG: $(equery \-q uses $PKG |grep $USE); done
.EE
-.br
-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.
+.br
+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.
.SS
.BI "list (l) [OPTIONS] " "PKG"
List installed versions of \fIPKG\fP or all packages matching the query pattern.
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
.B \-d, \-\-duplicates
-.br
+.br
List only packages with more than one version installed.
.HP
-.B \-f, \-\-full-regex
-.br
+.B \-f, \-\-full\-regex
+.br
The supplied query is a regular expression.
.HP
-.B \-m, \-\-mask-reason
-.br
+.B \-m, \-\-mask\-reason
+.br
Print the reason why a package was masked.
.HP
-.B \-I, \-\-exclude-installed
-.br
+.B \-I, \-\-exclude\-installed
+.br
Exclude installed packages from being output.
.HP
-.B \-o, \-\-overlay-tree
-.br
+.B \-o, \-\-overlay\-tree
+.br
Include package from overlays in the search path.
.HP
-.B \-p, \-\-portage-tree
-.br
+.B \-p, \-\-portage\-tree
+.br
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.
.HP
.B \-F, \-\-format=\fITMPL\fP
.br
Customize the output format of the matched packages using the template string \fITMPL\fP. \fITMPL\fP can contain the following placeholders:
.RS
-.TP
+.TP
\fB$cp\fP \- Contains the category and the package name only (e.g 'app\-portage/gentoolkit').
-.TP
+.TP
\fB$cpv\fP \- Contains the category, the package name and the full version (e.g. 'app\-portage/gentoolkit\-0.3.0_rc10\-r1').
-.TP
+.TP
\fB$category\fP \- Contains just the category (e.g. 'app\-portage').
-.TP
+.TP
\fB$name\fP \- Contains just the package name (e.g. 'gentoolkit').
-.TP
+.TP
\fB$version\fP \- Contains the package version (without the revision) (e.g. '0.3.0_rc10').
-.TP
+.TP
\fB$revision\fP \- Contains the package revision (e.g. 'r1').
-.TP
+.TP
\fB$fullversion\fP \- Contains the package version including its revision (e.g. '0.3.0_rc10\-r1').
-.TP
+.TP
\fB$slot\fP \- Contains the package's slot.
-.TP
+.TP
\fB$repo\fP \- Contains the name of the package's repository (e.g. 'gentoo').
-.TP
+.TP
\fB$mask\fP \- The Mask\-status field (\fB~M\-??\fP), see \fIOUTPUT\fP below for an explanation.
-.TP
+.TP
\fB$mask2\fP \- Contains a verbose description of the packages masking status.
-.TP
+.TP
\fB$location\fP \- The Location field (\fBIPO\-\fP), see \fIOUTPUT\fP below for an explanation.
.P
Apart from the above placeholders the template string can contain arbitrary
disambiguate the variable names from the enclosing text.
.RE
.P
-.IR "OUTPUT" ":"
+.I R "OUTPUT" ":"
.EX
$ equery list binutils
* Searching for binutils ...
- [I--] [??] sys-devel/binutils-2.18-r1:i686-pc-linux-gnu-2.18
- [IP-] [ ~] sys-devel/binutils-2.19.1-r1:i686-pc-linux-gnu-2.19.1
+ [I\-\-] [??] sys\-devel/binutils\-2.18\-r1:i686\-pc\-linux\-gnu\-2.18
+ [IP\-] [ ~] sys\-devel/binutils\-2.19.1\-r1:i686\-pc\-linux\-gnu\-2.19.1
.EE
.HP
-Location field (\fB[IPO-]\fP):
-.br
-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.
+Location field (\fB[IPO\-]\fP):
+.br
+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.
.HP
-Mask-status field (\fB[ ~M-??]\fP):
-.br
-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.
+Mask\-status field (\fB[ ~M\-??]\fP):
+.br
+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.
.HP
Package name:
-.br
+.br
The third field is the full package name and version.
.HP
Slot:
-.br
-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.
+.br
+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.
.P
-\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.
+\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.
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
equery list '*'
.EE
-.br
+.br
List all installed packages. This is equivalent to '\fBequery list\fP' in \fBGentoolkit\fP versions prior to 0.3.0.
.EX
.HP
-equery list -op mozilla-firefox
+equery list \-op mozilla\-firefox
.EE
-.br
-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.
+.br
+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.
.EX
.HP
equery list '*zilla*'
.EE
-.br
+.br
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.
.EX
.HP
-equery list 'www-client/*'
+equery list 'www\-client/*'
.EE
-.br
-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.
+.br
+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.
.EX
.HP
-equery list --duplicates '*'
+equery list \-\-duplicates '*'
.EE
-.br
-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.
+.br
+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.
.EX
.HP
-equery list -F '$cp:$slot' '*'
+equery list \-F '$cp:$slot' '*'
.EE
-.br
+.br
Get a list of slotted atoms for all installed packages.
.EX
.HP
-equery list -po -F '[$location] [$mask] $cpv:$slot [$repo]' '*'
+equery list \-po \-F '[$location] [$mask] $cpv:$slot [$repo]' '*'
.EE
-.br
+.br
Show all packages in the default (verbose) output format but also include their repository name.
.SS
Display metadata about \fIPKG\fP.
\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:
-.br
+.br
.EX
http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=4
.EE
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
.B \-d, \-\-description
-.br
+.br
Show an extended package description.
.HP
.B \-H, \-\-herd
-.br
-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)
+.br
+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)
.HP
.B \-k, \-\-keywords
-.br
+.br
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:
-.br
-Keywords: 1.35.0-r3:\fB0\fP:
-.br
-Keywords: 1.35.0-r5:\fB0\fP: amd64 hppa ppc x86 ~alpha ~arm ~ia64 ~mips ~ppc64 ~s390 ~sh ~sparc
-.br
-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.
+.br
+Keywords: 1.35.0\-r3:\fB0\fP:
+.br
+Keywords: 1.35.0\-r5:\fB0\fP: amd64 hppa ppc x86 ~alpha ~arm ~ia64 ~mips ~ppc64 ~s390 ~sh ~sparc
+.br
+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.
.HP
.B \-m, \-\-maintainer
-.br
+.br
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)
.HP
.B \-u, \-\-useflags
-.br
-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.
+.br
+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.
.HP
.B \-U, \-\-upstream
-.br
+.br
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)
.HP
.B \-x, \-\-xml
-.br
+.br
Dump the plain XML file to the screen.
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
equery meta gnucash
.EE
-.br
+.br
Show general information about maintainership, including herd, maintainer and upstream.
.EX
.HP
-equery meta --description screen
+equery meta \-\-description screen
.EE
-.br
+.br
See if the package maintainer has provided an extended description.
.EX
.HP
-equery -N meta -H gnome |grep -o --color=never '[^( ]*@gentoo.org'
+equery \-N meta \-H gnome |grep \-o \-\-color=never '[^( ]*@gentoo.org'
.EE
-.br
-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.
+.br
+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.
.SS
.BI "size (s) [OPTIONS] " "PKG"
Print total size of files contained in a given \fIPKG\fP.
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
.B \-b, \-\-bytes
-.br
+.br
Report package size in bytes.
.HP
-.B \-f, \-\-full-regex
-.br
+.B \-f, \-\-full\-regex
+.br
The query is a regular expression.
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
-equery -q size 'www-client/*'
+equery \-q size 'www\-client/*'
.EE
-.br
-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.
+.br
+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.
.SS
.BI "uses (u) [OPTIONS] " "PKG"
Display USE flag statuses and desriptions for a given \fRPKG\fP.
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
.B \-a, \-\-all
-.br
+.br
Display all package versions. Without this option, \fBequery\fP will choose the best available version.
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
-equery uses app-misc/beagle
+equery uses app\-misc/beagle
.EE
-.br
+.br
See which USE flags are enabled for a specific package.
.EX
.HP
-USE="perl"; for PKG in $(equery -q hasuse $USE); do echo $PKG: $(equery -q uses $PKG |grep $USE); done
+USE="perl"; for PKG in $(equery \-q hasuse $USE); do echo $PKG: $(equery \-q uses $PKG |grep $USE); done
.EE
-.br
-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.
+.br
+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.
.SS
.BI "which (w) [OPTIONS] " "PKG"
Display the path to the ebuild that would be used by Portage with the current configuation.
-.IR "LOCAL OPTIONS" ":"
+.I R "LOCAL OPTIONS" ":"
.HP
-.B \-m, \-\-include-masked
-.br
+.B \-m, \-\-include\-masked
+.br
Return the path to the hightest version ebuild available.
.P
-.IR "EXAMPLES" ":"
+.I R "EXAMPLES" ":"
.EX
.HP
-less $(equery which xorg-server)
+less $(equery which xorg\-server)
.EE
-.br
+.br
View the most recent installable ebuild.
.SH "BUGS"
.SH "AUTHORS"
Karl Trygve Kalleberg <karltk@gentoo.org>, 2003
-.br
+.br
Katerina Barone\-Adesi <katerinab@gmail.com>, 2004
-.br
+.br
Douglas Anderson <douglasjanderson@gmail.com>, 2009
projects / gentoolkit.git / commitdiff