Contents of /xml/htdocs/proj/en/overlays/userguide.xml

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.4 - (hide annotations) (download) (as text)
Sat Nov 11 22:21:04 2006 UTC (11 years, 5 months ago) by wrobel
Branch: MAIN
Changes since 1.3: +7 -5 lines
File MIME type: application/xml
Corrected instruction for layman initialization.

1 stuart 1.1 <?xml version="1.0" encoding="UTF-8"?>
2     <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4     <guide link="/proj/en/overlays/userguide.xml">
5     <title>Gentoo Overlays: Users' Guide</title>
7     <author title="Author">
8     <mail link="stuart@gentoo.org">Stuart Herbert</mail>
9     </author>
11     <abstract>This guide helps users understand how to use the Gentoo Overlays service</abstract>
13     <license/>
15     <version>1.0</version>
16     <date>2006-07-30</date>
18     <chapter>
19     <title>Introduction</title>
20     <section>
21     <title>Audience</title>
22     <body>
23     <p>This document has been written for all users of Gentoo. If you are a Gentoo
24     developer or Gentoo staff member, and you want to be able to manage your own
25     overlay, please see the <uri link="/proj/en/overlays/devguide.xml">Developers' Guide</uri>.</p>
26     </body>
27     </section>
29     <section>
30     <title>What Are Overlays?</title>
31     <body>
32     <p>"Overlays" are package trees for Portage. They contain additional ebuilds for Gentoo. They are maintained by Gentoo developers, but are distributed separately from the main Portage tree.</p>
33     </body>
34     </section>
36     <section>
37     <title>Why Use Overlays?</title>
38     <body>
39     <p>People create overlays for all sorts of reasons. Here are a few of the main
40     ones:</p>
41     <ul>
42     <li>If you modify an ebuild in /usr/portage, your change will be lost the next time you emerge --sync. But, if you put your modified ebuild into an overlay, your change is safe from emerge --sync.</li>
43     <li>Because overlays are not the main Gentoo Portage package tree, they're a great place to develop and test an ebuild without fear of breaking the main Gentoo Portage package tree.</li>
44     <li>Not every ebuild belongs in the Gentoo Portage package tree. An overlay is a great place to store an ebuild until it is ready to go into the Gentoo Portage package tree.</li>
45     </ul>
46     </body>
47     </section>
49     <section>
50     <title>What Is overlays.gentoo.org?</title>
51     <body>
52     <p><uri link="http://overlays.gentoo.org">overlays.gentoo.org</uri> provides social workspaces to allow Gentoo projects,
53     developers and users to collaborate together on tomorrow's Gentoo packages.
54     We do this by host overlays for Gentoo projects, and overlays for Gentoo
55     developers.</p>
56     </body>
57     </section>
59     <section>
60     <title>Are All Official Overlays Hosted On overlays.gentoo.org?</title>
61     <body>
62     <p>No. Gentoo developers are free to put their overlay wherever suits them best; they don't have to use overlays.gentoo.org if they don't want to.</p>
63     </body>
64     </section>
65     </chapter>
67     <chapter>
68     <title>Getting Started With Overlays</title>
69     <section>
70     <body>
71     <p>Use Gunnar Wrobel's layman to easily install and update overlays over
72     time.</p>
73     </body>
74     </section>
76     <section>
77     <title>Installing Layman</title>
78     <body>
79     <p>To install layman, follow these steps:</p>
80     <pre caption="Installing layman">
81     <i>emerge layman</i>
82     <i>echo "source /usr/portage/local/layman/make.conf" >> /etc/make.conf</i>
83     </pre>
84 wrobel 1.2 <note>
85 wrobel 1.4 Layman will create "/usr/portage/local/layman/make.conf" once you add
86     your first overlay. But if you do not plan to install an overlay
87     immediately you should ensure that this file actually exists and
88     contains the empty variable "PORTDIR_OVERLAY". Otherwise portage will
89     complain. You can run "echo PORTDIR_OVERLAY=\"\" >
90     /usr/portage/local/layman/make.conf" in order to have the file created
91     correctly.
92 wrobel 1.2 </note>
93 stuart 1.1 </body>
94     </section>
96     <section>
97     <title>Listing The Overlays Available</title>
98     <body>
99     <p>To see the list of overlays available, run:</p>
100     <pre caption="Listing the available overlays">layman -L</pre>
101     </body>
102     </section>
104     <section>
105     <title>Installing An Overlay</title>
106     <body>
107     <p>To install an overlay on your computer, run:</p>
108     <pre caption="Adding an overlay">
109     layman -a &lt;overlay-name&gt;
110     </pre>
111     <p>For example, to install <uri link="http://overlays.gentoo.org/proj/php">the PHP overlay</uri>, run:</p>
112     <pre caption="Adding the PHP overlay">
113     layman -a php
114     </pre>
115     </body>
116     </section>
118     <section>
119     <title>Installing Packages From An Overlay</title>
120     <body>
121     <p>After installing an overlay, you can install packages from it by running:</p>
122     <pre caption="Installing A Package From An Overlay">
123     emerge -av &lt;category&gt;/&lt;package&gt;
124     </pre>
125     <p>Portage automatically searches your main Portage tree (in /usr/portage), and
126     all of the overlays that you've installed, and picks the latest version of the
127     package that it can find.</p>
129     <p>If Portage isn't picking up the package from the overlay, that's normally
130     because the package is marked ~arch, where "arch" is the architecture of your
131     computer (normally x86).</p>
132     </body>
133     </section>
135     <section>
136     <title>Updating An Overlay</title>
137     <body>
138     <p>To keep your installed overlays up to date, run:</p>
139     <pre caption="Updating All Installed Overlays">
140     layman --sync ALL
141     </pre>
142     <p>Please don't run this more than once a day, or you'll put too much strain on
143     Gentoo's infrastructure.</p>
144     </body>
145     </section>
146     </chapter>
148     <chapter>
149     <title>How To Get More Involved</title>
151     <section>
152     <title>Introduction</title>
153     <body>
154     <p>All Gentoo developers were users of Gentoo before they became developers. Our users aren't just the reason Gentoo exists today; they're our future volunteers too.</p>
156     <p>If you start contributing to a project, we'll give you write access to the
157     project's overlay, and we'll provide mentors to help you contribute.
158     Eventually, if we like what you do and the way you do it, we'll invite you to
159     go the whole hog and become a full Gentoo developer, with a nice shiny
160     @gentoo.org email address.</p>
161     </body>
162     </section>
164     <section>
165     <title>How To Get Started</title>
166     <body>
167     <p>If you want to contribute to an overlay, the best approach is to build a good
168     working relationship with the Gentoo developers who are responsible for the
169     overlay. You can find out who is responsible for each overlay by going to
170     <uri link="http://overlays.gentoo.org">overlays.gentoo.org's homepage</uri>, and clicking on the link for the overlay in question.</p>
172     <p>Different developers preferred to be contacted in different ways. Some hang
173     out on IRC, and may have their own channels for their projects. Examples of
174     these include the PHP project (#gentoo-php), and the Webapps project
175     (#gentoo-web). Others prefer to be contacted by email only. The only way
176     you'll find out is to try and make contact, and take it from there.</p>
177     </body>
178     </section>
180     <section>
181     <title>Working With Subversion</title>
182     <body>
183     <p>You'll need to get comfortable working with Subversion. Subversion is the
184     version control software we use to manage the contents of our overlays. If you have never used Subversion before, the <uri link="http://svnbook.red-bean.com/">online book</uri> is an excellent way to learn Subversion. You can buy it in dead-tree format too if you prefer.</p>
185     </body>
186     </section>
188     <section>
189     <title>Further Information</title>
190     <body>
191     <p>The Gentoo project (or developer) you're working with should be able to
192     provide you with any further help and assistance that you need.</p>
193     </body>
194     </section>
195     </chapter>
197     <chapter>
198     <title>Frequently Asked Questions</title>
199     <section>
200     <body>
201     <p>Q: Do you host overlays for users?</p>
202     <ul>
203     <li>A: No, we do not. If you want an overlay of your own on o.g.o, you must first become a Gentoo developer.</li>
204     </ul>
205     </body>
206     </section>
207     </chapter>
208     </guide>

  ViewVC Help
Powered by ViewVC 1.1.20