[gentoo-doc-cvs] cvs commit: portage-utils.xml - gentoo-doc-cvs

From:	Josh Saddler <nightmorph@×××××××××××.org>
To:	gentoo-doc-cvs@l.g.o
Subject:	[gentoo-doc-cvs] cvs commit: portage-utils.xml
Date:	Sun, 30 Apr 2006 18:45:12
Message-Id:	`20060430184510.707D064451@smtp.gentoo.org`

1

nightmorph    06/04/30 18:45:10

2

3

  Added:                portage-utils.xml

4

  Log:

5

  rane's brand spanking new portage-utils doc is now here, closes bug 123327

6

7

Revision  Changes    Path

8

1.1                  xml/htdocs/doc/en/portage-utils.xml

9

10

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/portage-utils.xml?rev=1.1&content-type=text/x-cvsweb-markup&cvsroot=gentoo

11

plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/portage-utils.xml?rev=1.1&content-type=text/plain&cvsroot=gentoo

12

13

Index: portage-utils.xml

14

===================================================================

15

<?xml version='1.0' encoding='UTF-8'?>

16

<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/portage-utils.xml,v 1.1 2006/04/30 18:45:09 nightmorph Exp $ -->

17

<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">

18

19

<guide link="/doc/en/portage-utils.xml">

20

21

<title>Portage-utils</title>

22

23

<author title="Author">

24

  <mail link="rane@g.o">Łukasz Damentko</mail>

25

</author>

26

<author title="Editor">

27

  <mail link="nightmorph@g.o">Joshua Saddler</mail>

28

</author>

29

<author title="Editor">

30

  <mail link="vanquirius@g.o">Marcelo Góes</mail>

31

</author>

32

33

<abstract>

34

This guide covers some common uses if portage-utils, a set of fast Portage

35

helper applications written in C.

36

</abstract>

37

38

<!-- The content of this document is licensed under the CC-BY-SA license -->

39

<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->

40

<license/>

41

42

<version>1.0</version>

43

<date>2006-04-30</date>

44

45

<chapter>

46

<title>Introduction</title>

47

<section>

48

<body>

49

50

<p>

51

<c>portage-utils</c> is a collection of very fast utilities written in C, which

52

are meant to replace their counterparts included in <c>gentoolkit</c>. Although

53

<c>portage-utils</c> is not yet capable of fully replacing <c>gentoolkit</c>,

54

its utilities are much more efficient than the equivalent ones from

55

<c>gentoolkit</c>.

56

</p>

57

58

<p>

59

The removal of <c>gentoolkit</c> in favor of <c>portage-utils</c> is

60

discouraged, as <c>gentoolkit</c> contains some functions not implemented in

61

<c>portage-utils</c> yet, like <c>revdep-rebuild</c> and <c>glsa-check</c>.

62

Instead, you may want to consider having them both installed.

63

</p>

64

65

<p>

66

More information about <c>gentoolkit</c> can be found in the <uri

67

link="/doc/en/gentoolkit.xml">Gentoolkit</uri> guide.

68

</p>

69

70

<p>

71

You can view the complete list of applications in <c>portage-utils</c> by typing

72

<c>man q</c> or <c>q --help</c>. Please read the man page for each utility

73

described, as this guide is only meant to be a short reference for the most

74

useful functions and does not include all the information about each

75

application.

76

</p>

77

78

<p>

79

The first step of using <c>portage-utils</c> is to install the package:

80

</p>

81

82

<pre caption="Installing portage-utils">

83

# <i>emerge portage-utils</i>

84

</pre>

85

86

</body>

87

</section>

88

</chapter>

89

90

<chapter>

91

<title>Usage</title>

92

<section>

93

<title>How to find a package to which a file belongs</title>

94

<body>

95

96

<p>

97

<c>qfile</c> finds the package to which a file belongs:

98

</p>

99

100

<pre caption="Finding the package to which a file belongs">

101

$ <i>qfile /etc/fonts/fonts.conf</i>

102

media-libs/fontconfig (/etc/fonts/fonts.conf)

103

$ <i>qfile /usr/share/keymaps/atari/atari-uk-falcon.map.gz</i>

104

sys-apps/kbd (/usr/share/keymaps/atari/atari-uk-falcon.map.gz)

