From mboxrd@z Thu Jan 1 00:00:00 1970
Received: from pigeon.gentoo.org ([208.92.234.80] helo=lists.gentoo.org)
by finch.gentoo.org with esmtp (Exim 4.60)
(envelope-from )
id 1Qse5X-0005yA-0Z
for garchives@archives.gentoo.org; Sun, 14 Aug 2011 17:03:03 +0000
Received: from pigeon.gentoo.org (localhost [127.0.0.1])
by pigeon.gentoo.org (Postfix) with SMTP id 974FE21C2B5;
Sun, 14 Aug 2011 17:02:55 +0000 (UTC)
Received: from smtp.gentoo.org (smtp.gentoo.org [140.211.166.183])
by pigeon.gentoo.org (Postfix) with ESMTP id 2C7C121C2B5
for ; Sun, 14 Aug 2011 17:02:55 +0000 (UTC)
Received: from flycatcher.gentoo.org (flycatcher.gentoo.org [81.93.255.6])
(using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))
(No client certificate requested)
by smtp.gentoo.org (Postfix) with ESMTPS id 593131B4055
for ; Sun, 14 Aug 2011 17:02:54 +0000 (UTC)
Received: by flycatcher.gentoo.org (Postfix, from userid 617)
id 16D6220054; Sun, 14 Aug 2011 17:02:53 +0000 (UTC)
From: "Sven Vermeulen (swift)"
To: gentoo-commits@lists.gentoo.org
Reply-To: gentoo-dev@lists.gentoo.org, swift@gentoo.org
Subject: [gentoo-commits] gentoo commit in xml/htdocs/doc/en: gentoolkit.xml
X-VCS-Repository: gentoo
X-VCS-Files: gentoolkit.xml
X-VCS-Directories: xml/htdocs/doc/en
X-VCS-Committer: swift
X-VCS-Committer-Name: Sven Vermeulen
Content-Type: text/plain; charset=utf8
Message-Id: <20110814170253.16D6220054@flycatcher.gentoo.org>
Date: Sun, 14 Aug 2011 17:02:53 +0000 (UTC)
Precedence: bulk
List-Post:
List-Help:
List-Unsubscribe:
List-Subscribe:
List-Id: Gentoo Linux mail
X-BeenThere: gentoo-commits@lists.gentoo.org
Content-Transfer-Encoding: quoted-printable
X-Archives-Salt:
X-Archives-Hash: ff93d76fe8dfd599ca6f651e3fb86ab3
swift 11/08/14 17:02:53
Modified: gentoolkit.xml
Log:
Bug #269071 - Many updates on gentoolkit.xml documentation, thanks to f=
uzzyray
Revision Changes Path
1.34 xml/htdocs/doc/en/gentoolkit.xml
file : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/gent=
oolkit.xml?rev=3D1.34&view=3Dmarkup
plain: http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/gent=
oolkit.xml?rev=3D1.34&content-type=3Dtext/plain
diff : http://sources.gentoo.org/viewvc.cgi/gentoo/xml/htdocs/doc/en/gent=
oolkit.xml?r1=3D1.33&r2=3D1.34
Index: gentoolkit.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/gentoolkit.xml,v
retrieving revision 1.33
retrieving revision 1.34
diff -u -r1.33 -r1.34
--- gentoolkit.xml 3 Oct 2010 18:47:51 -0000 1.33
+++ gentoolkit.xml 14 Aug 2011 17:02:52 -0000 1.34
@@ -1,5 +1,5 @@
-
+
=20
@@ -29,6 +29,9 @@
Joshua Saddler
+
+ Douglas Anderson
+
=20
Gentoolkit is a suite of tools to ease the administration of a Gentoo sy=
stem.
@@ -37,8 +40,8 @@
=20
=20
-2
-2010-10-03
+3
+2011-06-24
=20
Introduction
@@ -88,7 +91,7 @@
Many of the tools in gentoolkit reveal important information about your =
system
or require root privilege. For that reason, some of the programs may onl=
y be
-executed (or only function properly) if run by a user with root permissi=
on.
+executed (or only function properly) if run by a user with root privileg=
es.
=20
=20
-equery is a tool that displays a great deal of useful information=
about
-the packages on your system and much more. equery --help gives yo=
u the
-full set of options.
+equery is a tool that displays useful information about the packa=
ges on
+your system. equery is based on a system of modules.=20
+Every module has a shorthand name. For example, equery l gcc is t=
he same
+as equery list gcc. equery --help explains global options
+and lists all available modules and their shorthand names.=20
+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.
=20
-
-Not all features listed by equery --help have been implemented ye=
t.
-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 em=
erge-like input):
+$ equery --quiet list gcc # package
+sys-devel/gcc-4.3.2-r3
+$ equery --quiet list sys-devel/gcc # category/pa=
ckage
+sys-devel/gcc-4.3.2-r3
+$ equery --quiet list '>=3Dsys-devel/gcc-4' # atom synt=
ax
+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 ca=
tegory 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 ...=20
+[IP-] [ ] media-libs/flac-1.2.1-r3 (0)
+[IP-] [ ] media-libs/speex-1.2_beta3_p2 (0)
+
+ * Searching for USE flag sse2 ...=20
+[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
+[...]
+
=20
-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 to=
ols, but
-you can also turn it off by adding the --no-pipe option. If you w=
rite
-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 '*'.=20
+To act on all packages in a category, use 'category-name/*'.
=20
+
+Don't forget to quote input when using special shell characters=20
+like asterisks or greater than/less than signs.
+
+
+
+The next few sections in this document give a quick introduction to the
+different equery modules.
+
+
=20
-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.