105

</pre>

106

107

</body>

108

</section>

109

<section>

110

<title>Verifying package integrity</title>

111

<body>

112

113

<p>

114

If you want to check MD5 sums or mtimes of the files installed by some package,

115

you can do it using the <c>qcheck</c> application:

116

</p>

117

118

<pre caption="Checking package integrity">

119

$ <i>qcheck portage-utils</i>

120

Checking app-portage/portage-utils-0.1.13 ...

121

  * 36 out of 36 files are good

122

</pre>

123

124

<p>

125

Of course, all the files which were changed after installation will be reported

126

here. If the application reports configuration files which you have manually

127

edited after installation, there's nothing to worry about.

128

</p>

129

130

</body>

131

</section>

132

<section>

133

<title>Listing packages which depend on some package</title>

134

<body>

135

136

<p>

137

Of course there's also an application which allows you to list all the packages

138

which depend on some package. This is done using <c>qdepends</c>.  Use the

139

<c>-a</c> flag to show all the DEPEND, RDEPEND, and PDEPEND information for a

140

package.

141

</p>

142

143

<pre caption="Listing packages which depend on some package">

144

$ <i>qdepends -a pygtk</i>

145

 * DEPEND

146

dev-python/pygtk-2.8.2: &gt;=dev-lang/python-2.3 &gt;=x11-libs/gtk+-2.8.0

147

&gt;=dev-libs/glib-2.8.0 &gt;=x11-libs/pango-1.10.0 &gt;=dev-libs/atk-1.8.0

148

&gt;=gnome-base/libglade-2.5.0 &gt;=dev-python/pycairo-0.9.0 dev-python/numeric

149

virtual/opengl dev-python/pyopengl &gt;=x11-libs/gtkglarea-1.99

150

&gt;=dev-util/pkgconfig-0.9 sys-devel/patch

151

 * RDEPEND

152

dev-python/pygtk-2.8.2: &gt;=dev-lang/python-2.3 &gt;=x11-libs/gtk+-2.8.0

153

&gt;=dev-libs/glib-2.8.0 &gt;=x11-libs/pango-1.10.0 &gt;=dev-libs/atk-1.8.0

154

&gt;=gnome-base/libglade-2.5.0 &gt;=dev-python/pycairo-0.9.0 dev-python/numeric

155

virtual/opengl dev-python/pyopengl &gt;=x11-libs/gtkglarea-1.99

156

 * PDEPEND

157

</pre>

158

159

</body>

160

</section>

161

<section>

162

<title>Listing files that belong to an ebuild</title>

163

<body>

164

165

<p>

166

<c>qlist</c> gives you a list of all files that belong to an ebuild.

167

</p>

168

169

<pre caption="Listing files which belong to an ebuild file">

170

$ <i>qlist vim</i>

171

/usr/bin/gvim

172

/usr/bin/gvimdiff

173

/usr/bin/evim

174

/usr/bin/eview

175

/usr/bin/gview

176

/usr/bin/rgvim

177

[...]

178

</pre>

179

180

</body>

181

</section>

182

<section>

183

<title>Looking for packages that use some USE flag</title>

184

<body>

185

186

<p>

187

This is done with <c>quse</c>, which must be run as root. It may take some time

188

to first create/update the ebuild cache.

189

</p>

190

191

<pre caption="Looking for packages with the 'firefox' USE flag">

192

# <i>quse firefox</i>

193

app-office/openoffice/openoffice-2.0.2_rc1.ebuild binfilter curl eds firefox gnome gtk java kde ldap mozilla xml2 

194

dev-haskell/gtk2hs/gtk2hs-0.9.10.ebuild doc glade gnome mozilla firefox 

195

dev-java/swt/swt-3.1-r1.ebuild accessibility cairo firefox gnome mozilla 

196

[...]

197

</pre>

198

199

</body>

200

</section>

201

<section>

202

<title>Finding package sizes</title>

203

<body>

204

205

<p>

206

This is done with <c>qsize</c> application and is as simple as:

207

</p>

208

209

<pre caption="Finding package size">

210

$ <i>qsize vim</i>

211

app-editors/gvim-6.4: 10 files, 7 non-files, 2327.516 KB

212

app-editors/vim-6.4: 6 files, 2 non-files, 2058.14 KB

213

app-editors/vim-core-6.4: 1024 files, 68 non-files, 10950.984 KB

214

[...]

215

</pre>

216

217

</body>

218

</section>

219

</chapter>

220

</guide>

--

225

gentoo-doc-cvs@g.o mailing list

1	nightmorph 06/04/30 18:45:10
2
3	Added: portage-utils.xml
4	Log:
5	rane's brand spanking new portage-utils doc is now here, closes bug 123327
6
7	Revision Changes Path
8	1.1 xml/htdocs/doc/en/portage-utils.xml
9
10	file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/portage-utils.xml?rev=1.1&content-type=text/x-cvsweb-markup&cvsroot=gentoo
11	plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/portage-utils.xml?rev=1.1&content-type=text/plain&cvsroot=gentoo
12
13	Index: portage-utils.xml
14	===================================================================
15	<?xml version='1.0' encoding='UTF-8'?>
16	<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/portage-utils.xml,v 1.1 2006/04/30 18:45:09 nightmorph Exp $ -->
17	<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
18
19	<guide link="/doc/en/portage-utils.xml">
20
21	<title>Portage-utils</title>
22
23	<author title="Author">
24	<mail link="rane@g.o">Łukasz Damentko</mail>
25	</author>
26	<author title="Editor">
27	<mail link="nightmorph@g.o">Joshua Saddler</mail>
28	</author>
29	<author title="Editor">
30	<mail link="vanquirius@g.o">Marcelo Góes</mail>
31	</author>
32
33	<abstract>
34	This guide covers some common uses if portage-utils, a set of fast Portage
35	helper applications written in C.
36	</abstract>
37
38	<!-- The content of this document is licensed under the CC-BY-SA license -->
39	<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
40	<license/>
41
42	<version>1.0</version>
43	<date>2006-04-30</date>
44
45	<chapter>
46	<title>Introduction</title>
47	<section>
48	<body>
49
50	<p>
51	<c>portage-utils</c> is a collection of very fast utilities written in C, which
52	are meant to replace their counterparts included in <c>gentoolkit</c>. Although
53	<c>portage-utils</c> is not yet capable of fully replacing <c>gentoolkit</c>,
54	its utilities are much more efficient than the equivalent ones from
55	<c>gentoolkit</c>.
56	</p>
57
58	<p>
59	The removal of <c>gentoolkit</c> in favor of <c>portage-utils</c> is
60	discouraged, as <c>gentoolkit</c> contains some functions not implemented in
61	<c>portage-utils</c> yet, like <c>revdep-rebuild</c> and <c>glsa-check</c>.
62	Instead, you may want to consider having them both installed.
63	</p>
64
65	<p>
66	More information about <c>gentoolkit</c> can be found in the <uri
67	link="/doc/en/gentoolkit.xml">Gentoolkit</uri> guide.
68	</p>
69
70	<p>
71	You can view the complete list of applications in <c>portage-utils</c> by typing
72	<c>man q</c> or <c>q --help</c>. Please read the man page for each utility
73	described, as this guide is only meant to be a short reference for the most
74	useful functions and does not include all the information about each
75	application.
76	</p>
77
78	<p>
79	The first step of using <c>portage-utils</c> is to install the package:
80	</p>
81
82	<pre caption="Installing portage-utils">
83	# <i>emerge portage-utils</i>
84	</pre>
85
86	</body>
87	</section>
88	</chapter>
89
90	<chapter>
91	<title>Usage</title>
92	<section>
93	<title>How to find a package to which a file belongs</title>
94	<body>
95
96	<p>
97	<c>qfile</c> finds the package to which a file belongs:
98	</p>
99
100	<pre caption="Finding the package to which a file belongs">
101	$ <i>qfile /etc/fonts/fonts.conf</i>
102	media-libs/fontconfig (/etc/fonts/fonts.conf)
103	$ <i>qfile /usr/share/keymaps/atari/atari-uk-falcon.map.gz</i>
104	sys-apps/kbd (/usr/share/keymaps/atari/atari-uk-falcon.map.gz)
105	</pre>
106
107	</body>
108	</section>
109	<section>
110	<title>Verifying package integrity</title>
111	<body>
112
113	<p>
114	If you want to check MD5 sums or mtimes of the files installed by some package,
115	you can do it using the <c>qcheck</c> application:
116	</p>
117
118	<pre caption="Checking package integrity">
119	$ <i>qcheck portage-utils</i>
120	Checking app-portage/portage-utils-0.1.13 ...
121	* 36 out of 36 files are good
122	</pre>
123
124	<p>
125	Of course, all the files which were changed after installation will be reported
126	here. If the application reports configuration files which you have manually
127	edited after installation, there's nothing to worry about.
128	</p>
129
130	</body>
131	</section>
132	<section>
133	<title>Listing packages which depend on some package</title>
134	<body>
135
136	<p>
137	Of course there's also an application which allows you to list all the packages
138	which depend on some package. This is done using <c>qdepends</c>. Use the
139	<c>-a</c> flag to show all the DEPEND, RDEPEND, and PDEPEND information for a
140	package.
141	</p>
142
143	<pre caption="Listing packages which depend on some package">
144	$ <i>qdepends -a pygtk</i>
145	* DEPEND
146	dev-python/pygtk-2.8.2: >=dev-lang/python-2.3 >=x11-libs/gtk+-2.8.0
147	>=dev-libs/glib-2.8.0 >=x11-libs/pango-1.10.0 >=dev-libs/atk-1.8.0
148	>=gnome-base/libglade-2.5.0 >=dev-python/pycairo-0.9.0 dev-python/numeric
149	virtual/opengl dev-python/pyopengl >=x11-libs/gtkglarea-1.99
150	>=dev-util/pkgconfig-0.9 sys-devel/patch
151	* RDEPEND
152	dev-python/pygtk-2.8.2: >=dev-lang/python-2.3 >=x11-libs/gtk+-2.8.0
153	>=dev-libs/glib-2.8.0 >=x11-libs/pango-1.10.0 >=dev-libs/atk-1.8.0
154	>=gnome-base/libglade-2.5.0 >=dev-python/pycairo-0.9.0 dev-python/numeric
155	virtual/opengl dev-python/pyopengl >=x11-libs/gtkglarea-1.99
156	* PDEPEND
157	</pre>
158
159	</body>
160	</section>
161	<section>
162	<title>Listing files that belong to an ebuild</title>
163	<body>
164
165	<p>
166	<c>qlist</c> gives you a list of all files that belong to an ebuild.
167	</p>
168
169	<pre caption="Listing files which belong to an ebuild file">
170	$ <i>qlist vim</i>
171	/usr/bin/gvim
172	/usr/bin/gvimdiff
173	/usr/bin/evim
174	/usr/bin/eview
175	/usr/bin/gview
176	/usr/bin/rgvim
177	[...]
178	</pre>
179
180	</body>
181	</section>
182	<section>
183	<title>Looking for packages that use some USE flag</title>
184	<body>
185
186	<p>
187	This is done with <c>quse</c>, which must be run as root. It may take some time
188	to first create/update the ebuild cache.
189	</p>
190
191	<pre caption="Looking for packages with the 'firefox' USE flag">
192	# <i>quse firefox</i>
193	app-office/openoffice/openoffice-2.0.2_rc1.ebuild binfilter curl eds firefox gnome gtk java kde ldap mozilla xml2
194	dev-haskell/gtk2hs/gtk2hs-0.9.10.ebuild doc glade gnome mozilla firefox
195	dev-java/swt/swt-3.1-r1.ebuild accessibility cairo firefox gnome mozilla
196	[...]
197	</pre>
198
199	</body>
200	</section>
201	<section>
202	<title>Finding package sizes</title>
203	<body>
204
205	<p>
206	This is done with <c>qsize</c> application and is as simple as:
207	</p>
208
209	<pre caption="Finding package size">
210	$ <i>qsize vim</i>
211	app-editors/gvim-6.4: 10 files, 7 non-files, 2327.516 KB
212	app-editors/vim-6.4: 6 files, 2 non-files, 2058.14 KB
213	app-editors/vim-core-6.4: 1024 files, 68 non-files, 10950.984 KB
214	[...]
215	</pre>
216
217	</body>
218	</section>
219	</chapter>
220	</guide>
221
222
223
224	--
225	gentoo-doc-cvs@g.o mailing list

Gentoo Archives: gentoo-doc-cvs